Opinionated Python template for new CLIs.
- Go to or create the package folder.
- Get the template files:
npx degit github:joaopalmeiro/template-python-cli
or
npx degit github:joaopalmeiro/template-python-cli --force
- Search for
template-python-cli
and replace it with the package name. - Search for
template_python_cli
and replace it with the underscored version of the package name. - Search for
Opinionated Python template for new CLIs.
and replace it with the (short) package description. - Search for
João Palmeiro
and replace it with the author's name. - Search for
joaopalmeiro@proton.me
and replace it with the author's email address. - Open the pyproject.toml file and add the package-specific dependencies. See the
Dependency configuration
andEnvironment configuration
pages in the Hatch documentation for more information (if necessary). - Update the
Source code
link at the top to the package repository link (if necessary). - Change
GitHub
in theDeployment
section toGitLab
orCodeberg
and update the link to the corresponding Tags page (if necessary). - Update the
Issues
andSource
fields in the pyproject.toml with their respective repository-related links (if necessary). - Delete the TEMPLATE.md file.
- Delete the
Getting Started
section.
Via pipx
pipx run template-python-cli --help
pipx run template-python-cli
Install pyenv (if necessary).
pyenv install && pyenv versions
pip install hatch==1.9.3 && 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 template-python-cli --help
hatch run template-python-cli
hatch run lint
hatch run format
hatch version micro
hatch version minor
hatch version major
hatch build --clean
- Commit and push changes.
- Create a tag on GitHub Desktop.
- Check GitHub.
hatch publish
- Check PyPI.