https://github.com/kumaraditya303/pycreds
PyCreds - Python Library to keep credentials safe by storing in platform keystores.
https://github.com/kumaraditya303/pycreds
Last synced: 3 months ago
JSON representation
PyCreds - Python Library to keep credentials safe by storing in platform keystores.
- Host: GitHub
- URL: https://github.com/kumaraditya303/pycreds
- Owner: kumaraditya303
- License: bsd-3-clause
- Created: 2021-01-13T11:20:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T08:29:54.000Z (over 1 year ago)
- Last Synced: 2025-03-17T20:43:18.574Z (3 months ago)
- Language: C++
- Homepage:
- Size: 70.3 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PyCreds - Python Library to keep credentials safe by storing in platform keystores.
    [](https://pepy.tech/project/pycreds)
PyCreds is a Python Library written in C++ to keep credentials safe by storing in platform keystores. On MacOS the passwords are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.
---
# Features 🚀
- **Cross Platform** - PyCreds is a cross platform solution for storing credentials, Windows, Linux and MacOS are fully supported.
- **Security** - Uses platform specific credential vault for storing credentials.
- **API** - Provides high level operations such as `get_password`, `set_password`, `delete_password`, `find_password` and `find_credentials`.
- **Command Line Interface** - Ships with a Cli based on [click](https://github.com/pallets/click) for Cli usage.
---
# Installation ✔
Install with pip:
```bash
$ pip install pycreds
# Or Install with cli
$ pip install pycreds[cli]
```
---
# Docs
- `get_password(service, account)`
Get the stored password for `service` and `account`.
`service` - The string service name.
`account` - The string account name.
Returns password as `string` if found else raises `ValueError`.
- `set_password(service, account, password)`
Save the `password` for `service` and `account`.
`service` - The string service name.
`account` - The string account name.
`password` - The string password.
Returns `True` if successful else raises `ValueError`.
- `delete_password(service, account)`
Delete the `password` for `service` and `account`.
`service` - The string service name.
`account` - The string account name.
Returns `True` if successful else raises `ValueError`.
- `find_password(service)`
Finds `password` for `service`.
`service` - The string service name.
Returns password as `string` if found else returns `None`.
- `find_credentials(service)`
Finds credentials for `service`.
`service` - The string service name.
Returns a list of credential dict in format `{"account": "foo", "password": "bar"}`.
---
# Cli Docs
```txt
Usage: pycreds [OPTIONS] COMMAND [ARGS]...
PyCreds Command Line Interface.
Options:
--help Show this message and exit.
Commands:
delete Delete Password.
get Get Password.
set Set Password.
```
---