Skip to content

A cookiecutter template for creating a new Python command-line application with Click.

License

Notifications You must be signed in to change notification settings

sgraaf/cookiecutter-python-cli-app

Repository files navigation

cookiecutter-python-cli-app

Supported Python Versions Nox Code style: Ruff Checked with mypy pre-commit

A cookiecutter template for creating a new Python command-line application with Click.

See https://github.com/sgraaf/cookiecutter-python-cli-app-demo for a demo of this template.

Usage

cookiecutter gh:sgraaf/cookiecutter-python-cli-app

Features

  • Beautiful and powerful command-line interfaces with Click
  • Linting with autofix (i.e. removing unused imports, formatting and Python syntax upgrades) with ruff
  • Code formatting with ruff and Prettier
  • Static type-checking with mypy
  • Checks and fixes before every commit with pre-commit
  • Testing with pytest
  • Project automation with Nox
  • Continuous Integration with GitHub Actions and pre-commit.ci
  • Automated version updates for GitHub Actions with Dependabot
  • Documentation with Sphinx, MyST, and Read the Docs using the Furo theme
  • Automated release builds and uploads to PyPI

This template supports Python 3.8, 3.9, 3.10, 3.11 and 3.12.

About

A cookiecutter template for creating a new Python command-line application with Click.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages