PyScaffold helps you to easily setup a new Python project, it is as easy as:
putup my_project
This will create a new subdirectory my_project
and serve you a project
setup with git repository, setup.py, document and test folder ready for some
serious coding.
Type putup -h
to learn about more configuration options. PyScaffold assumes
that you have Git installed and set up on your PC,
meaning at least your name and email configured.
The scaffold of my_project
provides you with following features:
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.
An update will only overwrite files that are not often altered by users like
setup.py, versioneer.py etc. To update all files use --update --force
.
An existing project that was not setup with PyScaffold can be converted with
putup --force existing_project
. The force option is completely save to use
since the git repository of the existing project is not touched!