/copier-poetry

Copier template for poetry projects.

Primary LanguageJinjaMIT LicenseMIT

๐Ÿ“‹ copier-poetry

Copier template for poetry projects.

GitHub repo stars License GitHub last commit (main) GitHub release GitHub commits since latest release Copier supported version

Features

  • ๐Ÿ“ฆ Poetry setup with a pre-defined pyproject.toml
  • ๐Ÿ” Continuous integration (CI) pipelines for Github Actions and GitLab CI/CD
  • ๐Ÿณ Docker support with build and publish pipelines
  • โš™๏ธ Settings management using pydantic-settings
  • ๐Ÿ—„๏ธ Database support with sqlmodel and mysql, postgres or sqlite configuration
  • โ–ถ๏ธ alembic database migrations
  • ๐Ÿƒ poethepoet task runner
  • ๐Ÿช pre-commit hooks
  • ๐Ÿ” pylint code linter
  • ๐Ÿ mypy static type checker
  • ๐Ÿงช pytest unit tests
  • ๐Ÿ›ก๏ธ bandit code security check
  • ๐ŸŽจ autopep8 and pydocstringformatter code formatter and styling
  • ๐Ÿ†š VSCode configuration

Requirements

First install copier:
(from the official installation documentation)

pip install copier

Usage

Make sure the requirements are met, then:

copier copy --trust "https://github.com/worldworm/copier-poetry.git" .

Update

To update a template after creating a project, run:

copier update --trust -a .project/.copier-answers.poetry.yml .

Explore more Copier templates

In addition to this template, there are a number of other Copier templates available. For an overview of all available templates, visit the Templates Showcase repository.


ยฉ worldworm 2023-2024
Licensed under MIT