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:
All configuration can be done in setup.cfg like changing the description,
url, classifiers and even console scripts of your project. That means in most
cases it is not necessary to tamper with setup.py.
In order to build a source, binary or wheel distribution, just run
python setup.py sdist, python setup.py bdist or
python setup.py bdist_wheel.
Namespace Packages
Optionally, namespace packages can be used, if you are planning to distribute a larger package as a collection of smaller ones. For example, use:
putup my_project --package my_package --with-namespace com.my_domain
to define my_package inside the namespace com.my_domain in java-style.
Package and Files Data
Additional data inside your package (package_data) or in the root
directory of your project (data_files) can be configured in setup.cfg.
To read this data in your code, use:
from pkgutil import get_data
data = get_data('my_package', 'path/to/my/data.txt')
Your project is already an initialised Git repository and setup.py uses
the information of tags to infer the version of your project.
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__.
Unleash the power of Git by using its pre-commit hooks. This feature is available through the
--with-pre-commit flag. After your project's scaffold was generated, make
sure pre-commit is installed, e.g. pip install pre-commit, then just run
pre-commit install.
It goes unsaid that also a default .gitignore file is provided that is well
adjusted for Python projects and the most common tools.
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.
In order to use the numpydoc
documentation style, the flag --with-numpydoc can be specified.
Run python setup.py test to run all unittests defined in the subfolder
tests with the help of py.test and
pytest-runner. Some sane
default flags for py.test are already defined in the [pytest] section of
setup.cfg. The py.test plugin
pytest-cov is used to automatically
generate a coverage report. It is also possible to provide additional
parameters and flags on the commandline, e.g., type:
python setup.py test --addopts -h
to show the help of py.test.
JUnit and Coverage HTML/XML
For usage with a continuous integration software JUnit and Coverage XML output
can be activated in setup.cfg. 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.
In order to use the virtualenv management and test tool Tox the flag --with-tox can be specified.
Add the requirements of your project to the requirements.txt file which
will be automatically used by setup.py.
This also allows you to easily customize a plain virtual environment with:
pip install -r requirements.txt
All licenses from choosealicense.com can be
easily selected with the help of the --license flag.
Create a Django project with the flag
--with-django which is equivalent to
django-admin.py startproject my_project enhanced by PyScaffold's features.
With the help of Cookiecutter it
is possible to customize your project setup. Just use the flag
--with-cookiecutter TEMPLATE to use a cookiecutter template which will be
refined by PyScaffold afterwards.
Keep your project's scaffold up-to-date by applying
putput --update my_project when a new version of PyScaffold was released.
An update will only overwrite files that are not often altered by users like
setup.py. 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 safe to use
since the git repository of the existing project is not touched!
Note
If you are updating from a PyScaffold version before 2.0, you must
manually remove the files versioneer.py and MANIFEST.in.