| Name | configvault JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Secure, encrypted configuration storage for Python applications |
| upload_time | 2024-11-09 19:29:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Ioannis D. (devcoons) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
configvault
configuration
encryption
secure storage
config management
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ConfigVault
[](https://pypi.org/project/configvault)
`ConfigVault` is a Python library that provides secure, encrypted configuration storage for sensitive data. It allows you to store, retrieve, and manage configuration settings with ease and security. Perfect for applications that require protected access to configuration details like API keys or database credentials.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [Usage](#usage)
- [Basic Initialization](#basic-initialization)
- [Storing Configuration](#storing-configuration)
- [Retrieving Configuration](#retrieving-configuration)
- [Removing Configurations](#removing-configurations)
- [Security](#security)
## Installation
To use ConfigVault, install it using pip:
```
pip install configvault
```
## Features
- Secure, encrypted storage for sensitive configuration data.
- Supports storing, retrieving, and removing specific configurations by key.
- Option to overwrite existing configurations with @force=True@.
- Ability to clear all stored configurations at once.
## Usage
### Basic Initialization
To get started, initialize `ConfigVault` with a storage folder path and a password for key derivation. A unique, strong password is recommended.
```
from configvault import ConfigVault
vault = ConfigVault(folder_path='path/to/storage', password='my_secure_password')
```
### Storing Configuration
Store a configuration dictionary securely under a specific key. Set `force=True` if you want to overwrite an existing entry.
```
data = {"database": "mydb", "user": "admin", "password": "secure_password"}
vault.store("db_config", data, force=True) # Overwrites if "db_config" exists
```
### Retrieving Configuration
Retrieve and decrypt stored data by its key.
```
retrieved_data = vault.retrieve("db_config")
print(retrieved_data) # Output: {"database": "mydb", "user": "admin", "password": "secure_password"}
```
### Removing Configurations
To remove a specific configuration by its key, use the `remove` method.
```
vault.remove("db_config") # Removes the configuration with key "db_config"
```
To remove all stored configurations, use the `remove_all` method:
```
vault.remove_all() # Clears all configurations
```
## Security
ConfigVault uses @cryptography@ for secure encryption based on a key derived from your password. For optimal security:
- Use a strong, unique password.
- Store your password securely (e.g., in an environment variable).
- Set a unique folder path for each application's configurations.
ConfigVault is ideal for applications that need sensitive data management, providing a reliable, encrypted storage solution.
Raw data
{
"_id": null,
"home_page": null,
"name": "configvault",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "configvault, configuration, encryption, secure storage, config management",
"author": null,
"author_email": "\"Ioannis D (devcoons)\" <support@devcoons.com>",
"download_url": "https://files.pythonhosted.org/packages/7a/e9/21383fcd6df996b9f4295ae84cd89b48bd1ce9b47ecfdc4e63087ec03168/configvault-0.0.2.tar.gz",
"platform": null,
"description": "# ConfigVault\n\n[](https://pypi.org/project/configvault)\n\n\n\n\n`ConfigVault` is a Python library that provides secure, encrypted configuration storage for sensitive data. It allows you to store, retrieve, and manage configuration settings with ease and security. Perfect for applications that require protected access to configuration details like API keys or database credentials.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Features](#features)\n- [Usage](#usage)\n - [Basic Initialization](#basic-initialization)\n - [Storing Configuration](#storing-configuration)\n - [Retrieving Configuration](#retrieving-configuration)\n - [Removing Configurations](#removing-configurations)\n- [Security](#security)\n\n## Installation\n\nTo use ConfigVault, install it using pip:\n\n```\npip install configvault\n```\n\n\n## Features\n\n- Secure, encrypted storage for sensitive configuration data.\n- Supports storing, retrieving, and removing specific configurations by key.\n- Option to overwrite existing configurations with @force=True@.\n- Ability to clear all stored configurations at once.\n\n## Usage\n\n### Basic Initialization\n\nTo get started, initialize `ConfigVault` with a storage folder path and a password for key derivation. A unique, strong password is recommended.\n\n```\nfrom configvault import ConfigVault\n\nvault = ConfigVault(folder_path='path/to/storage', password='my_secure_password')\n```\n\n\n### Storing Configuration\n\nStore a configuration dictionary securely under a specific key. Set `force=True` if you want to overwrite an existing entry.\n\n```\ndata = {\"database\": \"mydb\", \"user\": \"admin\", \"password\": \"secure_password\"} \nvault.store(\"db_config\", data, force=True) # Overwrites if \"db_config\" exists\n```\n\n\n### Retrieving Configuration\n\nRetrieve and decrypt stored data by its key.\n\n```\nretrieved_data = vault.retrieve(\"db_config\") \nprint(retrieved_data) # Output: {\"database\": \"mydb\", \"user\": \"admin\", \"password\": \"secure_password\"}\n```\n\n\n### Removing Configurations\n\nTo remove a specific configuration by its key, use the `remove` method.\n\n```\nvault.remove(\"db_config\") # Removes the configuration with key \"db_config\"\n```\n\n\nTo remove all stored configurations, use the `remove_all` method:\n\n```\nvault.remove_all() # Clears all configurations\n```\n\n\n## Security\n\nConfigVault uses @cryptography@ for secure encryption based on a key derived from your password. For optimal security:\n\n- Use a strong, unique password.\n- Store your password securely (e.g., in an environment variable).\n- Set a unique folder path for each application's configurations.\n\nConfigVault is ideal for applications that need sensitive data management, providing a reliable, encrypted storage solution.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Ioannis D. (devcoons) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Secure, encrypted configuration storage for Python applications",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://github.com/devcoons/configvault/wiki",
"Homepage": "https://github.com/devcoons/configvault",
"Issues": "https://github.com/devcoons/configvault/issues",
"Source": "https://github.com/devcoons/configvault"
},
"split_keywords": [
"configvault",
" configuration",
" encryption",
" secure storage",
" config management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7eaaa72421edb45cf9d2884d0206dc31c19a0d263aeae665fbbb46ddb6e594db",
"md5": "e0a8661ffca5bb739dab8709d2e95cf9",
"sha256": "3c726565e9aed6d8c0f9c985453643dba1f092fead206e8e983c6d7739a5af20"
},
"downloads": -1,
"filename": "configvault-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0a8661ffca5bb739dab8709d2e95cf9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6549,
"upload_time": "2024-11-09T19:29:42",
"upload_time_iso_8601": "2024-11-09T19:29:42.605780Z",
"url": "https://files.pythonhosted.org/packages/7e/aa/a72421edb45cf9d2884d0206dc31c19a0d263aeae665fbbb46ddb6e594db/configvault-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ae921383fcd6df996b9f4295ae84cd89b48bd1ce9b47ecfdc4e63087ec03168",
"md5": "f0f408ca7c833e30aa40fa1161e09f2f",
"sha256": "b980334e74132641cd4bf72d2e2b3cc90c4e8f11274f592c33da759fdef22a03"
},
"downloads": -1,
"filename": "configvault-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f0f408ca7c833e30aa40fa1161e09f2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5534,
"upload_time": "2024-11-09T19:29:44",
"upload_time_iso_8601": "2024-11-09T19:29:44.113048Z",
"url": "https://files.pythonhosted.org/packages/7a/e9/21383fcd6df996b9f4295ae84cd89b48bd1ce9b47ecfdc4e63087ec03168/configvault-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 19:29:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "devcoons",
"github_project": "configvault",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "configvault"
}
