pypkgkit

A Cookiecutter template for Python packages. A fully configured project with linting, type checking, testing, CI/CD, documentation, and automated releases to PyPI.

Quick start

# Install cookiecutter if you haven't already
uv tool install cookiecutter

# Generate a new project
cookiecutter gh:michaelellis003/pypkgkit

To pin a specific template version, pass the --checkout flag with a release tag:

cookiecutter gh:michaelellis003/pypkgkit --checkout v2.1.2

You will be prompted for a few values:

After generation, the template automatically:

1. Initializes a git repository
2. Installs dependencies with uv sync
3. Installs pre-commit hooks
4. Creates an initial commit

What is included

Every generated project comes with:

After generating your project

1. Create a GitHub repo and push:

   git remote add origin https://github.com/<username>/<project-name>.git
   git push -u origin main
   

2. Configure GitHub settings:

   • GitHub Pages: Settings > Pages > Source: gh-pages
   • RELEASE_TOKEN: Settings > Secrets — a PAT with contents: write
   • PyPI trusted publishing: add the repo on pypi.org
   • CODECOV_TOKEN: Settings > Secrets (optional)

Requirements

• uv installed
• cookiecutter (uv tool install cookiecutter)

Contributing

To work on the template itself:

git clone https://github.com/michaelellis003/pypkgkit.git
cd pypkgkit
uv sync
uv run pre-commit install
uv run pre-commit install --hook-type commit-msg
uv run pre-commit install --hook-type pre-push

Test the template locally:

cookiecutter . --no-input

License

Apache 2.0. See LICENSE for the full text.