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 ：您當前正在讀取的文件。