Skip to content

Add documentation on how to disable keyring #8019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============

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 other 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.
1 change: 1 addition & 0 deletions news/6773.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added documentation on how to disable keyring