diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index f2e49fadf64..b021cb6dcf0 100644 --- 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 new file mode 100644 index 00000000000..081cf1c7eb0 --- /dev/null +++ b/news/8636.doc @@ -0,0 +1 @@ +Add note and example on keyring support for index basic-auth