From f6e83e50a6a47c8bdecdcbd4c4c60ddb97e3b9e6 Mon Sep 17 00:00:00 2001 From: Suniti13 <44272790+Suniti13@users.noreply.github.com> Date: Mon, 14 Oct 2019 16:54:46 +0530 Subject: [PATCH 1/2] Added documentation about how to disable keyring --- docs/html/user_guide.rst | 21 +++++++++++++++++++++ news/6773.doc | 1 + 2 files changed, 22 insertions(+) create mode 100644 news/6773.doc diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 3195a4011ba..8e2986f56e6 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -843,3 +843,24 @@ of ability. Some examples that you could consider include: interacting with PyPI). .. _freeze: https://pip.pypa.io/en/latest/reference/pip_freeze/ + +.. _`Disable Keyring`: + +Disable Keyring +*************** + +Keyring in certain cases can prevent the installing of certain packages and modules +due to authentication errors. In such cases disabling the keyring is recommended. +Keyring can be manually uninstalled but doing so may invalidate other packages that +depends on Keyring. + +There are various ways to disable the keyring. They are: + +- Set the password as null to preferred keyring for the relevant URL and username. + +- keyring >= 15.1.0 can be disabled via command line using:: + + keyring --disable + +- Set environment variable ``PYTHON_KEYRING_BACKEND`` to + ``keyring.backends.null.Keyring`` in a configuration file. diff --git a/news/6773.doc b/news/6773.doc new file mode 100644 index 00000000000..d7b5cdeedb6 --- /dev/null +++ b/news/6773.doc @@ -0,0 +1 @@ +Added documentation on how to disable keyring From 02bdc8cce02f60ccc24be185fcbe14654def5ea4 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Sat, 11 Apr 2020 02:01:33 +0530 Subject: [PATCH 2/2] Reword and rewrap section --- docs/html/user_guide.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 8e2986f56e6..d07b318c7a4 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -847,14 +847,14 @@ of ability. Some examples that you could consider include: .. _`Disable Keyring`: Disable Keyring -*************** +=============== -Keyring in certain cases can prevent the installing of certain packages and modules -due to authentication errors. In such cases disabling the keyring is recommended. -Keyring can be manually uninstalled but doing so may invalidate other packages that -depends on Keyring. +In certain cases, pip's keyring support can prevent the installing of certain +packages and modules, due to authentication errors. In such cases, disabling +the keyring is recommended. This can be done by manually uninstalling keyring, +however doing so may invalidate other packages that depends on keyring. -There are various ways to disable the keyring. They are: +There are other ways to disable the keyring. They are: - Set the password as null to preferred keyring for the relevant URL and username.