template package importable

概要

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

このパッケージテンプレートは、CLI機能を提供するものではなく、代わりにインポート可能なパッケージを作成するために設計されています。

私たちは、これを他のツールとともに利用できるようにして、人々が独自のツールを作成するときに、適切に設計された出発点を使用できるようにすることにしました。

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

• テンプレートPythonプロジェクト
• テンプレートパッケージCLI

特徴

• モジュラーアーキテクチャ：メンテナンス性を向上させるために、コードをモジュールに整理します。
• カスタム例外：特定のエラー処理のためにカスタム例外を実装するための基本的な例。
• テスト例：パッケージのpytestテストを作成するための基本的な例。

インストール

インポート可能なパッケージをインストールするには、リポジトリをクローンしてプロジェクトディレクトリに移動します。

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

仮想環境を使用して依存関係を管理することをお勧めします。次のコマンドを使用して、仮想環境を作成およびアクティブ化できます。

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

必要な依存関係をインストールします。

pip install -r requirements.txt

プロジェクト構造

プロジェクトは次のように編成されています。

template-package-importable/
├── wolfsoftware/
│   └── template_package_importable/
│       ├── __init__.py
│       ├── exceptions.py
│       └── functions.py
├── tests/
│   ├── __init__.py
│   └── test_template_package_importable.py
├── README.md
├── setup.py
└── requirements.txt

• wolfsoftware/template_package_importable ：アプリケーションのコアモジュールが含まれています。
  • exceptions.py ：カスタム例外を処理します。
  • functions.py ：いくつかの例関数（テスト用）を定義します。
• tests ：pytestテストが配置されている場所。
  • test_template_package_importable.py ：実行する特定のテスト。
• setup.py ：パッケージ構成。
• requirements.txt ：プロジェクトに必要な依存関係をリストします。
• README.md ：現在読んでいるファイル。