Console Script Setup¶

Optionally, your package can include a console script using Typer, Click or argparse.

How it works¶

If the command_line_interface option is set to ["Typer"], ["click"] or ["argparse"] during setup, cookiecutter will add a file cli.py in the project_slug subdirectory.

Usage¶

To use the console script in development:

$ python -m pip install -e PROJECTDIR

PROJECTDIR should be the top level project directory with the pyproject.toml file.

The script will be generated with output for no arguments and --help.

--help: show help menu and exit