pypkgkit 2.1.2

A template for python packages

pypkgkit

A Cookiecutter template for Python packages. One command gives you a fully configured project with linting, type checking, testing, CI/CD, documentation, and automated releases — all wired together and ready to go.

Quick start

From GitHub (latest)

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

# Generate a new project from the latest template
cookiecutter gh:michaelellis003/pypkgkit

From PyPI (pinned version)

# Install pypkgkit
uv tool install pypkgkit

# Generate a new project using a specific release
uvx cookiecutter pypkgkit

Installing from PyPI lets you pin to a specific template version. The package includes the cookiecutter template and can be used directly as a cookiecutter source.

You will be prompted for a few values:

Variable	Default	Description
project_name	my-python-package	Name of the project (used in PyPI, GitHub, etc.)
project_slug	auto	Python-importable name (derived from project name)
project_description	A Python package	One-line description
author_name	Your Name	Author name for pyproject.toml and LICENSE
author_email	[e-mail]	Author email
github_username	your-github-username	GitHub username (used in URLs, badges, CODEOWNERS)
python_version	3.12	Minimum Python version
initial_version	0.1.0	Starting version

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:

Concern	Tool
Package management	uv
Linting & formatting	Ruff
Type checking	ty
Testing	pytest
Documentation	ProperDocs (MkDocs Material + mkdocstrings)
Versioning & releases	python-semantic-release with Conventional Commits
CI/CD	GitHub Actions (lint, type check, test across 3.10 – 3.13, build, release to PyPI, deploy docs)
Dependency updates	Dependabot (weekly, for both Actions and pip)
Pre-commit hooks	Ruff, ty, license headers, conventional commit validation

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.