Skip to content

Commit fc747ca

Browse files
authored
Merge pull request #11592 from judahrand/keyring-cli
2 parents b5be1da + 89a4a35 commit fc747ca

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/html/topics/authentication.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,21 @@ man pages][netrc-docs].
6868
pip supports loading credentials stored in your keyring using the
6969
{pypi}`keyring` library.
7070

71+
pip will first try to use `keyring` in the same environment as itself and
72+
fallback to using any `keyring` installation which is available on `PATH`.
73+
74+
Therefore, either of the following setups will work:
75+
76+
```bash
77+
$ pip install keyring # install keyring from PyPI into same environment as pip
78+
$ echo "your-password" | keyring set pypi.company.com your-username
79+
$ pip install your-package --index-url https://pypi.company.com/
80+
```
81+
82+
or
83+
7184
```bash
72-
$ pip install keyring # install keyring from PyPI
85+
$ pipx install keyring # install keyring from PyPI into standalone environment
7386
$ echo "your-password" | keyring set pypi.company.com your-username
7487
$ pip install your-package --index-url https://pypi.company.com/
7588
```
@@ -79,5 +92,4 @@ pip. This can create a bootstrapping issue if you need the credentials stored in
7992
the keyring to download and install keyring.
8093

8194
It is, thus, expected that users that wish to use pip's keyring support have
82-
some mechanism for downloading and installing {pypi}`keyring` in their Python
83-
environment.
95+
some mechanism for downloading and installing {pypi}`keyring`.

0 commit comments

Comments
 (0)