PyScaffold comes with a lot of eloberated features and configuration defaults to make the most common tasks in developing, maintaining and distributing your own Python package as easy as possible.
Configuration & Packaging¶
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.
Run python setup.py sdist, python setup.py bdist or python setup.py bdist_wheel to build a source, binary or wheel distribution. 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')
Complete Git Integration¶
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.
Unittest & Coverage¶
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 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.
Managing test environments with tox
Run tox to generate test virtual environments for various python environments defined in the generated tox.ini. Testing and building sdists for python 2.7 and python 3.4 is just as simple with tox as:
tox -e py27,py34
Environments for tests with the the static code analyzers pyflakes and pep8 which are bundled in flake8 are included as well. Run it explicitly with:
tox -e flake8
With tox, you can use the --recreate flag to force tox to create new environments. By default, PyScaffold’s tox configuration will execute tests for a variety of python versions. If an environment is not available on the system the tests are skipped gracefully. You can relay on the tox documentation for detailed configuration options.
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.
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!
If you are updating from a PyScaffold version before 2.0, just must manually remove the files versioneer.py and MANIFEST.in.