Python implementation of a Redis-compatible API using websockets.
Project description
ZnSocket - Redis-like Key-Value Store in Python
ZnSocket provides a Redis-compatible API using python-socketio and Python objects for storage. It is designed for testing and applications requiring key-value storage while being easily installable via pip
. For production, consider using redis-py and a Redis instance.
[!IMPORTANT] ZnSocket is not designed for large data. The maximum size for a single communication is 100 MB. Although this value can be adapted, you will notice slow data transfers for large files.
Installation
To install ZnSocket, use:
pip install znsocket
Example
Start the ZnSocket server using the CLI:
znsocket --port 5000
For additional options, run:
znsocket --help
Here's a simple example of how to use the ZnSocket client:
from znsocket import Client
# Connect to the ZnSocket server
c = Client.from_url("znsocket://127.0.0.1:5000")
# Set and get a value
c.set("name", "Fabian")
assert c.get("name") == "Fabian"
[!NOTE] ZnSocket does not encode/decode strings. Using it is equivalent to using
Redis.from_url(storage, decode_responses=True)
in the Redis client.
Lists
ZnSocket provides a synchronized version of the Python list
implementation. Unlike a regular Python list, the data in znsocket.List
is not stored locally; instead, it is dynamically pushed to and pulled from the server.
Below is a step-by-step example of how to use znsocket.List
to interact with a ZnSocket server.
from znsocket import Client, List
# Connect to the ZnSocket server using the provided URL
client = Client.from_url("znsocket://127.0.0.1:5000")
# Create a synchronized list associated with the specified key
sync_list = List(r=client, key="list:1")
# Extend the list with multiple elements
sync_list.extend(["a", "b", "c", "d"])
# Print every second element from the list
print(sync_list[::2])
Dicts
ZnSocket provides a synchronized version of the Python dict
implementation similar to the list
implementation.
Below is a step-by-step example of how to use znsocket.Dict
to interact with a ZnSocket server.
from znsocket import Client, Dict
# Connect to the ZnSocket server using the provided URL
client = Client.from_url("znsocket://127.0.0.1:5000")
# Create a synchronized dict associated with the specified key
sync_dict = Dict(r=client, key="dict:1")
# Add an item to the synchronized dict
sync_dict["Hello"] = "World"
# Print the added item
print(sync_dict["Hello"])
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file znsocket-0.2.7.tar.gz
.
File metadata
- Download URL: znsocket-0.2.7.tar.gz
- Upload date:
- Size: 16.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e5f8225af2ccaa82334064f2054142e68caa4980a64f9d2711761677d8d323e |
|
MD5 | bbaca16d67ce482026c689d3b79587e5 |
|
BLAKE2b-256 | f7d6806d3456e0dac0de28da028242d3bc3faccc7e4348470b1e516efbd4dd94 |
File details
Details for the file znsocket-0.2.7-py3-none-any.whl
.
File metadata
- Download URL: znsocket-0.2.7-py3-none-any.whl
- Upload date:
- Size: 18.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 890c08cee5a4ae174d6bd8667b8445fba242586879f3fde60de35fe8fcb574df |
|
MD5 | cc8e2796b0644e9a4b3862cb704d1486 |
|
BLAKE2b-256 | 5f3f0ff06ba0e46b15807500076081a3f361fd5f8769427ba033c70bc48d184d |