A Python package that provides a flexible way to retrieve credentials from various sources, including KeePassXC and custom credential providers.
Project description
cred_retrieve
cred_retrieve is a Python package that provides a flexible way to retrieve credentials from various sources, including KeePassXC and custom credential providers.
Installation
PS > pip install cred_retrieve
Usage
You can easily create a credential provider and retrieve credentials using the following examples.
Ecample 1: Using DotEnv Provider
# id
ID='dotenv_id'
# pw
PW='dotenv_pw'
ETC='etc_secret'
from cred_retrieve import create_provider
cred = create_provider('dotenv')
print(cred.get_id_pw())
print(cred['ETC'])
Example 2: Using KeePassXC Provider
import os
from cred_retrieve import create_provider
# Set the path to your KeePassXC database file
db = os.path.join(os.getenv('PROGRAMDATA'), 'KeePassXC', 'cred.kdbx')
# Create a provider instance
cred = create_provider('keepassxc', db)
# Retrieve credentials
username, password = cred.get_id_pw('db_password', 'entry')
print(f'Username: {username}, Password: {password}')
Example 3: Registering a Custom Provider
You can also create and register your own credential provider:
from cred_retrieve import creators, CredentialProvider, create_provider
# Define a custom provider
class TestProvider(CredentialProvider):
def __init__(self):
pass
def get_id_pw(self):
return 'test_id', 'test_pw'
# Register the custom provider
creators().register('test', TestProvider)
# Create an instance of the custom provider
p = create_provider('test')
# Retrieve credentials from the custom provider
username, password = p.get_id_pw()
print(f'Username: {username}, Password: {password}')
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
For any questions or support, please reach out to me via GitHub Issues.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cred_retrieve-0.1.3.tar.gz
.
File metadata
- Download URL: cred_retrieve-0.1.3.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8b01bc89bfb0b12c1728a85ab24d1dd90af31d3b6f697040e5d2c6225b5dd5a |
|
MD5 | 89e2abad21c1f000c5218dc619234fd5 |
|
BLAKE2b-256 | 01cfccd76d3ffb9d26904bdc904d41436e38e2a02523e738bfc104095b538da5 |
File details
Details for the file cred_retrieve-0.1.3-py3-none-any.whl
.
File metadata
- Download URL: cred_retrieve-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20f5978f9b77aad9e164da1aa9d2713fd30d9e3a9ddf1a4771451a14838387ff |
|
MD5 | 4d22c999868562a4027836f4a3dc5a0f |
|
BLAKE2b-256 | ac7d9505ee69cb8aa049c7b1556e2e064256c86150263f0456fd44d6ec018d8d |