cli-base-utilities

构建CLI程序和一些CLI程序的有用工具的辅助工具。

pip install cli-base-utilities

特性

一些特性包括

• run_pip_audit() 运行带有来自 pyproject.toml 的配置的 pip-audit

待办事项：在此处记录所有特性 ;)

开始开发

~$ git clone https://github.com/jedie/cli-base-utilities.git
~$ cd cli-base-utilities
~/cli-base-utilities$ ./dev-cli.py --help

dev CLI

usage: ./dev-cli.py [-h]
                    {check-code-style,coverage,fix-code-style,install,mypy,pip-audit,publish,test,
tox,update,update-test-snapshot-files,version}



╭─ options ──────────────────────────────────────────────────────────────────────────────────────╮
│ -h, --help        show this help message and exit                                              │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────────────╮
│ {check-code-style,coverage,fix-code-style,install,mypy,pip-audit,publish,test,tox,update,upda… │
│     check-code-style                                                                           │
│                   Check code style by calling darker + flake8                                  │
│     coverage      Run tests and show coverage report.                                          │
│     fix-code-style                                                                             │
│                   Fix code style of all cli_base source code files via darker                  │
│     install       Run pip-sync and install 'cli_base' via pip as editable.                     │
│     mypy          Run Mypy (configured in pyproject.toml)                                      │
│     pip-audit     Run pip-audit check against current requirements files                       │
│     publish       Build and upload this project to PyPi                                        │
│     test          Run unittests                                                                │
│     tox           Run tox                                                                      │
│     update        Update "requirements*.txt" dependencies files                                │
│     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.py [-h] {update-readme-history,version}



╭─ options ──────────────────────────────────────────────────────────────────────────────────────╮
│ -h, --help        show this help message and exit                                              │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────────────╮
│ {update-readme-history,version}                                                                │
│     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                              │
│     version       Print version and exit                                                       │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯

DEMO app CLI

usage: ./cli.py [-h]
                {demo-endless-loop,demo-verbose-check-output-error,edit-settings,print-settings,sy
stemd-debug,systemd-remove,systemd-setup,systemd-status,systemd-stop,version}



╭─ options ──────────────────────────────────────────────────────────────────────────────────────╮
│ -h, --help                                                                                     │
│     show this help message and exit                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────────────╮
│ {demo-endless-loop,demo-verbose-check-output-error,edit-settings,print-settings,systemd-debug… │
│     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-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                                                                     │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯

根据git提交/标签生成项目历史

将类似于 cli_base/tests/test_readme_history.py 的测试用例添加到您的项目中。在您的README中添加所需的 start/end 注释。

要发布新版本，请执行以下操作

• 增加您的项目版本号
• 运行测试以更新README
• 提交更改
• 创建发布

建议使用 git hookd（通过 pre-commit）来更新README。为此，请将 .pre-commit-config.yaml 添加到您的项目中。

[tool.cli_base]
version_module_name = "<your_package>" # Must provide the `__version__` attribute

将 .pre-commit-config.yaml 复制并粘贴到您的项目中。

将 pre-commit 添加到您的需求中，并通过以下方式安装git钩子

.venv/bin/pre-commit install
.venv/bin/pre-commit autoupdate

更新pre-commit钩子

在 .pre-commit-config.yaml 中更新版本并发布。

问题：如果“新”版本尚未标记，钩子会损坏。要创建发布，可以使用带有 --no-verify 的所有git命令（提交、推送等）以跳过钩子。

暂时卸载钩子、创建发布并再次安装钩子会更简单，例如

.../cli-base-utilities$ .venv/bin/pre-commit uninstall
# ...bump version, commit, push, merge... create release...
.../cli-base-utilities$ .venv/bin/pre-commit install

历史记录

• v0.13.1
  • 2024-09-26 - 修复缺少click的问题。为向后兼容性添加它
• v0.13.0
  • 2024-09-26 - 添加tyro辅助工具并用自己的CLI替换click
• v0.12.0
  • 2024-09-25 - 在update_readme_history调用中添加调试日志
  • 2024-09-25 - 将AssertCliHelpInReadme简化为扁平函数
  • 2024-09-25 - 应用项目管理工作更新
  • 2024-09-25 - 更新要求
• v0.11.0
  • 2024-08-30 - 应用manageprojects更新，例如：将最小Python版本设置为3.11+
  • 2024-08-30 - 新增：EncloseRuleContext