Poetry Cookiecutter

A modern Cookiecutter template for scaffolding Python packages and apps.

Using

Setting up a new project with this template

1. Install Cruft in your Python environment with:

   pip install cruft

2. Create a new repository and clone it locally.
3. In the repository's parent directory, run:

   cruft create -f [email protected]:radix-ai/poetry-cookiecutter.git

Updating your project with the latest template

1. Run cruft check to check for updates.
2. Run cruft update to update to the latest scaffolding.
3. Address failed merges in any .rej files.

Features

• 🧑‍💻 Quick and reproducible development environments with VS Code's Dev Containers and PyCharm's Docker Compose interpreter
• 📦 Packaging and dependency management with Poetry
• ⚡️ Task running with Poe the Poet
• ✍️ Code formatting with black and isort
• ✅ Code linting with pre-commit: bandit, darglint, flake8, mypy, pre-commit-hooks, pydocstyle, pygrep-hooks, pyupgrade, safety, and shellcheck
• 🏷 Follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen
• ♻️ Continuous integration with GitHub Actions or GitLab CI/CD
• 🧪 Test coverage with Coverage.py
• 🏗 Scaffolding upgrades with Cookiecutter and Cruft
• 🧰 Automated dependency updating with Dependabot