cookiecutter_example

Python Boilerplate contains all the boilerplate you need to create a Python package.

• GitHub | PyPI | Documentation
• Created by Andreas Larsen | GitHub @andlarsen | PyPI @andlarsen
• MIT License

Features

• TODO

Documentation

Documentation is built with Zensical and deployed to GitHub Pages.

• Live site: https://andlarsen.github.io/cookiecutter_example/
• Preview locally: just docs-serve (serves at http://localhost:8000)
• Build: just docs-build

API documentation is auto-generated from docstrings using mkdocstrings.

Docs deploy automatically on push to main via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to GitHub Actions.

Development

To set up for local development:

# Clone your fork
git clone git@github.com:your_username/cookiecutter_example.git
cd cookiecutter_example

# Install in editable mode with live updates
uv tool install --editable .

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run cookiecutter_example.

Run tests:

uv run pytest

Run quality checks (format, lint, type check, test):

just qa

Author

cookiecutter_example was created in 2026 by Andreas Larsen.

Built with Cookiecutter and the audreyfeldroy/cookiecutter-pypackage project template.