An opinionated template for Python projects that includes:
- Unit testing with pytest
- Type checking with MyPy
- Code coverage on Codecov
- Docker image
- Good-looking API documentation with Sphinx
- CI/CD pipeline on GitHub Actions with:
- Python venv caching for faster pipelines
- Linting, style and code duplication checking
- Test execution and coverage report upload
- Docker image build and push to DockerHub
The API documentation live preview is available at yapt.upsetbit.co.
yapt is tested against all major python versions: 3.7, 3.8 and
3.9.
Take what suits you, ignore or change what you do not like, and apply according to his will.
To the extent possible under law, Caian Ertl has waived all copyright
and related or neighboring rights to this work. In the spirit of freedom of
information, I encourage you to fork, modify, change, share, or do whatever
you like with this project! ^C ^V
