diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index ff500cb34de..0281af52c5e 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -791,3 +791,25 @@ of ability. Some examples that you could consider include: * ``distlib`` - Packaging and distribution utilities (including functions for interacting with PyPI). + + +.. _`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