template package cli

概述

这是我们在创建新的基于Python CLI的工具时内部使用的软件包模板。它具有创建，构建和发布新软件包所需的所有基本功能和工作流程。

该软件包提供了使用一组预定义参数和配置来处理和处理各种任务的命令行实用程序。该项目旨在作为开发类似命令行应用程序的基线。

它包括参数解析，配置管理和模块化结构等功能，以促进可扩展和可维护的代码开发。

我们还提供了我们使用的其他两个模板。

• 模板Python项目
• 模板软件包可导入

特征

• 模块化体系结构：将代码组织到模块中，以更好地可维护性。
• 参数解析：轻松使用argparse处理命令行参数。
• 配置管理：从命令行参数生成配置对象。
• 自定义异常：针对特定错误处理实现自定义异常。

安装

要安装CLI软件包，请克隆存储库并导航到项目目录：

git clone https://github.com/DevelopersToolbox/template-package-cli.git
cd template-package-cli

建议使用虚拟环境来管理依赖关系。您可以使用以下命令创建和激活虚拟环境：

python -m venv venv
source venv/bin/activate  # On Windows, use `venvScriptsactivate`

安装所需的依赖项：

pip install -r requirements.txt

用法

要运行CLI软件包，请从主脚本执行main函数：

python -m wolfsoftware.template_package_cli.main --required < value >

命令行参数

该应用程序支持几个命令行参数：

• -h, --help ：显示帮助消息和退出。
• -d, --debug ：启用详细输出的调试模式。
• -v, --verbose ：启用详细输出以显示扫描结果。
• -V, --version ：显示程序的版本编号和退出。
• -i, --optional-integer ：可选的整数参数（默认值：2）。
• -s, --optional-string ：一个可选的字符串参数（默认值：“ me”）。
• -r, --required ：必需的字符串参数。

示例用法：

python -m wolfsoftware.template_package_cli.main -r " required_value " -i 10 -s " optional_string " 

项目结构

该项目的组织如下：

template-package-cli/
├── wolfsoftware/
│   └── template_package_cli/
│       ├── __init__.py
│       ├── cli.py
│       ├── config.py
│       ├── exceptions.py
│       ├── globals.py
│       └── main.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_cli ：包含应用程序的核心模块。
  • cli.py ：处理命令行参数和主程序流。
  • config.py ：从命令行参数处理配置创建。
  • exceptions.py ：处理自定义异常。
  • globals.py ：定义整个应用程序中使用的全局常数。
  • main.py ：精心策划参数解析和程序执行的主要脚本。
• requirements.txt ：列出项目所需的依赖项。
• README.md ：您当前正在读取的文件。