Skip to content

Commit

Permalink
Remove section about non-existing --force-keyring flag (#12455)
Browse files Browse the repository at this point in the history
I must have messed up while merging/rebasing at some point...
  • Loading branch information
Darsstar authored Dec 28, 2024
1 parent c10dda5 commit dd6c4ad
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 19 deletions.
19 changes: 0 additions & 19 deletions docs/html/topics/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,25 +163,6 @@ from the subprocess in which they run Pip. You won't know whether the keyring
backend is waiting the user input or not in such situations.
```

pip is conservative and does not query keyring at all when `--no-input` is used
because the keyring might require user interaction such as prompting the user
on the console. You can force keyring usage by passing `--force-keyring` or one
of the following:

```bash
# possibly with --user, --global or --site
$ pip config set global.force-keyring true
# or
$ export PIP_FORCE_KEYRING=1
```

```{warning}
Be careful when doing this since it could cause tools such as pipx and Pipenv
to appear to hang. They show their own progress indicator while hiding output
from the subprocess in which they run Pip. You won't know whether the keyring
backend is waiting the user input or not in such situations.
```

Note that `keyring` (the Python package) needs to be installed separately from
pip. This can create a bootstrapping issue if you need the credentials stored in
the keyring to download and install keyring.
Expand Down
1 change: 1 addition & 0 deletions news/12455.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed section about non-existing ``--force-keyring`` flag.

0 comments on commit dd6c4ad

Please sign in to comment.