Module description
This module provides a way for securely storing passwords and other secrets.
It uses D-Bus Secret Service API that is supported by GNOME Keyring, KWallet (since version 5.97) and KeePassXC.
The main classes provided are secretstorage.Item, representing a secret item (that has a label, a secret and some attributes) and secretstorage.Collection, a place items are stored in.
SecretStorage supports most of the functions provided by Secret Service, including creating and deleting items and collections, editing items, locking and unlocking collections.
The documentation can be found on secretstorage.readthedocs.io.
Building the module
SecretStorage requires Python ≥ 3.10 and these packages to work:
To build SecretStorage, use this command:
python3 -m build
If you have Sphinx installed, you can also build the documentation:
python3 -m sphinx docs build/sphinx/html
Testing the module
First, make sure that you have the Secret Service daemon installed. The GNOME Keyring is the reference server-side implementation for the Secret Service specification.
Then, start the daemon and unlock the default collection, if needed. The testsuite will fail to run if the default collection exists and is locked. If it does not exist, the testsuite can also use the temporary session collection, as provided by the GNOME Keyring.
Then, run the Python unittest module:
python3 -m unittest discover -s tests
If you want to run the tests in an isolated or headless environment, run this command in a D-Bus session:
dbus-run-session -- python3 -m unittest discover -s tests
Get the code
SecretStorage is available under BSD license. The source code can be found on GitHub.
1 maintainer
Release files for SecretStorage 3.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| secretstorage-3.5.0.tar.gz | 19.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| secretstorage-3.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.4 kB
Release files / secretstorage-3.5.0.tar.gz
| Download URL | secretstorage-3.5.0.tar.gz |
|---|---|
| Size | 19.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f04b8e4689cbce351744d5537bf6b1329c6fc68f91fa666f60a380edddcd11be
|
|
BLAKE2b-256 checksum How to use checksums |
1c03e834bcd866f2f8a49a85eaff47340affa3bfa391ee9912a952a1faa68c7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 23, 2025.
Transparency logRelease files / secretstorage-3.5.0-py3-none-any.whl
| Download URL | secretstorage-3.5.0-py3-none-any.whl |
|---|---|
| Size | 15.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ce65888c0725fcb2c5bc0fdb8e5438eece02c523557ea40ce0703c266248137
|
|
BLAKE2b-256 checksum How to use checksums |
b746f5af3402b579fd5e11573ce652019a67074317e18c1935cc0b4ba9b35552
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 23, 2025.
Transparency log
