Added documentation on adding specific keyrings.

This commit is contained in:
facetoe 2015-02-22 10:06:44 +08:00
parent cb8f4225bd
commit d61925ab54

View File

@ -129,6 +129,16 @@ is done you can add the module to your config without specifying the credentials
::
# Use the default keyring to retrieve credentials. To determine which backend is the default on your system, run
# python -c 'import keyring; print(keyring.get_keyring())'
status.register('github')
If you don't want to use the default you can set a specific keyring like so:
::
from keyring.backends.file import PlaintextKeyring
status.register('github', keyring_backend=PlaintextKeyring())
i3pystatus will locate and set the credentials during the module loading process. Currently supported credentals are "password", "email" and "username".