ProjectTemplate¶
A Python project template with several best-practice features/integrations
- Documentation with
Sphinx
and hosted at Read the Docs- Run
make docs
to generate docs
- Run
- Testing with
pytest
,tox
, and more; hosted at Code Climate- Run
pytest
ormake test
to test in current environment - Run
tox
ormake test-all
to test in multiple virtual envs - Run
coverage
ormake coverage
for test coverate report - Run
flake8
ormake lint
for code style/quality checks
- Run
- Continuous integration at Travis-CI
- Version management with
bumpversion
- Dependency updates and Python 3 compatability at PyUp.io
- Makefile recipes
- Run
make
for recipe summaries
- Run
This project is adapted from the Cookiecutter package utility and the PyPackage template.