Cookiecutter for Python packages

Creating a new project

1. Install cruft:

pip3 install cruft

or personally i use:

brew install cruft

2. Run cruft:

cruft create /~https://github.com/A-Thakkar/cookiecutter-pypackage

3. Fill out the requested information.

Optional updating:

4. You can automatically get changes from this template with:

cruft update

see the cruft docs for further information.

Features

• Cruft: Manage cookiecutter templates
• UV: Manage python, versions, dependancy, build, and release
• Pytest: Testing framework
• Ruff: Formatting and linting
• mypy: Static type checking
• Typer: Command line interfaces (CLI)
• GitHub Actions: CI for pytest, mypy, ruff
• Mkdocs: Writing your docs in markdown style
• Mkdocstrings: Auto API doc generation

Consider (not implemented)

• Tox: improved testing
• Rich: CLI formatting
• autodocStrings: VSCode extension for docstring templates

Credits

Feel free to adapt this template to your needs, but please credit me in your README and link back to /~https://github.com/A-Thakkar/cookiecutter-pypackage.

This repo was inspired by:

• cthoyt/cookiecutter-snekpack
• zillionare/python-project-wizard
• audreyfeldroy/cookiecutter-pypackage