https://github.com/muhammad-fiaz/keepsafe
KeepSafe: A secure and user-friendly solution for storing and distributing sensitive information such as keys and passwords in your projects.
https://github.com/muhammad-fiaz/keepsafe
decryption encryption encryption-decryption environment-variables keepsafe lock locker package poetry pypi python python-library python-package secure-env store-env
Last synced: 7 months ago
JSON representation
KeepSafe: A secure and user-friendly solution for storing and distributing sensitive information such as keys and passwords in your projects.
- Host: GitHub
- URL: https://github.com/muhammad-fiaz/keepsafe
- Owner: muhammad-fiaz
- License: mit
- Created: 2024-01-14T11:14:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T13:45:04.000Z (over 1 year ago)
- Last Synced: 2025-10-28T00:47:01.684Z (7 months ago)
- Topics: decryption, encryption, encryption-decryption, environment-variables, keepsafe, lock, locker, package, poetry, pypi, python, python-library, python-package, secure-env, store-env
- Language: Python
- Homepage: https://pypi.org/project/keepsafe/
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Keepsafe: Securely store and distribute sensitive information like passwords and keys
## Table of Contents
- [Introduction](#)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Initialize a new file with a master password](#initialize-a-new-file-with-a-master-password)
- [Add secrets](#add-secrets)
- [Retrieve secrets](#retrieve-secrets)
- [Export secrets to `.env` file](#export-secrets-to-env-file)
- [Testing](#testing)
- [License](#license)
- [Contributing](#contributing)
- [Contact](#contact)
Keepsafe is a Python library that helps you securely store and retrieve sensitive information like passwords, API keys, and other secrets. It uses encryption techniques to ensure that your sensitive data is safe, and only accessible using the correct master password or decryption key.
## Features
- Securely store and retrieve secrets (e.g., passwords, API keys).
- Encryption based on `Fernet` and `PBKDF2` for password-based key derivation.
- Supports adding secrets using either the master password or decryption key.
- Export secrets to `.env` files for use in applications.
- Easily integrated into existing projects.
## Installation
You can install `keepsafe` via `pip` from PyPI:
```bash
pip install keepsafe
```
## Usage
### Initialize a new file with a master password
First, create a `Keepsafe` object and initialize the file:
```python
from keepsafe import KeepSafe
ks = KeepSafe("./secrets.keepsafe")
decryption_key = ks.initialize_file(password="your_master_password")
```
### Add secrets
You can add secrets either using the master password or the decryption key:
```python
ks.add_secret("api_key", "super_secret_api_key", password_or_decryption_key="your_master_password")
ks.add_secret("email_password", "super_secret_email_password", password_or_decryption_key=decryption_key)
```
### Retrieve secrets
You can retrieve secrets using the master password or the decryption key:
```python
api_key = ks.get_secret("api_key", password_or_decryption_key="your_master_password")
email_password = ks.get_secret("email_password", password_or_decryption_key=decryption_key)
print(f"API Key: {api_key}")
print(f"Email Password: {email_password}")
```
### Export secrets to `.env` file
To unlock the file and export all secrets to a `.env` file:
```python
ks.unlock(password="your_master_password", env_file_path=".env")
```
This will export the secrets into the `.env` file, where each secret will be written as `KEY=VALUE`.
## Testing
To run tests, you can use `pytest`. This package includes basic tests to verify that the core functionality works as expected.
Run the tests with:
```bash
pytest
```
## License
Keepsafe is distributed under the MIT License. See `LICENSE` for more information.
## Contributing
We welcome contributions to Keepsafe! Before contributing, please make sure to read our [Code of Conduct](CODE_OF_CONDUCT.md) and follow the guidelines below to ensure a smooth collaboration process.
**Please ensure you follow the [Code of Conduct](CODE_OF_CONDUCT.md) when contributing.**
If you encounter any issues or need assistance, feel free to open an issue or contact the maintainers.
Thank you for your contributions!
## Contact
For any issues, bugs, or feature requests, please open an issue on the [GitHub repository](https://github.com/muhammad-fiaz/keepsafe).