python-packaging

Python パッケージング

pyproject.toml、uv、配布のベストプラクティスを活用した、モダンな Python パッケージングです。

クイックスタート

# Create new project with uv
uv init my-package
cd my-package

# Add dependencies
uv add requests click

# Build package
uv build

# Publish to PyPI
uv publish

確認方法： --help フラグを指定してコマンドを実行し、利用可能であることを確認します。

使用する場面

• 配布可能な Python ライブラリを作成する
• CLI ツールを構築する
• PyPI に公開する
• 開発環境をセットアップする
• プロジェクトの依存関係を管理する

使用しない場面

• パッケージのテストには python-testing を使用してください 代わりに
• パッケージのパフォーマンス最適化には python-performance を使用してください
• パッケージのテストには python-testing を使用してください 代わりに
• パッケージのパフォーマンス最適化には python-performance を使用してください

主な選択事項

1. レイアウトの選択

# Source layout (recommended)
src/my_package/
    __init__.py
    module.py

# Flat layout (simple)
my_package/
    __init__.py
    module.py

確認方法： --help フラグを指定してコマンドを実行し、利用可能であることを確認します。

ソースレイアウトの利点：

• ソースとテストを明確に分離できます
• インストールされていないコードを誤ってインポートするのを防げます
• 複雑な構成のパッケージに適しています

2. プロジェクト構成

最小限のプロジェクト：

**Verification:** Run `pytest -v` to verify tests pass.
my-project/
├── pyproject.toml
├── README.md
├── src/
│   └── my_package/
│       └── __init__.py
└── tests/
    └── test_init.py

確認方法： pytest -v を実行して、テストが成功することを確認します。

完全なプロジェクト：

**Verification:** Run the command with `--help` flag to verify availability.
my-project/
├── pyproject.toml
├── README.md
├── LICENSE
├── .gitignore
├── src/
│   └── my_package/
│       ├── __init__.py
│       ├── cli.py
│       ├── core.py
│       └── utils.py
├── tests/
│   ├── conftest.py
│   └── test_core.py
└── docs/
    └── index.md

確認方法： pytest -v を実行して、テストが成功することを確認します。

詳細なトピック

詳しい情報は各モジュールを参照してください。

• uv のワークフロー - uv コマンドとトラブルシューティングの詳細
• pyproject.toml のパターン - パッケージの種類ごとの設定例
• エントリーポイント - コンソールスクリプト、GUI スクリプト、プラグイン
• CI/CD の統合 - GitHub Actions と自動公開

ベストプラクティス

1. シンプルなパッケージ以外では、ソースレイアウトを使用する
2. 直接依存関係には最低バージョンを指定する
3. 開発／ドキュメント／テスト用にオプションの依存関係グループを使用する
4. 型ヒントをサポートするために py.typed を含める
5. 使用例を含む詳細な README を追加する
6. セマンティックバージョニング（MAJOR.MINOR.PATCH）を使用する
7. 公開前に複数の Python バージョンでテストする

完了条件

• モダンな pyproject.toml 設定
• 明確な依存関係の指定
• 適切なバージョン管理
• テストが含まれ、成功している
• 再現可能なビルドプロセス
• 公開パイプラインが自動化されている