From 9eb9319f7e0d5ab564be75ce5fab1f1317228c91 Mon Sep 17 00:00:00 2001 From: Laurie O Date: Mon, 27 Jul 2020 20:59:31 +1000 Subject: [PATCH 1/2] Document keyring support for index basic-auth --- docs/html/user_guide.rst | 15 +++++++++++++++ news/8636.doc | 1 + 2 files changed, 16 insertions(+) create mode 100644 news/8636.doc diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index f2e49fadf64..78a57d32aca 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -79,6 +79,21 @@ 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. + +.. 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 From bac3c8eb9ac9dc7d2454ee3e2f6695d5812babf7 Mon Sep 17 00:00:00 2001 From: Laurie O Date: Tue, 28 Jul 2020 10:42:01 +1000 Subject: [PATCH 2/2] Explicitly note that pip does not vendor keyring --- docs/html/user_guide.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 78a57d32aca..b021cb6dcf0 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -83,7 +83,8 @@ Keyring Support --------------- pip also supports credentials stored in your keyring using the `keyring`_ -library. +library. Note that ``keyring`` will need to be installed separately, as pip +does not come with it included. .. code-block:: shell