template-python-cli

Opinionated Python template for new CLIs.

• Source code
• PyPI package
• Snyk Advisor

Getting Started

1. Go to or create the CLI folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-python-cli

or

npx degit github:joaopalmeiro/template-python-cli --force

3. Search for template-python-cli and replace it with the CLI name. Ignore the template repository URL in the NOTES.md file.
4. Search for template_python_cli and replace it with the underscored version of the CLI name.
5. Search for Opinionated Python template for new CLIs. and replace it with the (short) CLI description.
6. Search for João Palmeiro and replace it with the author's name.
7. Search for [email protected] and replace it with the author's email address.
8. Open the pyproject.toml file and add the CLI-specific dependencies. See the Dependency configuration and Environment configuration pages in the Hatch documentation for more information (if necessary).
9. Update the Source code link at the top to the CLI repository link (if necessary).
10. Change GitHub in the Deployment section to GitLab or Codeberg and update the link to the corresponding Tags page (if necessary).
11. Update the Issues and Source fields in the pyproject.toml file with their respective repository-related links (if necessary).
12. Remove hatch-cli-demo/ from the .gitignore file.
13. Delete the TEMPLATE.md file.
14. Delete the Getting Started section.

Usage

Via pipx

pipx run template-python-cli --help

pipx run template-python-cli

Development

Install pyenv (if necessary).

pyenv install && pyenv versions

pip install hatch==1.12.0 && hatch --version

hatch config set dirs.env.virtual .hatch

hatch config show

hatch env create

hatch status

hatch env show

hatch dep show table

hatch run pip list

hatch run template-python-cli --help

hatch run template-python-cli

hatch run qa:lint

hatch run qa:format

hatch project metadata

Deployment

hatch version micro

hatch version minor

hatch version major

hatch build --clean

echo "v$(hatch version)" | pbcopy

• Commit and push changes.
• Create a tag on GitHub Desktop.
• Check GitHub.

hatch publish

• Check PyPI.