python_cli_template

🐍 Python CLI Template

Quick Start

Greet a name:

pipx run python_cli_template --name world

Prerequisites

• Python
• pipx

CLI

Install the CLI:

pipx install python_cli_template

--name

Optional: Name to greet. Defaults to World.

python_cli_template --name Alex

--version

Show the program's version number and exit:

python_cli_template --version # python_cli_template -v

Show the help message and exit:

python_cli_template --help # python_cli_template -h

Script

Create a virtual environment:

python3 -m venv .venv

Activate the virtual environment:

source .venv/bin/activate

Install the package:

pip install python_cli_template

Greet a name:

# script.py
from python_cli_template import hello

print(hello("Bob"))

Run the script:

python script.py

License

MIT