Skip to content

docs: clarify what the system argument is in keyring usage #755

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.

Sign up for GitHub

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

Open
SAY-5 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

docs: clarify what the system argument is in keyring usage #755

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@ The basic usage of keyring is pretty simple: just call
>>> keyring.get_password("system", "username")
'password'

The ``system`` argument is any string that identifies the context for the
credential. It might be a hostname (``"example.com"``), a URL
(``"https://the.web.site/"``), the name of a service (``"PyPI"``,
``"GitHub"``), or any other label that makes the credential easy to look
up later. The ``username`` argument is the account name within that
context.

Command-line Utility
--------------------

Expand Down