| Name | zcached.py JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | https://github.com/xXenvy/zcached.py |
| Summary | A lightweight client-side library for zcached, written in Python. |
| upload_time | 2024-04-23 23:14:17 |
| maintainer | None |
| docs_url | None |
| author | xXenvy |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Zcached.py - A client-side library for zcached.
## `📜` Introduction
Zcached.py is a Python client-side library designed to interact with zcached, a high-performance in-memory caching system.
This library provides developers an easy-to-use interface for integrating zcached into their Python applications, enabling efficient data caching.
For more information, please see [zcached repository](https://github.com/sectasy0/zcached).
## `🌟` Features
- **Simplified Caching:** Zcached.py simplifies the process of caching data by providing intuitive functions for storing and retrieving values.
- **Efficient Communication:** The library optimizes communication with the zcached server, ensuring minimal overhead and efficient data transfer.
- **Properly Typehinted:** The codebase of zcached.py is properly typehinted, enhancing code readability.
## `🔧` Installation
> [!IMPORTANT]
> **Library requires python version 3.8 or newer.** (Older also should work, but untested).
Before installing zcached.py, ensure that you have the zcached server. Instructions for installing and running the server can be found [here](https://github.com/sectasy0/zcached).
Once the zcached server is ready to use, you can proceed to install zcached.py using pip:
```shell
pip install -U zcached.py
```
## `🖊️` Usage
Here's a basic example demonstrating how to use zcached.py in your Python code:
```py
from typing import List
from zcached import ZCached, Result
client = ZCached(host="localhost", port=5555)
client.run()
if client.is_alive() is False:
raise RuntimeError("Something went wrong.")
client.set(key="dogs", value=["Pimpek", "Laika"])
dogs_result: Result[List[str]] = client.get(key="dogs")
dbsize_result: Result[int] = client.dbsize()
keys_result: Result[List[str]] = client.keys()
print(keys_result.value)
client.save()
client.delete("dogs")
client.flush()
```
**See more examples [here](https://github.com/xXenvy/zcached.py/tree/master/examples)**
## `👥` Contributing
Contributions to zcached.py are welcome!
If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
## `📕` License
Zcached.py is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/xXenvy/zcached.py",
"name": "zcached.py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "xXenvy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ba/b7/cd21762d8d1ccbeab461e43088bab175c85d4247185df1dc2272784e179b/zcached.py-1.2.1.tar.gz",
"platform": null,
"description": "# Zcached.py - A client-side library for zcached.\r\n\r\n\r\n\r\n\r\n\r\n## `\ud83d\udcdc` Introduction\r\nZcached.py is a Python client-side library designed to interact with zcached, a high-performance in-memory caching system.\r\nThis library provides developers an easy-to-use interface for integrating zcached into their Python applications, enabling efficient data caching.\r\n\r\nFor more information, please see [zcached repository](https://github.com/sectasy0/zcached).\r\n\r\n## `\ud83c\udf1f` Features\r\n- **Simplified Caching:** Zcached.py simplifies the process of caching data by providing intuitive functions for storing and retrieving values.\r\n- **Efficient Communication:** The library optimizes communication with the zcached server, ensuring minimal overhead and efficient data transfer.\r\n- **Properly Typehinted:** The codebase of zcached.py is properly typehinted, enhancing code readability.\r\n\r\n## `\ud83d\udd27` Installation\r\n> [!IMPORTANT] \r\n> **Library requires python version 3.8 or newer.** (Older also should work, but untested).\r\n\r\nBefore installing zcached.py, ensure that you have the zcached server. Instructions for installing and running the server can be found [here](https://github.com/sectasy0/zcached).\r\n\r\nOnce the zcached server is ready to use, you can proceed to install zcached.py using pip:\r\n```shell\r\npip install -U zcached.py\r\n```\r\n\r\n## `\ud83d\udd8a\ufe0f` Usage\r\nHere's a basic example demonstrating how to use zcached.py in your Python code:\r\n```py\r\nfrom typing import List\r\nfrom zcached import ZCached, Result\r\n\r\nclient = ZCached(host=\"localhost\", port=5555)\r\nclient.run()\r\n\r\nif client.is_alive() is False:\r\n raise RuntimeError(\"Something went wrong.\")\r\n\r\nclient.set(key=\"dogs\", value=[\"Pimpek\", \"Laika\"])\r\n\r\ndogs_result: Result[List[str]] = client.get(key=\"dogs\")\r\ndbsize_result: Result[int] = client.dbsize()\r\nkeys_result: Result[List[str]] = client.keys()\r\nprint(keys_result.value)\r\n\r\nclient.save()\r\nclient.delete(\"dogs\")\r\nclient.flush()\r\n```\r\n**See more examples [here](https://github.com/xXenvy/zcached.py/tree/master/examples)**\r\n\r\n## `\ud83d\udc65` Contributing\r\nContributions to zcached.py are welcome!\r\nIf you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.\r\n\r\n## `\ud83d\udcd5` License\r\nZcached.py is licensed under the MIT License.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A lightweight client-side library for zcached, written in Python.",
"version": "1.2.1",
"project_urls": {
"Bug Reports": "https://github.com/xXenvy/zcached.py/issues",
"Homepage": "https://github.com/xXenvy/zcached.py",
"Source": "https://github.com/xXenvy/zcached.py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f59c06e685813d979b691f97ef6555c8ea2ce92d9f1ba90f7d032655f4f93684",
"md5": "3badd7f9eedc7a1f5a714233a51f7382",
"sha256": "60254d1a5938aa34673ac9f177e15188a94c6278ff502aef67549d1838d1d436"
},
"downloads": -1,
"filename": "zcached.py-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3badd7f9eedc7a1f5a714233a51f7382",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13447,
"upload_time": "2024-04-23T23:14:15",
"upload_time_iso_8601": "2024-04-23T23:14:15.999505Z",
"url": "https://files.pythonhosted.org/packages/f5/9c/06e685813d979b691f97ef6555c8ea2ce92d9f1ba90f7d032655f4f93684/zcached.py-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bab7cd21762d8d1ccbeab461e43088bab175c85d4247185df1dc2272784e179b",
"md5": "baddbc719f773f18077016da7895b11c",
"sha256": "1a7af70b424da32278a205e44faa710564ff6bd18e4e2b08f8207226a847fff6"
},
"downloads": -1,
"filename": "zcached.py-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "baddbc719f773f18077016da7895b11c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14197,
"upload_time": "2024-04-23T23:14:17",
"upload_time_iso_8601": "2024-04-23T23:14:17.129673Z",
"url": "https://files.pythonhosted.org/packages/ba/b7/cd21762d8d1ccbeab461e43088bab175c85d4247185df1dc2272784e179b/zcached.py-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 23:14:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xXenvy",
"github_project": "zcached.py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "zcached.py"
}
