/cookiecutter-poetry

Python Cookiecutter template with Flake8, Black, isort, Mypy, pre-commit hooks, Poetry, & Poe

Primary LanguagePythonApache License 2.0Apache-2.0

Poetry Python Cookiecutter

License standard-readme compliant

A minimal Cookiecutter template for creating Python packages with Poetry + common tools

Background

This project is a Python Cookiecutter template that includes the following:

Install

First, make sure both pipx and cookiecutter are installed. For example, on Mac:

brew install pipx
pipx install cookiecutter

Then, run the following command:

cookiecutter gh:dtbuchholz/cookiecutter-poetry

This will run your through setup steps and create the templated project.

Usage

The project uses poetry for dependency management and packaging. You'll want to make sure you have it installed:

pipx install poetry

Then, you can install the project dependencies:

poetry install

The README that gets created when the template is generated explains the other functionality.

Contribute

PRs accepted.

License

Apache-2.0 © Dan Buchholz