Python パッケージ作成に関する情報まとめ

Python パッケージ作成、PyPI(パイ・ピーアイ) への登録などに役立つ情報を、まとめる。

setup.py だけ使用するパターン、setup.cfg も使用するパターン、__init__.py に多くの役割を持たせるパターン/ほとんど役割を持たせないパターン、などパッケージ作成に関してさまざま選択肢があるので、いろいろな例を見ておくと良い。

関連公式ドキュメント

参考情報

参考になる Python パッケージ(OSS

パッケージのインストールテスト

パッケージを作ったらインストールして試してみる

開発用

$ python3 setup.py develop

# もしくは

$ pip3 install -e .

配布用

# 配布用パッケージの作成
# これで dist/ 以下にパッケージ(tar.gz)ができる
$ python3 setup.py sdist

# 配布用パッケージのインストール
$ pip3 install dist/*

パッケージ情報の確認

$ pip3 show <パッケージ名> 

アンインストール

$ pip3 uninstall <パッケージ名>

PyPI への登録

登録するためのツール twine が入っていないならインストールする。

$ pip3 install twine

登録。

$ twine upload --repository pypi dist/*