From d61925ab5400cdf1d455b5545d3f176a6419f4ef Mon Sep 17 00:00:00 2001 From: facetoe Date: Sun, 22 Feb 2015 10:06:44 +0800 Subject: [PATCH] Added documentation on adding specific keyrings. --- docs/configuration.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/configuration.rst b/docs/configuration.rst index abd4cab..be4bcf4 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -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". \ No newline at end of file