Skip to content

Commit

Permalink
added short description for keyring support in readme
Browse files Browse the repository at this point in the history
Signed-off-by: Oleg Höfling <[email protected]>
  • Loading branch information
hoefling committed May 23, 2019
1 parent 851494b commit 4347692
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ devpi-client-extensions

Some useful stuff around `devpi client`_. Although this package is proudly named *extensions*,
currently there is only one thing implemented ready to be used: a hook that uses passwords from
``.pypirc`` on login to devpi server so you don't have to enter your password if you store it for upload anyway.
``.pypirc`` or `keyring`_ on login to devpi server so you don't have to enter your password
if you store it for upload anyway.

Install
-------
Expand All @@ -23,6 +24,24 @@ Just use the ``devpi login`` command as usual:
Using hoefling credentials from .pypirc
logged in 'hoefling', credentials valid for 10.00 hours
Keyring Support
---------------

Since version 0.3, reading credentials using `keyring`_ is supported. Install the package with `keyring` extras:

.. code-block:: sh
$ pip install devpi-client-extensions[keyring]
Example with storing the password in keyring:

.. code-block:: sh
$ keyring set https://my.devpi.url/ hoefling
$ devpi login hoefling
Using hoefling credentials from keyring
logged in 'hoefling', credentials valid for 10.00 hours
Stats
-----

Expand Down Expand Up @@ -55,4 +74,6 @@ Stats
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black

.. _devpi client: https://github.com/devpi/devpi
.. _devpi client: https://pypi.org/project/devpi-client/

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

0 comments on commit 4347692

Please sign in to comment.