A modern Cookiecutter template for scaffolding Python packages and apps.
Setting up a new project with this template
- Install Cruft in your Python environment with:
pip install cruft
- Create a new repository and clone it locally.
- In the repository's parent directory, run:
cruft create -f [email protected]:radix-ai/poetry-cookiecutter.git
Updating your project with the latest template
- Run
cruft check
to check for updates. - Run
cruft update
to update to the latest scaffolding. - Address failed merges in any
.rej
files.
- ๐งโ๐ป 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