alanwilter / poetry-python-cookiecutter

A cookiecutter template using poetry, ruff, pre-commit and mypy

Python Poetry Managed Cookiecutter template

This is a cookiecutter template that utilises poetry, ruff, pre-commit, and mypy.

How to Use

1. Install poetry, via homebrew or pipx:

   brew install poetry

   or

   pipx install poetry

2. Create a Python virtual environment of your preference and activate it.

3. Install cookiecutter and cruft via, e.g., homebrew or pip:

   python3 -m pip install --upgrade cookiecutter cruft

4. Run the command below to create your new project based on this cookiecutter template:

   cookiecutter https://github.com/alanwilter/poetry-python-cookiecutter

   or

   cookiecutter gh:/alanwilter/poetry-python-cookiecutter

   Alternatively, you can use cruft, which is a layer above cookiecutter. This allows you to manage your project from the template after it has been generated, enabling you to check, diff, or update it:

   cruft create https://github.com/alanwilter/poetry-python-cookiecutter

   The command line interface will ask you to provide several informations.

5. It's optional, but we strongly recommend commitizen

Not Exactly What You Want?

If this template doesn't meet your needs, you can explore thousands of other cookiecutter templates here.