This is a modern Cookiecutter template that can be used to initiate a Python Data Science project with all the necessary tools for development, testing, and deployment. It supports the following features:
- Poetry for dependency management
- CI/CD with GitHub Actions
- Pre-commit hooks with pre-commit
- Code quality with Black, flake8, isort, mypy, and pylint
- A repository creation in GitHub if agreed by the user using GitHub CLI
- Testing and coverage with pytest
- Compatibility testing for multiple versions of Python with Tox
On your local machine, install cookiecutter and directly pass the URL to this
Github repository to the cookiecutter command:
pip install cookiecutter
cookiecutter https://github.com/fpgmaas/cookiecutter-poetry.gitYou are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
This project is partially based on:
- Audrey Feldroy's great cookiecutter-pypackage repository
- The cookiecutter-datascience repository
- Florian Maas's cookiecutter-poetry repository