A Python project template with several best-practice features/integrations
- Continuous integration
- Documentation with
Sphinx
- Run
make docs
to generate docs - Hosted at Read the Docs
- Run
- Testing with
pytest
andtox
- Run
pytest
ormake test
to test in current environment - Run
tox
ormake test-all
to test in multiple virtual envs- Test matrix covers several Python and Numpy versions
- Run
- Quaity checks with
coverage
andflake8
- Run
coverage
ormake coverage
for test coverage report - Run
flake8
ormake lint
for code style/quality checks - Analysis at Code Climate and QuantifiedCode
- Run
- Dependency updates and Python 3 compatability at PyUp.io
- Version management with
bumpversion
- Run
bumpversion major|minor|patch
to increment version project-wide
- Run
- Makefile recipes
- Run
make
for recipe summaries
- Run
This project is adapted from the Cookiecutter package utility and the PyPackage template.