cookiecutter-python-standard

Cookiecutter template for a Python package based on pep 621, pyproject.toml, and some other python nice-to-haves. Derived directly from cookiecutter-hypermodern-python.

✨📚✨ Read the full documentation

Usage

cookiecutter gh:maxsu/cookiecutter-python-standard

Features

Package Management

• Packaging with [Pip]
• Automated dependency updates with Dependabot

CI/CD

• Continuous integration with GitHub Actions
• Automated release notes with Release Drafter
• Automated uploads to PyPI

Documentation

• Documentation with Read the Docs
• Generate API documentation with autodoc and napoleon
• Generate command-line reference with sphinx-click

Testing

• Testing with pytest
• Code coverage with Coverage.py
• Coverage reporting with Codecov
• Check documentation examples with xdoctest

QA

• Code formatting with Black
• Import sorting with isort
• Linting with pre-commit and Flake8
• Automated Python syntax upgrades with pyupgrade

Project Tools

• Manage project labels with GitHub Labeler

Security

• Security audit with Bandit and Safety

Typing

• Static type-checking with mypy
• Runtime type-checking with Typeguard

UI

• Command-line interface with Click

The template supports Python 3.8 - 3.12.