summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJudah Rand <17158624+judahrand@users.noreply.github.com>2022-11-11 21:44:35 +0000
committerJudah Rand <17158624+judahrand@users.noreply.github.com>2022-11-11 21:44:35 +0000
commit89a4a35a3381cc324aa818392c19631654cae495 (patch)
tree16f3c66c224631e610f8fd7f1d848628a03fcee9 /docs
parent623ac5d77dec4c9e4e8d99582bad913c1b0f0b6f (diff)
downloadpip-89a4a35a3381cc324aa818392c19631654cae495.tar.gz
Add documentation on functionality in #11589
Diffstat (limited to 'docs')
-rw-r--r--docs/html/topics/authentication.md18
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`.