cookiecutter-py

🐍 Modern Python project Cookiecutter template

Explore the latest docs »

---

Each time you start a new Python project, you shouldn't start from scratch. Ideally, you'd start with a standard project structure and set of tools and integrations to help facilitate writing quality Python code.

This modern Python Cookiecutter template is the tool that will help you do just that.

---

✨ Features

• poetry to manage dependencies

• structlog for logging

• mypy for static typing

• pytest, hypothesis, mutmut for testing

  • pytest-cov for coverage reports
  • pytest-mock for mocks
  • pytest-xdist for distributed testing
  • pytest-randomly to randomly order tests

• tox for testing automation

• sphinx for docs

  • myst-parser for markdown docs
  • selectable theme

• pdb++ for debugging

• konch for shell configuration w/ ipython support

• pre-commit hooks with various hooks (mypy / black / ruff / deptry)

• dockerfile for development, testing, and production

• dunamai for versioning

• custom Justfile (run just)

• stay up-to-date w/ configured dependabot

• github-actions with ci (leveraging tox), publish to pypi workflows w/ release-drafter integration

  • ci workflow (leveraging tox)

    • optional codecov integration for code coverage

  • publish workflow (to test.pypi.org / pypi.org) w/ release-drafter integration

  • auto approve / merge workflow

  • with these additional workflows:

    • codeql
    • hadolint
    • pr-size-labeling
    • commitlint
    • trufflehog

• optional direnv .envrc (with pyenv layout)

🚀 Getting Started

Prerequisites

Install Cookiecutter

poetry add cookiecutter
# pip install cookiecutter
# pipenv install cookiecutter

Optional: Install Cruft

poetry add cruft
# pip install cruft
# pipenv install cruft

🛠️ Usage

Cookiecutter

cookiecutter gh:ryankanno/cookiecutter-py

Note: If you want to use the auto approve / merge Dependabot workflow, make sure to create tags major, minor, patch so that Dependabot can tag its PRs. The workflow won't merge anything with a major tag.

Cruft (Optional)

cruft create https://github.com/ryankanno/cookiecutter-py/

🔍 Details

Coming soon to a README near you!

Docker

To build the container:

DOCKER_BUILDKIT=1 docker build .

To run the container (if you've installed the defaults):

docker run <image_id or tag> python -m surf.surf

Versioning

If you enable the PyPi workflow, versioning will happen via dunamai within the Github pipeline.

If instead, you prefer to version your package, please do it via poetry version $(dunamai from any) as recommended in their documentation.

🚧 Roadmap

See the open issues for a list of proposed features (and known issues).

☑️ TODO

• add mutmut example to template
• add hypothesis example to template
• add licenses
• add typeguard
• version releases
• update docs
  • include cookiecutter var descriptions
• update default/initial template doc structure
• add publish docs workflow
• investigate uv
• migrate to uv
• plan for 1.0

🤝 Contributing

Contributions are very much appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/new-cookiecutter-feature)
3. Commit your changes (git commit -m 'Added a new feature')
4. Push to the feature branch (git push origin feature/new-cookiecutter-feature)
5. Open a PR! 🎆

📝 License

Distributed under the MIT License. See LICENSE for more information.

📫 Contact

Ryan Kanno - @ryankanno

Project Link: https://github.com/ryankanno/cookiecutter-py