Python パッケージを作成して公開する方法

Python パッケージを作成して公開すると、コードをより広範な Python コミュニティと共有できます。このガイドでは、Python パッケージを作成し、他のユーザーが簡単にインストールして使用できるように Python パッケージ インデックス (PyPI) に公開する手順について説明します。

プロジェクトの設定

始める前に、システムに Python がインストールされていることを確認してください。まだインストールしていない場合は、setuptools および wheel パッケージもインストールする必要があります。

pip install setuptools wheel

パッケージ構造の作成

パッケージ プロジェクト用の新しいディレクトリを作成します。このディレクトリ内に、次の構造を作成します。

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

これらのファイルの概要は次のとおりです。

• your_package/__init__.py: ディレクトリを Python パッケージとしてマークします。
• your_package/module1.py および your_package/module2.py: パッケージ モジュール。
• tests/: パッケージのテストケースのディレクトリ。
• setup.py: パッケージのビルド スクリプト。
• README.md: パッケージの機能について説明するファイル。
• LICENSE: パッケージのライセンス ファイル。

セットアップスクリプトの作成

setup.py ファイルは、パッケージのメタデータと依存関係を定義するために不可欠です。以下に基本的な例を示します。

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

README ファイルの作成

README.md ファイルには、インストール方法や使用方法など、パッケージの概要が記載されている必要があります。次に例を示します。

# Your Package

A brief description of your package.

インストール

pip install your_package

使用法

import your_package

# Example usage

パッケージの構築

プロジェクト ディレクトリに移動し、次のコマンドを実行してパッケージをビルドします。

python setup.py sdist bdist_wheel

このコマンドは、dist/ ディレクトリに配布アーカイブを作成します。

PyPIへの公開

パッケージを公開するには、PyPI のアカウントが必要です。アカウントをお持ちでない場合は、PyPI で作成してください。

次に、twine パッケージをインストールします。

pip install twine

twine を使用してパッケージを PyPI にアップロードします。

twine upload dist/*

PyPI のユーザー名とパスワードの入力を求められます。アップロードが成功すると、パッケージが PyPI で利用できるようになります。

結論

おめでとうございます! これで Python パッケージを作成して公開できました。他の人は pip を使用してインストールでき、あなたは引き続き更新して改善することができます。変更を加えたらバージョン番号を更新し、新しいリリースをアップロードしてパッケージを維持することを忘れないでください。