Drop-in redis-py replacement backed by valkey-py — migrate from Redis to Valkey without changing application code
Project description
valkey-redis-compat
Drop-in redis-py replacement backed by valkey-py.
Migrate from Redis to Valkey without changing a single line of application code.
Русская версия / Russian version
What it does
| Layer | Before | After |
|---|---|---|
import redis |
loads redis-py |
loads valkey-py via this shim |
redis.Redis(...) |
redis.client.Redis |
valkey.client.Valkey (API-compatible) |
| kombu broker transport | redis:// only |
works through the shim |
flask-caching RedisCache |
needs redis-py |
works through the shim |
The package patches importlib.metadata.version("redis") so that libraries like kombu, which check the installed redis version at import time, work without issues.
Installation
pip install valkey-redis-compat
Quick start
Nothing changes in your application code:
import redis
r = redis.Redis(host="localhost", port=6379, db=0)
r.set("key", "value")
print(r.get("key")) # b'value'
Under the hood every call goes through valkey-py.
kombu / Celery broker
kombu uses import redis internally for the redis:// broker transport — the shim handles this transparently.
To use valkey:// URLs as a broker, register the transport alias before Celery starts:
from kombu.transport import TRANSPORT_ALIASES
TRANSPORT_ALIASES.setdefault("valkey", "kombu.transport.redis:Transport")
TRANSPORT_ALIASES.setdefault("valkeys", "kombu.transport.redis:Transport")
flask-caching
No changes needed — RedisCache / RedisSentinelCache import redis internally, which this package provides.
Shim coverage
Every public valkey-py submodule is re-exported under the redis namespace:
redis.* |
maps to |
|---|---|
redis |
valkey |
redis.asyncio |
valkey.asyncio |
redis.backoff |
valkey.backoff |
redis.client |
valkey.client |
redis.cluster |
valkey.cluster |
redis.commands |
valkey.commands |
redis.connection |
valkey.connection |
redis.credentials |
valkey.credentials |
redis.exceptions |
valkey.exceptions |
redis.lock |
valkey.lock |
redis.retry |
valkey.retry |
redis.sentinel |
valkey.sentinel |
redis.typing |
valkey.typing |
redis.utils |
valkey.utils |
Nested submodules (redis.asyncio.client, redis.commands.search, etc.) are also covered.
Why not just import valkey as redis?
That works for your code.
It does not work for third-party libraries (kombu, flask-caching, celery) that hardcode import redis internally.
This package solves both cases at once.
Compatibility
- Python 3.9 -- 3.13
- valkey-py >= 6.1.1
- Tested with kombu 5.x, flask-caching 2.x
License
MIT
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file valkey_redis_compat-0.1.0.tar.gz.
File metadata
- Download URL: valkey_redis_compat-0.1.0.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c43743aa041bd13fef394659000d605fa5dd94e888bfbd85cdd9a9c8bdfb1be
|
|
| MD5 |
64039d948e7cd544e97cd6bae14124bc
|
|
| BLAKE2b-256 |
995cf96e1224e0269124a1daa32a5375f3d0ff819d36df58162ed5a3d83aa34f
|
File details
Details for the file valkey_redis_compat-0.1.0-py3-none-any.whl.
File metadata
- Download URL: valkey_redis_compat-0.1.0-py3-none-any.whl
- Upload date:
- Size: 20.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3683aa38261b1f77aa711e6f0b84e721334d5982db27bc042a6de56364a5660
|
|
| MD5 |
c4a4b075673c027adcaa685a2c9e1430
|
|
| BLAKE2b-256 |
531d2c88172953edffd73bf709b52ab73a062b1ab596f518ad78904236c603ed
|