Copier Poetry¤
Copier template for Python projects managed by Poetry.
This copier template is mainly for my own usage, but feel free to try it out, or fork it!
Also checkout copier-pdm, which is the same template but with PDM instead of Poetry.
Features¤
- Poetry setup, with pre-defined
pyproject.toml
- Documentation built with MkDocs (Material theme and "autodoc" mkdocstrings plugin)
- Pre-configured tools for code formatting, quality analysis and testing:
- Tests run with pytest and plugins, with coverage support
- Cross-platform tasks with duty
- Support for GitHub workflow and Gitlab CI
- Python 3.6 or above
- Auto-generated
CHANGELOG.md
from git commits (using Angular message style) - Auto-generated
CREDITS.md
from Python dependencies - All licenses from choosealicense.com
- Makefile for convenience
Quick setup and usage¤
Make sure all the requirements are met, then:
copier "https://github.com/pawamoy/copier-poetry.git" /path/to/your/new/project
Or even shorter:
copier "gh:pawamoy/copier-poetry" /path/to/your/new/project
See the documentation for more details.