【初心者向け】Pythonで作成したライブラリをPyPIに登録する方法

はじめに

ブログの自動投稿に興味があったのだが、Pythonには使い勝手のいいライブラリがなかったので自作した。せっかくならpip install hogehogeてやりたいのでその方法についてまとめてみた。

環境

• Mac OS Big Sur 11.1
• Python 3.8.2
• pip 20.3.3
• Pipenv 2020.11.15
• twine 3.3.0

忙しい人向け

PyPIってところに登録するといいよ！
アップロードにはtwineを使ってね！

手順

以下はPipenvを使用時のコマンドになりますが参考を見るなりして適宜置き換えてください。

0. 前提

• PyPI、Test PyPIでアカウントを作成していること。
• LICENSE、README.md、setup.pyなどを準備していること。もしまだであればこちらを参考に作成してください。

1. twineのインストール

PyPIへのアップロードはtwineを使用するため予めインストールしておきます。

pipenv install --dev twine

2. 登録ファイルの作成

以下を実行するとdist/以下に.whlと.tar.gzが作成されます。

python setup.py sdist bdist_wheel

3. Test PyPIへアップロード

本番のPyPIへアップロードする前にTest環境のPyPIが使用できます。
絶対に使わなければいけないってことはないですが、慣れないうちは使用する方がいいでしょう。

python -m twine upload --repository testpypi dist/*

これでTest PyPIへのアップロードが完了しました。
せっかくなのでTest PyPIからインストールを行なってみましょう。

pipenv install --pypi-mirror https://test.pypi.org/simple/ <PACKAGE_NAME>

4. PyPIへアップロード

Test PyPIへアップロードしたライブラリの動作確認ができたら最後は本番のPyPIに登録しましょう。誰かに審査されるわけではないのでお気軽にどうぞ。

python -m twine upload dist/*

これで本番のPyPIへアップロードが完了しました。
最後に例のやつを試して終了です。お疲れさまでした。

pipenv install <PACKAGE_NAME>

参考

Packaging Python Projects