Skip to main content

yedis

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

This has been forked from https://github.com/andymccurdy/redis-py 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.

Installation

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 setup.py install

Getting Started

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

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 https://github.com/andymccurdy/redis-py for the details of the implementation and limitations.

Author

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 (sedrik@gmail.com). It can be found here: http://github.com/andymccurdy/redis-py

Metadata

Release files for yedis 2.10.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yedis 2.10.6.0
File Size Uploaded
yedis-2.10.6.0.tar.gz 79.0 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for yedis 2.10.6.0
File Interpreter ABI Platform
yedis-2.10.6.0-py2.py3-none-any.whl Python 2, Python 3 none any Details
yedis-2.10.6.0-py2.7.egg Legacy Egg format - - Details

Total release size: 549.1 kB

Release files / yedis-2.10.6.0.tar.gz

Download URL yedis-2.10.6.0.tar.gz
Size 79.0 kB
Tags Source
SHA-256 checksum
How to use checksums
2b52a64ed998e7a0fd6572989834285d7348916c96e3425502767aff5fa93a77
BLAKE2b-256 checksum
How to use checksums
331d64c9fd5b4735e71f613a0149b5b0f83cf7e9296a21d79748b37f8108bf94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

Release files / yedis-2.10.6.0-py2.py3-none-any.whl

Download URL yedis-2.10.6.0-py2.py3-none-any.whl
Size 138.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d1a552ab5e2c49c6b0461b35ceb767d0a92b2401db7a9d2b25a8200737069a84
BLAKE2b-256 checksum
How to use checksums
bc00d966014ea4772ea702b12d377290f525892a0489efea873e6530929ae0e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

Release files / yedis-2.10.6.0-py2.7.egg

Download URL yedis-2.10.6.0-py2.7.egg
Size 331.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
7fddc15e412a7e0a02e7017b95dc87b6dffae4cb1c9df34093c800f1e6f0a91f
BLAKE2b-256 checksum
How to use checksums
1f1192233cef60df3d3306d4405c8241ae5a8d668d9cf9b1555c70021678ddbb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

Release history Release notifications | RSS feed

This release

2.10.6.0 This release

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page