jaraco / jaraco/keyring

How to use Keyring (unanswered questions)

Open
#706 1 comment 0 reactions 0 assignees View on GitHub
documentation help wanted question
Dominant language
Python
Stars
1.5k
Forks
196
PR merge metrics
No merged PRs in 30d

Description

> 10 years later, almost to the day, and this issue still applies.
>
> From [Using Keyring](https://github.com/jaraco/keyring?tab=readme-ov-file#using-keyring):
>
> ```
> ...
>>> keyring.set_password("system", "username", "password")
> ...
> $ keyring set system username
> ...
> ```
>
> What is `system` ? 🤷🏻‍♂️
>
> How do I use `keyring` in the most basic real-world scenario ? 🤷🏻‍♂️🤷🏻‍♂️
> How do I get / set secrets from / in any of the four recommended keyring backends supported
> (macOS Keychain, Freedesktop Secret Service, KDE Wallet, Windows Credential Locker) ? 🤷🏻‍♂️🤷🏻‍♂️🤷🏻‍♂️
>
> I do remember having looked into `keyring` quite a few times in the last couple of years, but gave up on it quickly each time because I simply didn't understand how to use it. Now I'm somewhat forced to make it work for me because it is the only somewhat reasonable means of authentication for [`uv`](https://github.com/astral-sh/uv) - at least until they've added support for a Rust-based solution.
>
> I'd be happy to contribute documentation, but I can't because I don't know how `keyring` is supposed to work 😞

_Originally posted by @dd-ssc in [#116](https://github.com/jaraco/keyring/issues/116#issuecomment-2668019702)_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README's Using Keyring section and the examples shown there, then investigate how the four recommended backends handle basic secret access. Done means documenting what “system” represents, a basic real-world workflow, and how to get or set secrets for macOS Keychain, Freedesktop Secret Service, KDE Wallet, and Windows Credential Locker.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.