File: README.md

package info (click to toggle)
keyring-pass 0.9.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 152 kB
  • sloc: python: 186; sh: 33; makefile: 2
file content (36 lines) | stat: -rw-r--r-- 1,075 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# keyring_pass

This is a [`pass`](https://www.passwordstore.org/) backend for [`keyring`](https://pypi.org/project/keyring/)

Install with `pip install keyring-pass` and set the following content in
your [`keyringrc.cfg`](https://pypi.org/project/keyring/#config-file-path) file:

```ini
[backend]
default-keyring = keyring_pass.PasswordStoreBackend
```

You can modify the default `python-keyring` prefix for `pass`, by:

- adding following to `keyringrc.cfg`:

    ```ini
    [pass]
    key-prefix=alternative/prefix/path
    binary=gopass
    ```

- (for `keyring` version 23.0.0 or higher) setting environment variables:
    - `KEYRING_PROPERTY_PASS_KEY_PREFIX`
    - `KEYRING_PROPERTY_PASS_BINARY`

- You can clear the path (start from root), by setting above to `.` or an empty value (just `key-prefix=` on the line).

## Test your setup

You can check if your setup works end-to-end (creates, reads and deletes a key from password store).

```shell
# warning: this will create and delete a key at `<prefix>/test/asd` in your password store
python -m keyring_pass
```