レポジトリ

PyPIレポジトリの使用

デフォルトでは、Poetryはパッケージのインストールと公開に PyPI レポジトリを使うよう設定されます。

そのため、プロジェクトに依存関係を追加すると、PoetryはそれがPyPIで利用可能だと仮定します。

これはほとんどの場合に当たり、ほとんどのユーザーにとって十分なようです。

プライベートレポジトリの使用

しかし、あるときは、チームメイトには共有可能にしつつ、パッケージを非公開のままにする必要があるかもしれません。 その場合、プライベートレポジトリを使う必要があります。

レポジトリの追加

レポジトリの追加は config コマンドを使うと簡単です。

poetry config repositories.foo https://foo.bar/simple/

このコマンドは、レポジトリ foo のURLを https://foo.bar/simple/ に設定します。

認証情報の設定

もし特定のレポジトリの認証情報を保存したいなら、次のように簡単にできます:

poetry config http-basic.foo username password

パスワードを指定しなかった場合は、パスワードを書くように促されます。

注意

PyPIへ公開するために、 pypi という名前のレポジトリの認証情報を設定できます。

パッケージをPyPIにアップロードするときには、API tokensを使うのが 推奨されていることに注意してください。 新しくトークンを作っておけば、Poetryにそれを使わせられます:

poetry config pypi-token.pypi my-token

ここでも自分のユーザー名とパスワードを使いたい場合、 次の config の呼び出し方でできます。

poetry config http-basic.pypi username password

publish コマンドを使うときに --username オプションと --password オプションを付けて、ユーザー名とパスワードを指定することもできます。

システムのキーリングが利用可能でサポートされている場合、パスワードはキーリングに格納されたり、キーリングから取得されたりします。認証情報は poetry-repository-pypi という名前で格納されます。キーリングへのアクセスに失敗したりサポートされていない場合、パスワードはユーザー名と一緒に auth.toml ファイルに書き込まれます。

キーリングのサポートは keyringライブラリ を使って有効にします。サポートされる環境基盤についてより詳しいことは ライブラリドキュメント を参照してください。

あるいは、環境変数を使って認証情報を提供できます:

export POETRY_PYPI_TOKEN_PYPI=my-token
export POETRY_HTTP_BASIC_PYPI_USERNAME=username
export POETRY_HTTP_BASIC_PYPI_PASSWORD=password

環境変数でPoetryを設定する方法についてより詳しいことは、環境変数の使用を参照してください。

カスタム認証局と相互TLS認証

Poetryは、証明書ベースのクライアント認証を必要とするレポジトリだけでなくカスタムの認証局によって保護されているレポジトリもサポートしています。次のコマンドは、"foo" レポジトリの設定をして、カスタム認証局を使いそのレポジトリの証明書を検証する、それと、クライアント認証を使えるようにする、というものです（これらの設定変数は必ずしも両方とも設定する必要が無いことに注意してください）:

    poetry config certificates.foo.cert /path/to/ca.pem
    poetry config certificates.foo.client-cert /path/to/client.pem

プライベートレポジトリからの依存関係インストール

プライベートレポジトリへの公開ができようになったので、そこから依存関係をインストールできるようにする必要があります。

そのためには、 pyproject.toml ファイルを次のように編集する必要があります

[[tool.poetry.source]]
name = "foo"
url = "https://foo.bar/simple/"

今後は、Poetryはプライベートレポジトリのパッケージも検索します。

注意

どんな独自レポジトリもPyPIより優先されます。

PyPIを第一のパッケージ取得元としておきたい場合は、
独自レポジトリを第二のレポジトリと宣言できます。

```toml
[[tool.poetry.source]]
name = "foo"
url = "https://foo.bar/simple/"
secondary = true
```

プライベートレポジトリがHTTP Basic認証を要求する場合、上の例を使って、忘れずにユーザー名とパスワードを http-basic 設定に追加してください (tool.poetry.source セクションにある名前と同じものを使うことも忘れないでください)。 レポジトリにカスタムの認証局かクライアント証明書が必要な場合も同様に上の例を参照して certificates セクションを設定してください。 Poetryは、パッケージのダウンロードや検索をするときに、これらの値をプライベートレポジトリに対する認証に使います。

PyPIレポジトリの無効化

パッケージがプライベートレポジトリからのみ探されて欲しい場合は、default キーワードを使ってデフォルトであることが設定できます。

[[tool.poetry.source]]
name = "foo"
url = "https://foo.bar/simple/"
default = true

デフォルトの取得元は、他の取得元を追加した場合のフォールバック先になります。