Skip to main content

Cookiecutter template for new Python projects

Project description

Cookiecutter template for new Python projects

PyPI PyPI - Python Version Build codecov GitHub stars

cookie-python

A template for new Python projects, with:

Poetry installation

Via pipx:

pip install pipx
pipx install poetry
pipx inject poetry poetry-pre-commit-plugin

Via pip:

pip install poetry
poetry self add poetry-pre-commit-plugin

New project creation

With cruft via script

poetry install
poetry run new-cookie <path>  # or poetry run cruft create

With cookiecutter directly

pip install cookiecutter
cookiecutter https://github.com/smkent/cookie-python

Development tasks

  • Setup: poetry install
  • Run static checks: poetry run poe lint or poetry run pre-commit run --all-files
  • Run static checks and tests: poetry run poe test
  • Update test expected output files from test results: poetry run poe updatetests

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page