この記事では、簡単な Python パッケージを PyPI に公開する方法を解説します。

PyPI とは

PyPI とは、Python Package Index の略で、Python のパッケージを公開するためのリポジトリです。
Python で書かれたソフトウェアとライブラリを公開、共有するための中央リポジトリとしての役割を果たしています。

仕組み

パッケージの公開: 開発者は自分が作成した Python パッケージを PyPI にアップロードします。
パッケージの検索とダウンロード: `pip`` はこの PyPI からパッケージを検索し、ダウンロードしてインストールします。

1. PyPI のアカウントを作成する

PyPI のアカウント作成ページにアクセスし、アカウントを作成します。
二要素認証（2FA）を有効にします。PyPI のアカウント設定ページにアクセスし、Add 2FA with authentication application から 2FA を有効にします。
同じページで API トークンを作成します。API トークンの項目で API トークンの追加 をクリックし、トークンを作成します。
.pypirc というファイルをホームディレクトリに作成します。以下のように記述します。
.pypirc
```
[pypi]
username = __token__
password = <3 で作成した API トークン>
```

2. パッケージを作成する

ここではランダムな「コンプリメント」（褒め言葉）を生成するパッケージを作成してみます。
まずディレクトリを作成します。

mkdir compliment_generator
cd compliment_generator

次に、プロジェクトディレクトリ内に compliment_generator.py という Python ファイルを作成します。

compliment_generator.py

import random

def generate_compliment():
    compliments = [
        "You look great today!",
        "You're a smart cookie!",
        "I like your style!",
        "You're the bee's knees!"
    ]
    return random.choice(compliments)

次に setup.py というファイルを作成します。

setup.py

from setuptools import setup

setup(
    name='compliment_generator',
    version='0.1',
    py_modules=['compliment_generator'],
    install_requires=[],
)

3. パッケージのビルド

setup.py が存在するディレクトリで以下のコマンドを実行します。

python setup.py sdist bdist_wheel

4. パッケージを PyPI にアップロードする

twine というパッケージをインストールします。

pip install twine

twine を使って PyPI にアップロードします。

twine upload dist/*

最後に使ってみる

インストール

$ pip install compliment-generator
  Downloading compliment_generator-0.1-py3-none-any.whl (1.4 kB)
Successfully installed compliment-generator-0.1

実行

$ python
Python 3.7.3 (default, Apr 24 2019, 15:29:51) [MSC v.1915 64 bit (AMD64)] :: Anaconda, Inc. on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import compliment_generator
>>> compliment_generator.generate_compliment()
'I like your style!'
>>> compliment_generator.generate_compliment()
"You're the bee's knees!"

以下のページから今回作成したプロジェクトを確認できます。
https://pypi.org/project/compliment-generator/