Metadata-Version: 2.1
Name: SafeVaultDB
Version: 1.0.1
Summary: a free database library for python
Home-page: https://github.com/RGB-CAT/SafeVaultDB-Python
Author: RGB_CATT
Author-email: <RGBCAT@duck.com>
Keywords: python,database
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
Requires-Dist: cryptography

# Contributing
Contributions are welcome! If you'd like to contribute to SafeVaultDB, please submit a pull request to the [repository](https://github.com/RGB-CAT/SafeVaultDB-Python).

# License
SafeVaultDB for python is released under the GNU GPL 3 License.

# Usage
```python
from SafeVaultDB import SafeVault

# Initialize SafeVault with database path and password
vault = SafeVault(database_path="path/to/database.db", password="your_password")
```

## Installation

You can install SafeVaultDB for python using pip:
```bash
pip install SafeVaultDB
```

# Functions
## Initialization
### __init__(database_path:str, password:str)
### Initialize SafeVault object.

#### database_path (str): The path to the database file.
#### password (str): The password used to generate the encryption key.
## Adding Data
### add_data(key:str, value:str)
### Adds key-value pair to the encrypted database.

#### key (str): The key to add.
#### value (str): The value corresponding to the key.
## Updating Data
### update_data(key:str, value:str)
### Updates the value corresponding to the given key in the encrypted database.

#### key (str): The key to update.
#### value (str): The new value corresponding to the key.
## Retrieving Data
### get_data(key:str)
### retrieves data corresponding to the given key from the encrypted database.

#### key (str): The key to retrieve data for.
## Deleting Data
### delete_data(key:str)
#### Key (str): The key to delete
### Deletes data corresponding to the given key from the encrypted database.
