https://github.com/pawamoy/copier-poetry
Copier template for Python projects managed by Poetry.
https://github.com/pawamoy/copier-poetry
bootstrapping copier copier-template poetry python scaffolding template
Last synced: 3 months ago
JSON representation
Copier template for Python projects managed by Poetry.
- Host: GitHub
- URL: https://github.com/pawamoy/copier-poetry
- Owner: pawamoy
- License: isc
- Created: 2020-04-16T10:45:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-25T17:11:45.000Z (10 months ago)
- Last Synced: 2025-05-26T11:14:54.989Z (5 months ago)
- Topics: bootstrapping, copier, copier-template, poetry, python, scaffolding, template
- Language: Jinja
- Homepage: https://pawamoy.github.io/copier-poetry/
- Size: 973 KB
- Stars: 82
- Watchers: 5
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Copier Poetry
[Copier](https://github.com/copier-org/copier) template
for Python projects managed by [Poetry](https://github.com/python-poetry/poetry).
> [!WARNING]
> I personally don't use this template anymore,
> so it is maintained by the community. I will still review and merge PRs though.
> I can add you as a contributor if you wish to maintain the template
> for the community (for personal needs, please fork instead).
Similar templates:
- [copier-pdm](https://github.com/pawamoy/copier-pdm), with [PDM](https://github.com/pdm-project/pdm)
- [copier-uv](https:///github.com/pawamoy/copier-uv), with [uv](https://github.com/astral-sh/uv)
## Features
- [Poetry](https://github.com/sdispater/poetry) setup, with pre-defined `pyproject.toml`
- Documentation built with [MkDocs](https://github.com/mkdocs/mkdocs)
([Material theme](https://github.com/squidfunk/mkdocs-material)
and "autodoc" [mkdocstrings plugin](https://github.com/pawamoy/mkdocstrings))
- Pre-configured tools for code formatting, quality analysis and testing:
- [black](https://github.com/psf/black),
- [flake8](https://gitlab.com/pycqa/flake8) and plugins,
- [isort](https://github.com/timothycrosley/isort),
- [mypy](https://github.com/python/mypy),
- [safety](https://github.com/pyupio/safety)
- Tests run with [pytest](https://github.com/pytest-dev/pytest) and plugins,
with [coverage](https://github.com/nedbat/coveragepy) support
- Cross-platform tasks with [duty](https://github.com/pawamoy/duty)
- Support for GitHub workflow and Gitlab CI
- Python 3.8 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](https://choosealicense.com/appendix/)
- Makefile for convenience
## Quick setup and usage
Make sure all the
[requirements](https://pawamoy.github.io/copier-poetry/requirements)
are met, then:
```bash
copier "https://github.com/pawamoy/copier-poetry.git" /path/to/your/new/project
```
Or even shorter:
```bash
copier "gh:pawamoy/copier-poetry" /path/to/your/new/project
```
See the [documentation](https://pawamoy.github.io/copier-poetry)
for more details.