Skip to content

sgraaf/cookiecutter-python-package

Repository files navigation

cookiecutter-python-package

Supported Python Versions Nox uv Ruff Checked with mypy pre-commit

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, formatting and Python syntax upgrades) with ruff
  • Code formatting with ruff and Prettier
  • Static type-checking with mypy
  • Checks and fixes before every commit with pre-commit
  • Testing with pytest
  • Project automation with Nox
  • Extremely fast Python package and project management with uv
  • Continuous Integration with GitHub Actions and pre-commit.ci
  • 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.9, 3.10, 3.11, 3.12 and 3.13.

About

A cookiecutter template for creating a new Python package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •