cli-base-utilities
Helpers to build a CLI program and some useful tools for CLI programs.
pip install cli-base-utilities
Features
Some of the features are:
TODO: Document all features here ;)
start development
~$ git clone https://codeberg.org/jedie/cli-base-utilities.git
~$ cd cli-base-utilities
~/cli-base-utilities$ ./dev-cli.py --help
dev CLI
usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,shell-completion,test,update,update-readme-history,update-test-snapshot-files,version}
╭─ options ──────────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────╮
│ (required) │
│ • coverage Run tests and show coverage report. │
│ • install Install requirements and 'cli_base' via pip as editable. │
│ • lint Check/fix code style by run: "ruff check --fix" │
│ • mypy Run Mypy (configured in pyproject.toml) │
│ • nox Run nox │
│ • pip-audit Run pip-audit check against current requirements files │
│ • publish Build and upload this project to PyPi │
│ • shell-completion │
│ Setup shell completion for this CLI (Currently only for bash and zsh) │
│ • test Run unittests │
│ • update Update dependencies (uv.lock) and git pre-commit hooks │
│ • update-readme-history │
│ Update project history base on git commits/tags in README.md │
│ │
│ Will be exited with 1 if the README.md was updated otherwise with 0. │
│ │
│ Also, callable via e.g.: │
│ python -m cli_base update-readme-history -v │
│ • update-test-snapshot-files │
│ Update all test snapshot files (by remove and recreate all snapshot │
│ files) │
│ • version Print version and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
app CLI
usage: cli-base-utilities [-h] {shell-completion,update-readme-history,version}
╭─ options ──────────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────╮
│ (required) │
│ • shell-completion │
│ Setup shell completion for this CLI (Currently only for bash and zsh) │
│ • update-readme-history │
│ Update project history base on git commits/tags in README.md │
│ │
│ Will always exist with exit code 0 because changed README is auto added │
│ to git. │
│ │
│ Also, callable via e.g.: │
│ python -m cli_base update-readme-history -v │
│ • version Print version and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
DEMO app CLI
usage: ./demo-cli.py [-h] {demo-endless-loop,demo-verbose-check-output-error,edit-settings,print-settings,systemd-debug,systemd-logs,systemd-remove,systemd-setup,systemd-status,systemd-stop,version}
╭─ options ──────────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────╮
│ (required) │
│ • demo-endless-loop │
│ Just a useless example command, used in systemd DEMO: It just print │
│ some information in a endless loop. │
│ • demo-verbose-check-output-error │
│ DEMO for a error calling │
│ cli_base.cli_tools.subprocess_utils.verbose_check_output() │
│ • edit-settings Edit the settings file. On first call: Create the default one. │
│ • print-settings │
│ Display (anonymized) MQTT server username and password │
│ • systemd-debug Print Systemd service template + context + rendered file content. │
│ • systemd-logs List and follow logs of systemd service. (May need sudo) │
│ • systemd-remove │
│ Write Systemd service file, enable it and (re-)start the service. │
│ (May need sudo) │
│ • systemd-setup Write Systemd service file, enable it and (re-)start the service. │
│ (May need sudo) │
│ • systemd-status │
│ Display status of systemd service. (May need sudo) │
│ • systemd-stop Stops the systemd service. (May need sudo) │
│ • version Print version and exit │
╰────────────────────────────────────────────────────────────────────────────────────────╯
Generate project history base on git commits/tags
Add a test case similar to cli_base/tests/test_readme_history.py into your project.
Add the needed start/end comments into your README.
To make a new release, do this:
- Increase your project version number
- Run tests to update the README
- commit the changes
- Create release
It's recommended to use git hookd (via pre-commit) to update the README.
For this, add in your pyproject.toml:
[tool.cli_base]
version_module_name = "<your_package>" # Must provide the `__version__` attribute
Copy&paste .pre-commit-config.yaml into your project.
Add pre-commit to your requirements and install the git hooks by:
.venv/bin/pre-commit install
.venv/bin/pre-commit autoupdate
Update pre-commit hooks
Update version in .pre-commit-config.yaml and make a release.
The Problem: The hooks are broken, if the "new" version is not tagged yet.
To create a release, it's possible to use all git commands (commit, push, etc) with --no-verify to skip the hooks.
It's easier to temporarily uninstall the hooks, create the release and install the hooks again, e.g.:
.../cli-base-utilities$ .venv/bin/pre-commit uninstall
# ...bump version, commit, push, merge... create release...
.../cli-base-utilities$ .venv/bin/pre-commit install
Backwards-incompatible changes
v0.14 - Switch from pip-tools to uv
cli_base.run_pip_audit.run_pip_audit() works now with uv base projects instead of pip-tools.
history
- v0.33.0
- 2026-09-21 - NEW: optional
force_dev_platformin [tool.cli_base] - 2026-09-21 - Apply project updates
- 2026-09-21 - Add project links to README
- 2026-09-21 - NEW: optional
- v0.32.2
- 2026-09-13 - fix more github -> codeberg links
- v0.32.1
- 2026-09-13 - FIX: TypeCheckError: argument "project_info" (cli_base.cli_tools.git.CodebergInfo) did not match
- 2026-09-13 - NEW: git.get_remote_info()
- 2026-09-13 - Update README
- 2026-09-11 - README.md aktualisiert
- v0.32.0
- 2026-09-11 - GitHub -> Codeberg + Radicle
Expand older history entries ...
- v0.31.1
- 2026-08-22 - Fix "pip-audit" command
- 2026-08-22 - apply projects upgrades
- 2026-06-16 - Enhance README utils
- 2026-06-16 - remove lock file from git
- v0.30.0
- 2026-04-11 - Enhance print_version(): Add optional project_name and clean module name
- v0.29.2
- 2026-04-10 - Bugfix fallback to default Path instance
- 2026-04-10 - update requirements
- v0.29.1
- 2026-04-09 - fix tests
- 2026-04-09 - run_pip_audit(): Fill temp file directly from uv
- 2026-04-09 - update requirements
- 2026-04-09 - Apply project updates
- v0.29.0
- 2026-03-28 - fix publishing
- 2026-03-28 - fix CI
- 2026-03-28 - fix tests
- 2026-03-28 - fix ruff
- 2026-03-28 - deprecate shell completion
- 2026-03-28 - Apply manageprojects updates
- v0.28.0
- 2026-02-19 - Fix update_readme_history() by escape backslashes for markdown rendering
- 2026-02-19 - Don't set "text=True" as default for subprocess.check_call()
- 2026-02-19 - Bugfix the "missing parts count" value in assert_in()
- v0.27.4
- 2026-02-16 - Bugfix initial commits without any parent version number
- 2026-02-16 - Update requirements
- v0.27.3
- 2026-01-30 - Bugfix run_pip_audit() and add a tests for it
- 2026-01-30 - self.assert_in_content() -> assert_in()
- 2026-01-30 - Update requirements
- v0.27.2
- 2026-01-25 - Update requirements
- 2026-01-25 - Enhance "assert_in": No stdout usage and no click import
- v0.27.1
- 2026-01-19 - Import pwd only if needed to avoid issues on non-unix systems
- 2026-01-19 - Update requirements
- v0.27.0
- 2026-01-14 - NEW: cli_base.cli_tools.test_utils.base_testcases to deny output in unittests
- 2026-01-14 - Apply manageprojects updates
- 2026-01-14 - Update requirements
- v0.26.0
- 2025-12-22 - Update README
- 2025-12-22 - NEW: git.changed_files(): Get a list of Path objects containing the changed files
- 2025-12-22 - Update requirements
- 2025-12-22 - Remove verbose output on "pip-audit" run
- 2025-10-13 - -cli_base/cli_dev/update_readme_history.py and update test snapshots
- 2025-10-13 - Fix code style
- 2025-10-13 - Apply manageproject template updates
- v0.25.0
- 2025-09-23 - Shell completion: Remove fix_completion_prog() and add support for Z-Shell
- v0.24.1
- 2025-09-22 - Fix tests: don't remove the ".gitignore" file
- 2025-09-22 - Add integration tests for shell complete with snapshots
- 2025-09-22 - fix shell-complete and match full cli program path
- 2025-09-22 - suffix prog name to differate between app/dev cli
- v0.24.0
- 2025-09-22 - Check README in CI, too
- 2025-09-22 - NEW: setup_tyro_shell_completion(): Helper to setup shell completion for Tyro CLIs
- 2025-09-22 - Don't use rich_traceback_install() in own CLI
- 2025-09-20 - Update requirements
- v0.23.3
- 2025-09-20 - pre-commit config: Remove "default_install_hook_types"
- 2025-09-20 - Update README: Always exit with 0 and always add (but no amend commit) changed README
- 2025-09-20 - Update requirements
- v0.23.2
- 2025-09-20 - Always exit with 0 if "auto-commit" is on.
- v0.23.1
- 2025-09-20 - Update git history tests
- 2025-09-20 - Bugfix Git detection and error messages
- 2025-09-20 - Enhance pre-commit hook: Auto commit the changed README file
- 2025-09-20 - update/add PyCharm run configs
- 2025-09-20 - add pycharm .run file
- 2025-09-20 - Remove obsolete ".flake8" file
- 2025-09-20 - Update requirements and fix tests
- v0.23.0
- 2025-09-04 - separate click CLI test tools and deprecate them all
- v0.22.0
- 2025-09-03 - Use ruff instead of darker
- v0.21.1
- 2025-08-05 - Enhance MockToolsExecutor and accept "cwd", too.
- v0.21.0
- 2025-08-05 - NEW: Helper to mock
ToolsExecutorin tests.
- 2025-08-05 - NEW: Helper to mock
- v0.20.0
- 2025-08-04 - Release v0.20.0
- 2025-08-04 - Fix git history caused by github
- v0.19.0
- 2025-07-29 - Expand Git() around commit message
- 2025-07-29 - Update requirements
- v0.18.0
- 2025-06-16 - Add helper to display logs from systemd service
- 2025-06-16 - Update requirements
- v0.17.1
- 2025-06-02 - Update requirements
- 2025-06-02 - Execute "pre-commit autoupdate" only if "pre-commit" is installed
- v0.17.0
- 2025-02-12 - migrate from tox to nox
- v0.16.0
- 2025-01-17 - +lookup_python_tool()
- v0.15.1
- 2025-01-17 - Remove pip-tools work-a-round and update requirements
- v0.15.0
- 2024-12-03 - Restructure cli test utils
- 2024-12-03 - Remove tyro work-a-round
- v0.14.0
- 2024-11-21 - Use tyro.extras.SubcommandApp()
- 2024-11-21 - Update "install" command and use uv
- 2024-11-21 - Switch from pip-tools to uv
- v0.13.1
- 2024-09-26 - Bugfix missing click. Add it for Backward compatibility
- v0.13.0
- 2024-09-26 - Add Helper for tyro and replace click with tyro in own CLIs
- v0.12.0
- 2024-09-25 - Add debug log to update_readme_history call
- 2024-09-25 - Simplify AssertCliHelpInReadme to a flat function
- 2024-09-25 - Apply manage projects updates
- 2024-09-25 - Update requirements
- v0.11.0
- 2024-08-30 - Apply manageprojects updates, e.g.: Set min. Python to 3.11+
- 2024-08-30 - NEW: EncloseRuleContext
- v0.10.3
- 2024-08-05 - Bugfix unchanable boolean flags in toml settings
- v0.10.2
- 2024-08-04 - Auto activate pre commit hooks
- 2024-08-04 - Update demo CLI: Always update pip and pip-tools
- 2024-08-04 - Handle KeyboardInterrupt in cli scripts.
- 2024-08-04 - Bugfix #50 toml2dataclass(): AttributeError: 'bool' object has no attribute 'unwrap'.
- 2024-08-02 - Fix doc link in README.md
- v0.10.1
- 2024-08-02 - Increase default timout from 5 to 15 minutes
- 2024-08-02 - Update pre-commit hook version to cli-base-utilities v0.10.0
- v0.10.0
- 2024-08-02 - Use dateutil in get_commit_date()
- 2024-08-02 - Replace "safety" by "pip-audit" and add tooling for it.
- 2024-08-01 - Update manageprojects updates
- v0.9.0
- 2024-07-16 - Update project
- v0.8.0
- 2024-03-12 - Bugfix publish
- 2024-03-12 - fix tests
- 2024-03-12 - Split app/dev CLI into a package with autodiscovery
- 2024-03-12 - Move click defaults
- 2024-03-12 - Apply cookiecutter template updates
- 2024-03-12 - Update requirements
- 2024-01-16 - Use typeguard in tests
- 2024-01-16 - manageprojects updates
- 2024-01-16 - Update requirements + datetimes ;)
- 2023-12-17 - Bugfix .pre-commit-config.yaml
- v0.7.0
- 2023-12-16 - Add "Update pre-commit hooks" to README
- 2023-12-16 - Bugfix update_readme_history(): Use
__version__from module - 2023-12-16 - NEW: "update-readme-history" git hook using "pre-commit"
- 2023-12-16 - fix tests
- 2023-12-16 - Bugfix type hints
- 2023-12-16 - Add update-readme-history to app CLI
- 2023-12-16 - Move DEMO into
./cli_base/demo/ - 2023-12-16 - Simplify App CLI
- 2023-12-16 - Remove PACKAGE_ROOT from app CLI
- 2023-12-16 - Update requirements
- 2023-12-16 - Skip test_readme_history() on CI
- v0.6.0
- 2023-12-02 - NEW: Code style tools
- v0.5.0
- 2023-12-01 - fix flake8
- 2023-12-01 - NEW: test utils: AssertLogs() context manager
- 2023-12-01 - Bugfix expand_user() if SUDO_USER is the same as current user
- 2023-12-01 - Add "run_coverage()" to "dev_tools" and polish tox, unittest, too.
- 2023-12-01 - add tests for EraseCoverageData()
- 2023-12-01 - Apply manageprojects updates
- v0.4.5
- 2023-11-30 - Configure unittests via "load_tests Protocol" hook
- 2023-11-30 - Update requirements and add "flake8-bugbear"
- 2023-11-30 - Remove function calls in function agruments
- v0.4.4
- 2023-11-01 - Bugfix "AssertionError: Expected only one line" in Git.first_commit_info()
- v0.4.3
- 2023-11-01 - Git history renderer: Collapse older entries
- v0.4.2
- 2023-11-01 - Remove duplicate git commits and keep only test last one, e.g.: "update requirements"
- 2023-11-01 - Bugfix git history: Add commits before the first tag
- v0.4.1
- 2023-10-08 - Remove commit URLs from history and handle release a new version
- 2023-10-08 - NEW: Generate a project history base on git commits/tags.
- 2023-10-08 - Update requirements
- 2023-09-26 - Update README.md
- v0.4.0
- 2023-09-24 - fix tests
- 2023-09-24 - Add UpdateTestSnapshotFiles() Context Manager
- 2023-09-24 - coverage: Refactor setup and add helpers
- 2023-09-24 - Update requirements
- v0.3.0
- 2023-08-17 - Bugfix tests run in terminal
- 2023-08-17 - update requirements
- 2023-08-17 - NEW: cli_base.cli_tools.git and cli_base.cli_tools.version_info
- v0.2.0
- 2023-08-09 - Project setup updates
- 2023-05-22 - Update README.md
- 2023-05-22 - Rename project "cli-base" to "cli-base-utilities"
- 2023-05-22 - Add github CI config
- 2023-05-22 - Add subprocess_utils from manageprojects
- 2023-05-21 - init
GitHub suspended me!
Important notice:
GitHub suspended my account sometime in late August 2026 ! There was no warning beforehand, nor any explanation of the reasons afterwards. Since then, I have had no access or control over my data on GitHub.
All my projects and everything about me have completely disappeared. Everything just results in a 404 "Not Found" error page.
A support request still hasn't been answered, even after several weeks (apart from a confirmation that the request was received).
For that reason, I have been looking for a new home for all my OpenSource projects. (Or rather, I am in the process of republishing all my projects elsewhere.)
Now you can find my on these places:
- Codeberg.org/jedie
- OpenCommit.eu/jedie
- GitLab.com/users/jedie
- Radicle: did🔑z6MkfvNUuBCwRtNZwANEAGd4vaTzyuZXMKfiSyjoBALga934 | jedie.radicle.garden
That is why there will probably be a lot of broken links pointing to my GitHub account for quite some time!
#GitHubSuspendedMe #GiveUpGitHub
Project links
Metadata
Release files for cli-base-utilities 0.33.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cli_base_utilities-0.33.0.tar.gz | 87.4 kB | Without provenance | Details for cli_base_utilities-0.33.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cli_base_utilities-0.33.0-py3-none-any.whl | Python 3 | none | any | Details for cli_base_utilities-0.33.0-py3-none-any.whl |
Total release size: 198.5 kB
Release files / cli_base_utilities-0.33.0.tar.gz
| Download URL | cli_base_utilities-0.33.0.tar.gz |
|---|---|
| Size | 87.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b402f76991852acbf4083248371679cc2471306ccf4358b4ff56e4b490a51e53
|
|
BLAKE2b-256 checksum How to use checksums |
c84c48de0e1374050ba02f9e121521605c9585c1ee560a9572c25633bf2dbd67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Release files / cli_base_utilities-0.33.0-py3-none-any.whl
| Download URL | cli_base_utilities-0.33.0-py3-none-any.whl |
|---|---|
| Size | 111.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdb14ccda2da6b14c88c3e940e48a3bac65a4338fe295b6a9a14c0d6dfe97696
|
|
BLAKE2b-256 checksum How to use checksums |
114df30a96434ed8b637d2be622a368d90cf534ba229d92a8af41b91bec8422b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Security for cli-base-utilities 0.33.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.