https://github.com/joaopeuko/secured
Secure your Python data with Secured. This tool protects sensitive information like API keys and database credentials, offering customizable settings for high confidentiality and integrity. Note: Provides a thin layer of protection.
https://github.com/joaopeuko/secured
configuration-management environment-variables security security-tools
Last synced: 12 months ago
JSON representation
Secure your Python data with Secured. This tool protects sensitive information like API keys and database credentials, offering customizable settings for high confidentiality and integrity. Note: Provides a thin layer of protection.
- Host: GitHub
- URL: https://github.com/joaopeuko/secured
- Owner: Joaopeuko
- License: mit
- Created: 2024-04-15T15:23:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T09:05:13.000Z (over 1 year ago)
- Last Synced: 2025-01-02T10:22:34.623Z (over 1 year ago)
- Topics: configuration-management, environment-variables, security, security-tools
- Language: Python
- Homepage:
- Size: 121 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/Joaopeuko/secured)
# Secured
- [Secured](#secured)
- [Installation](#installation)
- [Usage](#usage)
- [Example 1: Basic Usage](#example-1-basic-usage)
- [Example 2: Custom Usage](#example-2-custom-usage)
- [Example 3: Config Usage](#example-3-config-usage)
- [Example 4: Compose](#example-4-compose)
- [Features](#features)
Secure your Python data structures and secrets with Secured. This package provides a straightforward solution for obscuring sensitive data in applications. It's specifically designed for developers who need to protect API keys, database credentials, and other critical configuration details from accidental exposure. Featuring customizable security measures, our tool allows you to control how sensitive information is represented and managed securely. It's ideal for projects that demand high data confidentiality and integrity. Please note that this provides a thin layer of protection.
## Installation
To install Secured, run the following command:
```python
pip install secured
```
## Usage
Below are some examples on how to use Secured to protect your sensitive data:
### Example 1: Basic Usage
```python
from secured import Secure
# Protect a sensitive string
DATABASE_URL = "mysql://user:password@localhost/dbname"
secure_database_url = Secure(DATABASE_URL, "")
# Usage in code
print(secure_database_url) # Output:
```
### Example 2: Custom Usage
```python
from secured import Secure
# Protect an API key with a custom message
API_KEY = "12345-abcdef-67890-ghijk"
secure_api_key = Secure(API_KEY, "API Key Protected")
# Usage in code
print(secure_api_key) # Output: API Key Protected
```
### Example 3: Config Usage
The `Secured` class allows you to securely read configuration files containing sensitive data. Here's how you can use it:
```python
from secured import Secured
# Create a Secured object to read a YAML configuration file
secured = Secured('config.yaml', secure=True)
# Access configuration attributes securely
print(secured.config.name) # Using dot notation
print(secured.config["name"]) # Using dictionary-like notation
```
### Example 4: Compose
```python
from secured import Secured
# Define the custom secure message
message = "🔒 🔒"
# Example secured object
CONFIG_PATH = "examples/config.yaml"
DATABASE_URL = "mysql://{user}:{password}@localhost/dbname"
secure = Secured(CONFIG_PATH, secure=True, message=message)
# Usage in code
secure_database_url = secure.compose(DATABASE_URL, user="guest", password="guest_password")
print(secure_database_url) # Output: 🔒 🔒
print(secure_database_url.get_original()) # Careful! This will print the original data, do not use it.
print(secure_database_url == "mysql://guest:guest_password@localhost/dbname") # Output: True
```
## Features
- **Data Protection**: Helps prevent the accidental logging or display of sensitive information.
- **Customizable Representations**: Set how your data is displayed when being secured.
- **Ease of Use**: Integrate seamlessly into existing Python applications.