Skip to content

pawamoy/copier-poetry

Repository files navigation

Copier Poetry

Copier template for Python projects managed by Poetry.

⚠️ 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:

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.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
  • 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.