Skip to content
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

Document keyring support for index basic-auth #8636

Merged
merged 2 commits into from
Aug 8, 2020
Merged
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
16 changes: 16 additions & 0 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,22 @@ as the "username" and do not provide a password, for example -
``https://0123456789abcdef@pypi.company.com``


Keyring Support
---------------

pip also supports credentials stored in your keyring using the `keyring`_
library. Note that ``keyring`` will need to be installed separately, as pip
does not come with it included.

.. code-block:: shell

pip install keyring
echo your-password | keyring set pypi.company.com your-username
pip install your-package --extra-index-url https://pypi.company.com/

.. _keyring: https://pypi.org/project/keyring/


Using a Proxy Server
====================

Expand Down
1 change: 1 addition & 0 deletions news/8636.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add note and example on keyring support for index basic-auth