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

Project details


Download files

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

Source Distribution

yedis-2.10.6.0.tar.gz (79.0 kB view details)

Uploaded Source

Built Distributions

yedis-2.10.6.0-py2.py3-none-any.whl (138.4 kB view details)

Uploaded Python 2 Python 3

yedis-2.10.6.0-py2.7.egg (331.6 kB view details)

Uploaded Source

File details

Details for the file yedis-2.10.6.0.tar.gz.

File metadata

  • Download URL: yedis-2.10.6.0.tar.gz
  • Upload date:
  • Size: 79.0 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for yedis-2.10.6.0.tar.gz
Algorithm Hash digest
SHA256 2b52a64ed998e7a0fd6572989834285d7348916c96e3425502767aff5fa93a77
MD5 599b54ece2e8a0e5337d8058da666fc3
BLAKE2b-256 331d64c9fd5b4735e71f613a0149b5b0f83cf7e9296a21d79748b37f8108bf94

See more details on using hashes here.

File details

Details for the file yedis-2.10.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: yedis-2.10.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 138.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for yedis-2.10.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d1a552ab5e2c49c6b0461b35ceb767d0a92b2401db7a9d2b25a8200737069a84
MD5 2a8427f27ef9c82b262380583f120811
BLAKE2b-256 bc00d966014ea4772ea702b12d377290f525892a0489efea873e6530929ae0e5

See more details on using hashes here.

File details

Details for the file yedis-2.10.6.0-py2.7.egg.

File metadata

  • Download URL: yedis-2.10.6.0-py2.7.egg
  • Upload date:
  • Size: 331.6 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for yedis-2.10.6.0-py2.7.egg
Algorithm Hash digest
SHA256 7fddc15e412a7e0a02e7017b95dc87b6dffae4cb1c9df34093c800f1e6f0a91f
MD5 49d0b1d501539331ce6f35c3dfec7ddf
BLAKE2b-256 1f1192233cef60df3d3306d4405c8241ae5a8d668d9cf9b1555c70021678ddbb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page