pipインストールがgithubから機能するように構成する

githubでpipを使用して、プライベートパッケージを本番サーバーにインストールします。この質問は、インストールを成功させるためにgithubリポジトリに何が必要かに関するものです。

次のコマンドラインを想定します（これは問題なく認証され、インストールを試みます）。

pip install git+ssh://git@github.com/BlahCo/search/tree/prod_release_branch/ProductName

ProductNameには何が必要ですか？これは、sdistオプションを使用してsetup.pyを実行した後、通常はtarファイルに含まれる内容ですか、それとも実際のtar.gzファイルですか、それとも何か他のものですか？

いくつかのバリエーションを試してみましたが、機能させることができないので、ここで質問します。助けてくれてありがとう。

setup.pyファイルが入ったpythonパッケージ全体が必要です。

名前の付いたパッケージfooは次のようになります。

foo # the installable package
├── foo
│   ├── __init__.py
│   └── bar.py
└── setup.py

そしてgithubから次のようにインストールします：

$ pip install git+https://github.com/myuser/foo.git@v123
or
$ pip install git+https://github.com/myuser/foo.git@newbranch

詳しくはhttps://pip.pypa.io/en/stable/reference/pip_install/#vcs-supportをご覧ください

githubリポジトリからインストールしなければならないときに同様の問題がありましたが、gitなどをインストールしたくありませんでした。

それを行う簡単な方法は、パッケージのzipアーカイブを使用することです。/zipball/masterリポジトリURLに追加：

    $ pip install https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
Downloading/unpacking https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
  Downloading master
  Running setup.py egg_info for package from https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
Installing collected packages: django-debug-toolbar-mongo
  Running setup.py install for django-debug-toolbar-mongo
Successfully installed django-debug-toolbar-mongo
Cleaning up...

このようにして、githubソースリポジトリでpipを機能させます。

requirements.txtfile を使用する場合はgit、以下のエントリのように、マスターブランチを匿名でフェッチする必要がありますrequirements.txt。

通常のインストールの場合：

git+git://github.com/celery/django-celery.git

「編集可能な」インストールの場合：

-e git://github.com/celery/django-celery.git#egg=django-celery

編集可能モードでは、プロジェクトのソースコード./srcが現在のディレクトリにダウンロードされます。pip freezeパッケージの正しいgithubの場所を出力できます。

他のプロジェクトを複製するのと同じ方法で、ターゲットリポジトリを複製します。

git clone git@github.com:myuser/foo.git

次に、開発モードでインストールします。

cd foo
pip install -e .

不要なものは何でも変更でき、fooパッケージを使用するすべてのコードは変更されたコードを使用します。

このソリューションには2つの利点があります。

1. パッケージはホームプロジェクトディレクトリにインストールできます。
2. パッケージには.gitdirが含まれているため、通常のGitリポジトリです。すぐにフォークにプッシュできます。

Colabでこの方法を試すことができます

!git clone https://github.com/UKPLab/sentence-transformers.git
!pip install -e /content/sentence-transformers
import sentence_transformers