Skip to main content

Python client for Redis key-value store, extended to support additional features from YugaByteDB

Project description

The Python interface to the Redis key-value store, extended to support additional features from YugaByteDB.

This has been forked from and is intended to be used against the YEDIS API end point of YugaByteDB. This client also supports additional commands (such as the time-series related commands) for use against YugaByte DB that are not part of the official Redis API.

Please refer to YugaByte DB docs for reference.


yedis requires a running YugaByteDB instance listening on the YEDIS end point, or a normal Redis server. See YugaByteDB quickstart or Redis’s quickstart for installation instructions.

To install yedis, simply:

$ sudo pip install yedis

or alternatively (you really should be using pip though):

$ sudo easy_install yedis

or from source:

$ sudo python install

Getting Started

>>> import redis
>>> r = redis.StrictRedis(host='localhost', port=6379, db=0)
>>> r.set('foo', 'bar')
>>> r.get('foo')

By default, all responses are returned as bytes in Python 3 and str in Python 2. The user is responsible for decoding to Python 3 strings or Python 2 unicode objects.

If all string responses from a client should be decoded, the user can specify decode_responses=True to StrictRedis.__init__. In this case, any Redis command that returns a string type will be decoded with the encoding specified.

API Reference

Please refer to YugaByte API Refernce for details on the commmands that Yugabyte’s YEDIS end point supports. For other use cases, the official Redis command documentation does a great job of explaining each command in detail.

yedis is forked off redis-py, please refer to for the details of the implementation and limitations.


yedis is based on a fork of redis-py, extended to support the additional commands for use against YugaByteDB’s YEDIS API end point.

redis-py is developed and maintained by Andy McCurdy ( It can be found here:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for yedis, version
Filename, size File type Python version Upload date Hashes
Filename, size yedis- (331.6 kB) File type Egg Python version 2.7 Upload date Hashes View
Filename, size yedis- (138.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size yedis- (79.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page