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.

🌟 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.

Once the zcached server is ready to use, you can proceed to install zcached.py using pip:

pip install -U zcached.py

🖊️ Usage

Here's a basic example demonstrating how to use zcached.py in your Python code:

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

👥 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.