Scripts we use to manage our tech geek household.
See COPYING for licensing details. (c) 2014 Magdalena & Kristian Rother
Your project was successfully set up with PyScaffold 1.0c2. Following features are available:
Run python setup.py sdist
, python setup.py bdist
or
python setup.py bdist_wheel
to build a source, binary or wheel
distribution.
Your project is already an initialised Git repository and setup.py
uses
the information of tags to infer the version of your project with the help of
versioneer.
To use this feature you need to tag with the format vMAJOR.MINOR[.REVISION]
, e.g. v0.0.1
or v0.1
. The prefix v
is needed!
Run python setup.py version
to retrieve the current PEP440-compliant version. This version
will be used when building a package and is also accessible through
my_project.__version__
.
The version will be unknown
until you have added a first tag.
Build the documentation with python setup.py docs
and run doctests with
python setup.py doctest
. Start editing the file docs/index.rst
to
extend the documentation. The documentation also works with Read the Docs.
Run python setup.py test
to run all unittests defined in the subfolder
tests
with the help of py.test. The py.test plugin
pytest-cov is used to automatically
generate a coverage report. For usage with a continuous integration software
JUnit and Coverage XML output can be activated. Checkout putup -h
for
details. Use the flag --with-travis
to generate templates of the
Travis configuration files .travis.yml
and
tests/travis_install.sh
which even features the coverage and stats system
Coveralls.
Add the requirements of your project to the requirements.txt
file which
will be automatically used by setup.py
.
Create a Django project with the flag --with-django
which is equivalent
to django-admin.py startproject my_project
enhanced by PyScaffold's
features.
Keep your project's scaffold up-to-date by applying
putput --update my_project
when a new version of PyScaffold was released.
It may also be used to change the url, license and description setting.
Note
Replace the content of this file with a description of your project.
virtualenv -p python3 .