template package cli

概要

これは、新しいPython CLIベースのツールを作成するときに内部で使用するパッケージテンプレートです。新しいパッケージをPYPIに作成、構築、公開するために必要なすべての基本的な機能とワークフローがあります。

このパッケージは、事前定義された引数と構成のセットを使用して、さまざまなタスクを処理および処理するためのコマンドラインユーティリティを提供します。このプロジェクトは、同様のコマンドラインアプリケーションを開発するためのベースラインとして機能することを目的としています。

これには、引数解析、構成管理、スケーラブルで保守可能なコード開発を促進するモジュラー構造などの機能が含まれます。

また、使用する他の2つのテンプレートも提供しています。

• テンプレート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 ：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 ：現在読んでいるファイル。