Skip to content

Commit 2e4d748

Browse files
authored
Merge pull request #8636 from EpicWink/doc/keyring
Document keyring support for index basic-auth
2 parents e8f5219 + bac3c8e commit 2e4d748

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/html/user_guide.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,22 @@ as the "username" and do not provide a password, for example -
7979
``https://[email protected]``
8080

8181

82+
Keyring Support
83+
---------------
84+
85+
pip also supports credentials stored in your keyring using the `keyring`_
86+
library. Note that ``keyring`` will need to be installed separately, as pip
87+
does not come with it included.
88+
89+
.. code-block:: shell
90+
91+
pip install keyring
92+
echo your-password | keyring set pypi.company.com your-username
93+
pip install your-package --extra-index-url https://pypi.company.com/
94+
95+
.. _keyring: https://pypi.org/project/keyring/
96+
97+
8298
Using a Proxy Server
8399
====================
84100

news/8636.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add note and example on keyring support for index basic-auth

0 commit comments

Comments
 (0)