Add instructions on disabling keyring #7200
Conversation
Added documentation about how to disable keyring. Refered pypa/twine#338 for it.
Small edit because of whitespaces
Added NEWS entry for the issue pypa#6773. Added documentation on how to 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 was a problem hiding this comment.
| depends on Keyring. | |
| depend on Keyring. |
There was a problem hiding this comment.
Thanks for making this PR, I have been working through some keyring related issues today and I was wondering whether it is discussed at all in the documentation so it is good to see it being added! I am not a maintainer on this project but I made some suggestions anyway, feel free to consult with someone who can hit the merge button if you have any hesitations. Thanks again for your contribution!
| Disable Keyring | ||
| *************** | ||
|
|
||
| Keyring in certain cases can prevent the installing of certain packages and modules |
There was a problem hiding this comment.
Perhaps we can indicate how a user could recognize if they are impacted by this issue? The language here is a bit vague, perhaps there are some example warnings (maybe they are ResourceWarnings or Exceptions that would indicate if keyring is causing this problem).
There was a problem hiding this comment.
By default you don't get any output unfortunately. If you increase the verbosity you are going to read something like Getting credentials from keyring for https://pypi.org/simple before it get stuck
| Disable Keyring | ||
| *************** | ||
|
|
||
| Keyring in certain cases can prevent the installing of certain packages and modules |
There was a problem hiding this comment.
Also I don't think keyring is mentioned anywhere else in the user guide, maybe before talking about how to turn it off, you could mention that pip doesn't come with keyring but it may try to use it if the user has it installed.
| 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 was a problem hiding this comment.
| depends on Keyring. | |
| depends on keyring. |
|
@Suniti13 Hi! It would be great if you could respond to the review comments people have left. Once you resolve those suggestions, the maintainers can merge your improvements into the master branch, and once the new documentation is deployed, users can enjoy your improvements! |
|
Hello! I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the |
Added documentation about how to disable keyring. Refered pypa/twine#338 for it.
Fixes #6773.