【2025年版】自作のPythonライブラリを `pip install` できるようにする
目次
Pythonプログラムを pip install できるようにする方法をリポジトリにまとめた。
Sponsored by Google AdSense
Github テンプレートレポジトリ
以下のリポジトリをテンプレートにして、 python-template と python_template をライブラリ名に置換すればよい。
複数のビルド方法に対応するため、 packages 下に setupに必要なファイルを作成した。 1つのビルド方法であれば、LICENSE, README.md, pyproject.tomlをルートディレクトリに置くほうが簡単。
ビルドする方法
pip install "packages/setuptools/standard/[dev]"
python -m build packages/setuptools/standard/
インストール方法
ローカルにファイルがあるとき
# 開発者向け
pip install -e packages/setuptools/standard/
# 本番
pip install packages/setuptools/standard/
githubから直接インストールする
pip install git+https://github.com/yu9824/python-template.git#subdirectory=packages/setuptools/standard
# バージョン指定したいとき
pip install git+https://github.com/yu9824/[email protected]#subdirectory=packages/setuptools/standard
PyPIにアップロードする
tag をつけてpushすれば Github actions でアップロードできるようにできるが、いくつか準備が必要。
手動でやる方法は 過去の方法 を参考。
pypi.org, test.pypi.org にアカウントを作成
別途、pypi.org (本番環境), test.pypi.org (テスト環境) へアカウントを作成する。
ライブラリの作成
先にライブラリを作成して、「プロジェクトの管理」＞「Publishing」＞「Add a new publisher」 からGithubリポジトリを追加する。
- オーナー: Githubアカウント名
- Repository name: リポジトリ名
- Workflow name: release-pypi.yml
- Environment name: pypi
ワークフローを修正
.github/workflows/release-pypi.yml の trigger 部分の push/tag を アンコメントする。
tagをつけて、push
git tag v0.1.0
git push origin main --tags
