PythonのパッケージをGitHubリポジトリからインストールする方法について解説します。この記事は、Pythonの開発者や、GitHubリポジトリを利用している方、またはpipによる配布パッケージの配布にこれから取り組みたい方を対象としています。
GitHubリポジトリからpipでインストールする方法
GitHubのPublicリポジトリに配置された配布パッケージから、pipコマンドでインストールするために必要な情報は次の通りです。
- gitリポジトリのURL
pipコマンドに対して、次のようにgitリポジトリのURLを指定して実行します。
pip install git+https://[gitリポジトリのURL]
ここでgitリポジトリのURLは、GitHubリポジトリのClone用のURLを指定します。
GitHubリポジトリに配布パッケージを配置する方法
配布パッケージを作成するために構成したファイル・フォルダー構造を、そのままGitHubリポジトリに格納します。具体的には、リポジトリのルートに setup.py もしくは pyproject.toml ファイルがある状態を意図します。
リポジトリをPublic状態で公開すれば、配布のための準備は完了です。
注意点
この方式でのpipコマンド実行時の内部的な動きは、「リポジトリをgit cloneし、その後にcloneしたリポジトリからパッケージをインストールする」という流れなので、配布パッケージのファイル作成（ *.whl ）をする必要がありません。必要なのは「配布パッケージのファイル作成ができる状態のファイル・フォルダー構成」となります。
以上、GitHubリポジトリからPythonパッケージをインストールする方法について解説しました。この方法を利用すれば、PyPIに公開するほどではないが、インターネットを通じてある程度広く配布パッケージを公開したい場合に便利です。.