ConorSheehan1 / cookiecutter-fire-cli

A cookiecutter template for creating a fire cli python package

A cookiecutter template for creating a new python package with a fire command line interface.

Usage

To create a new project using this cookiecutter template:

pip install cookiecutter poetry
cookiecutter gh:ConorSheehan1/cookiecutter-fire-cli

# cd your_new_package
poetry install
poetry run task install_hooks

For full cookiecutter instructions see https://github.com/audreyr/cookiecutter#features

Configuration provided

1. testing
   1. pytest
   2. github actions
      1. ci
      2. release (github release, optional)
      3. deploy (to pypi, requires additional steps, optional)
2. linting
   1. black autoformatter
   2. isort import sorter
   3. mypy type checker
3. dependency management / packaging
   1. poetry
4. version management
   1. bump2version
5. license
   1. MIT
6. githooks
   1. pre-commit (requires additional steps)

Local/Dev install

poetry install
poetry run cookiecutter .
# poetry run cookiecutter . --overwrite-if-exists --no-input