Cookiecutter PyPackage

Cookiecutter template for a Python package.

• GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/
• Free software: MIT license
• Discord: https://discord.gg/PWXJr3upUE

Features

• Testing setup with pytest
• GitHub Actions testing: Setup to easily test for Python 3.10, 3.11, 3.12, and 3.13
• Auto-release to PyPI when you push a new tag to master (optional)
• Command line interface using Typer

Quickstart

Install the latest Cookiecutter if you haven't installed it yet:

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git

Then:

• Create a repo and put it there.
• Register your project with PyPI.
• Add the repo to your Read the Docs account + turn on the Read the Docs service hook.
• Release your package by pushing a new tag to master.

Not Exactly What You Want?

Don't worry, you have options:

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

Similar Cookiecutter Templates

Explore other forks to get ideas. See the network and family tree for this repo.

Or Submit a Pull Request

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.