# Burrowkv
Burrowkv is a simple key-value store implementation in Python. It provides basic functionality to store and retrieve key-value pairs, as well as additional features such as JSON serialization and deserialization.
## Features
- Set a value for a given key.
- Retrieve the value associated with a key.
- Delete a key-value pair.
- Check if a key exists in the store.
- Get a list of all keys.
- Get a list of all values.
- Get a list of all key-value pairs.
- Serialize the key-value store to JSON.
- Deserialize JSON into the key-value store.
## Installation
```
pip install burrowkv
```
## Usage
```
from burrowkv import burrowkv
# Create a new instance of burrowkv
store = burrowkv()
# Set a value for a key
store.set('name', 'John')
# Retrieve the value associated with a key
name = store.get('name') # Returns 'John'
# Delete a key-value pair
store.delete('name')
# Check if a key exists
if store.contains('name'):
print('Key exists')
else:
print('Key does not exist')
# Get a list of all keys
keys = store.keys() # Returns a list of keys
# Get a list of all values
values = store.values() # Returns a list of values
# Get a list of all key-value pairs
items = store.items() # Returns a list of (key, value) tuples
# Serialize the key-value store to JSON
json_data = store.to_json()
# Deserialize JSON into the key-value store
store.from_json(json_data)
```
## License
This project is licensed under the MIT License. See the LICENSE file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/iunary/burrowkv",
"name": "burrowkv",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "key value store,kv,key-value",
"author": "Yusuf",
"author_email": "contact@yusuf.im",
"download_url": "https://files.pythonhosted.org/packages/7e/67/4ef33bf6cde1774f29c91d40e354fe6cd28831adfb82541882c37efc34fc/burrowkv-0.0.3.tar.gz",
"platform": null,
"description": "# Burrowkv\n\nBurrowkv is a simple key-value store implementation in Python. It provides basic functionality to store and retrieve key-value pairs, as well as additional features such as JSON serialization and deserialization.\n\n## Features\n\n- Set a value for a given key.\n- Retrieve the value associated with a key.\n- Delete a key-value pair.\n- Check if a key exists in the store.\n- Get a list of all keys.\n- Get a list of all values.\n- Get a list of all key-value pairs.\n- Serialize the key-value store to JSON.\n- Deserialize JSON into the key-value store.\n\n## Installation\n\n```\npip install burrowkv\n```\n\n## Usage\n```\nfrom burrowkv import burrowkv\n\n# Create a new instance of burrowkv\nstore = burrowkv()\n\n# Set a value for a key\nstore.set('name', 'John')\n\n# Retrieve the value associated with a key\nname = store.get('name') # Returns 'John'\n\n# Delete a key-value pair\nstore.delete('name')\n\n# Check if a key exists\nif store.contains('name'):\n print('Key exists')\nelse:\n print('Key does not exist')\n\n# Get a list of all keys\nkeys = store.keys() # Returns a list of keys\n\n# Get a list of all values\nvalues = store.values() # Returns a list of values\n\n# Get a list of all key-value pairs\nitems = store.items() # Returns a list of (key, value) tuples\n\n# Serialize the key-value store to JSON\n\njson_data = store.to_json()\n\n# Deserialize JSON into the key-value store\nstore.from_json(json_data)\n```\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for more information.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "key-value store",
"version": "0.0.3",
"split_keywords": [
"key value store",
"kv",
"key-value"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d885690a85f847a7c681eb48b226d5b57773c82ef982c1c5fbb827c96276028f",
"md5": "d7ff6040f8cac05e8ab807192d9715b6",
"sha256": "aeff791f865091478802039b07a9ebf1d1008a205be6faa391c5383f71eee381"
},
"downloads": -1,
"filename": "burrowkv-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7ff6040f8cac05e8ab807192d9715b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4685,
"upload_time": "2023-04-28T16:04:38",
"upload_time_iso_8601": "2023-04-28T16:04:38.309041Z",
"url": "https://files.pythonhosted.org/packages/d8/85/690a85f847a7c681eb48b226d5b57773c82ef982c1c5fbb827c96276028f/burrowkv-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e674ef33bf6cde1774f29c91d40e354fe6cd28831adfb82541882c37efc34fc",
"md5": "afd2a5856e6f96331c72676281be9f80",
"sha256": "10312b9907b7cdf279a407212786f7331dbd76c88485650173a07fddaac60ba4"
},
"downloads": -1,
"filename": "burrowkv-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "afd2a5856e6f96331c72676281be9f80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3987,
"upload_time": "2023-04-28T16:04:41",
"upload_time_iso_8601": "2023-04-28T16:04:41.993715Z",
"url": "https://files.pythonhosted.org/packages/7e/67/4ef33bf6cde1774f29c91d40e354fe6cd28831adfb82541882c37efc34fc/burrowkv-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 16:04:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "iunary",
"github_project": "burrowkv",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "burrowkv"
}
JSON
