Skip to content

Latest commit

 

History

History
60 lines (31 loc) · 1.9 KB

README.md

File metadata and controls

60 lines (31 loc) · 1.9 KB

redis-py-cluster

This client provides a client for redis cluster that was added in redis 3.0.

This project is a port of redis-rb-cluster by antirez, with alot of added functionality. The original source can be found at https://github.com/antirez/redis-rb-cluster

Gitter chat room: Gitter

Build Status Coverage Status PyPI version

Documentation

All documentation can be found at http://redis-py-cluster.readthedocs.org/en/master

This Readme contains a reduced version of the full documentation.

Upgrading instructions between each released version can be found docs/upgrading.rst

Installation

Latest stable release from pypi

$ pip install redis-py-cluster

Usage example

Small sample script that shows how to get started with RedisCluster. It can also be found in examples/basic.py

>>> from rediscluster import StrictRedisCluster

>>> # Requires at least one node for cluster discovery. Multiple nodes is recommended.
>>> startup_nodes = [{"host": "127.0.0.1", "port": "7000"}]

>>> # Note: decode_responses must be set to True when used with python3
>>> rc = StrictRedisCluster(startup_nodes=startup_nodes, decode_responses=True)

>>> rc.set("foo", "bar")
True
>>> print(rc.get("foo"))
'bar'

License & Authors

Copyright (c) 2013-2016 Johan Andersson

MIT (See docs/License.txt file)

The license should be the same as redis-py (https://github.com/andymccurdy/redis-py)