# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/RGB-CAT/SafeVaultDB-Python",
"name": "SafeVaultDB",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,database",
"author": "RGB_CATT",
"author_email": "<RGBCAT@duck.com>",
"download_url": "",
"platform": null,
"description": "# Contributing\r\nContributions 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).\r\n\r\n# License\r\nSafeVaultDB for python is released under the GNU GPL 3 License.\r\n\r\n# Usage\r\n```python\r\nfrom SafeVaultDB import SafeVault\r\n\r\n# Initialize SafeVault with database path and password\r\nvault = SafeVault(database_path=\"path/to/database.db\", password=\"your_password\")\r\n```\r\n\r\n## Installation\r\n\r\nYou can install SafeVaultDB for python using pip:\r\n```bash\r\npip install SafeVaultDB\r\n```\r\n\r\n# Functions\r\n## Initialization\r\n### __init__(database_path:str, password:str)\r\n### Initialize SafeVault object.\r\n\r\n#### database_path (str): The path to the database file.\r\n#### password (str): The password used to generate the encryption key.\r\n## Adding Data\r\n### add_data(key:str, value:str)\r\n### Adds key-value pair to the encrypted database.\r\n\r\n#### key (str): The key to add.\r\n#### value (str): The value corresponding to the key.\r\n## Updating Data\r\n### update_data(key:str, value:str)\r\n### Updates the value corresponding to the given key in the encrypted database.\r\n\r\n#### key (str): The key to update.\r\n#### value (str): The new value corresponding to the key.\r\n## Retrieving Data\r\n### get_data(key:str)\r\n### retrieves data corresponding to the given key from the encrypted database.\r\n\r\n#### key (str): The key to retrieve data for.\r\n## Deleting Data\r\n### delete_data(key:str)\r\n#### Key (str): The key to delete\r\n### Deletes data corresponding to the given key from the encrypted database.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "a free database library for python",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/RGB-CAT/SafeVaultDB-Python"
},
"split_keywords": [
"python",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "324d2544b9df20b5db2b1e86e0f92fc8edfcd68955fe5705ed74943514d28584",
"md5": "2461ac4cd42281f08825c3977a22b5fd",
"sha256": "62257ff25fca6a55f6a135b88c3ebe89caa0c4345405e62a48bd73a9304938c3"
},
"downloads": -1,
"filename": "SafeVaultDB-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2461ac4cd42281f08825c3977a22b5fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4415,
"upload_time": "2024-03-14T01:45:01",
"upload_time_iso_8601": "2024-03-14T01:45:01.622493Z",
"url": "https://files.pythonhosted.org/packages/32/4d/2544b9df20b5db2b1e86e0f92fc8edfcd68955fe5705ed74943514d28584/SafeVaultDB-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-14 01:45:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RGB-CAT",
"github_project": "SafeVaultDB-Python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "safevaultdb"
}
JSON
