Home
A Python project template with modern toolings for testing, deployment, and quality assurance. Key features include:
- uv for fast, reliable dependency management
- CI/CD with GitHub Actions
- Pre-commit hooks with pre-commit
- Code quality with ruff, mypy, deptry and prettier
- Publishing to PyPI by creating a new release on GitHub
- Testing and coverage with pytest and codecov
- Documentation with MkDocs
- Compatibility testing for multiple versions of Python with tox-uv
- Containerization with Docker
Quickstart¶
On your local machine, navigate to the directory in which you want to create a project directory, and run the following command:
uvx cookiecutter https://github.com/proteusiq/pyproject.git
or if you don't have uv installed yet:
pip install cookiecutter
cookiecutter https://github.com/proteusiq/pyproject.git
Follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the README.md to complete the setup of your project.
Acknowledgements¶
This project is based on Florian Mass' cookiecutter-uv => Audrey Feldroy's cookiecutter-pypackage.