Cookiecutter Python Template

Features

• Dependency and virtual environment management (one of the following based on user choice)
  • uv
  • pipenv
  • poetry
• Coding style
  • ruff: check coding style, security rules (flake8-bandit S) and format it
  • mypy: check static typing
• Test through pytest with the following plugins
  • pytest-cov: generate test coverage repo
  • pytest-mock: mocking
• commitizen:
  • regulate git commit convention
  • bump project version
  • generate changelog automatically
• Security check through
  • pip-audit
• mkdocs: generate documentation
• pre-commit: git-hook to run the above tools automatically
• Task runner to organize the tools above (one of the following based on user choice, default to invoke)
  • invoke: tasks written in Python (like Makefile in Python)
  • poethepoet: tasks declared in pyproject.toml
  • just: tasks declared in a justfile
• CI/CD
  • GitHub Actions workflows for
    • checking coding style
    • testing
    • publishing package to PyPI
    • pushing documentation to GitHub pages
  • GitHub issue templates, pull request template
• General Python project Dockerfile
• Consolidate most of the tool configurations in pyproject.toml

Getting Started

Prerequisites

• Python
• cruft

Usage

cruft create https://github.com/Lee-W/cookiecutter-python-template

Setup secrets for GitHub Actions

• Required GitHub repository secrets
  • PERSONAL_ACCESS_TOKEN: GitHub personal access token used to bump project version automatically
    • Refer to Creating a personal access token to generate one
• (optional) PyPI Trusted Publishing: no API token is needed
  • required only if you set "build_pypi_package" to "y" during project creation
  • Add a trusted publisher on PyPI for your repository with the workflow name python-publish.yaml (see Creating a PyPI project with a trusted publisher)

Authors

Lee-W