diff options
author | Pradyun Gedam <pradyunsg@gmail.com> | 2023-01-28 22:45:49 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-28 22:45:49 +0000 |
commit | fc747ca912c53d9a55b5c4ecdbc58416f1f61459 (patch) | |
tree | 77db0cd1c9ac8118fe2f45d5263503d2ecb55e6f /docs | |
parent | b5be1da91875f9a96d7d87a11991f6e7097f49a8 (diff) | |
parent | 89a4a35a3381cc324aa818392c19631654cae495 (diff) | |
download | pip-fc747ca912c53d9a55b5c4ecdbc58416f1f61459.tar.gz |
Merge pull request #11592 from judahrand/keyring-cli
Diffstat (limited to 'docs')
-rw-r--r-- | docs/html/topics/authentication.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/html/topics/authentication.md b/docs/html/topics/authentication.md index 981aab5ab..f5b553160 100644 --- a/docs/html/topics/authentication.md +++ b/docs/html/topics/authentication.md @@ -68,8 +68,21 @@ man pages][netrc-docs]. pip supports loading credentials stored in your keyring using the {pypi}`keyring` library. +pip will first try to use `keyring` in the same environment as itself and +fallback to using any `keyring` installation which is available on `PATH`. + +Therefore, either of the following setups will work: + +```bash +$ pip install keyring # install keyring from PyPI into same environment as pip +$ echo "your-password" | keyring set pypi.company.com your-username +$ pip install your-package --index-url https://pypi.company.com/ +``` + +or + ```bash -$ pip install keyring # install keyring from PyPI +$ pipx install keyring # install keyring from PyPI into standalone environment $ echo "your-password" | keyring set pypi.company.com your-username $ pip install your-package --index-url https://pypi.company.com/ ``` @@ -79,5 +92,4 @@ pip. This can create a bootstrapping issue if you need the credentials stored in the keyring to download and install keyring. It is, thus, expected that users that wish to use pip's keyring support have -some mechanism for downloading and installing {pypi}`keyring` in their Python -environment. +some mechanism for downloading and installing {pypi}`keyring`. |