cookiecutter-python-package

A cookiecutter template for creating a new Python package.

See https://github.com/sgraaf/cookiecutter-python-package-demo for a demo of this template.

Usage

cookiecutter gh:sgraaf/cookiecutter-python-package

Features

• Linting with autofix (i.e. removing unused imports, detecting code smells and Python syntax upgrades) with Ruff
• Code formatting with Ruff, Mdformat and Prettier
• Static type-checking with mypy, Pyrefly and ty
• Checks and fixes before every commit with prek
• Testing with pytest
• Extremely fast Python package and project management with uv
• Continuous Integration with GitHub Actions
• Automated version updates for GitHub Actions with Dependabot
• Documentation with Sphinx, MyST and Read the Docs, using the Furo theme
• Automated release builds and uploads to PyPI

This template supports Python 3.10, 3.11, 3.12, 3.13 and 3.14.