Merge pull request #8636 from EpicWink/doc/keyring

Document keyring support for index basic-auth
pypa · Aug 8, 2020 · 2e4d748 · 2e4d748
2 parents e8f5219 + bac3c8e
commit 2e4d748
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst
@@ -79,6 +79,22 @@ as the "username" and do not provide a password, for example -
 ``https://0123456789abcdef@pypi.company.com``
 
 
+Keyring Support
+---------------
+
+pip also supports credentials stored in your keyring using the `keyring`_
+library. Note that ``keyring`` will need to be installed separately, as pip
+does not come with it included.
+
+.. code-block:: shell
+
+   pip install keyring
+   echo your-password | keyring set pypi.company.com your-username
+   pip install your-package --extra-index-url https://pypi.company.com/
+
+.. _keyring: https://pypi.org/project/keyring/
+
+
 Using a Proxy Server
 ====================
 

diff --git a/news/8636.doc b/news/8636.doc
@@ -0,0 +1 @@
+Add note and example on keyring support for index basic-auth