DEPRECATED
Go to file
Gavin M. Roy e26b1efa25 Update README.rst 2016-11-03 10:19:11 -04:00
docs Major release for backwards incompatibilty 2015-06-22 17:51:52 -04:00
sprockets Extend the StrictRedis class instead of wrapping it 2015-06-22 17:47:56 -04:00
.editorconfig Initial commit 2015-03-26 17:41:18 -04:00
.gitignore Initial commit 2015-03-26 17:41:18 -04:00
.travis.yml Try to fix travis again 2015-05-18 15:15:22 -04:00
LICENSE Initial commit 2015-03-26 17:41:18 -04:00
MANIFEST.in Initial commit 2015-03-26 17:41:18 -04:00
README.rst Update README.rst 2016-11-03 10:19:11 -04:00
dev-requirements.txt clients.redis: Add sismember & smembers 2015-05-18 13:51:32 -04:00
requirements.txt Drop Python 2.6 support 2015-03-26 18:13:27 -04:00
setup.cfg Initial commit 2015-03-26 17:41:18 -04:00
setup.py Major release for backwards incompatibilty 2015-06-22 17:51:52 -04:00
test-requirements.txt Initial commit 2015-03-26 17:41:18 -04:00
tests.py Extend the StrictRedis class instead of wrapping it 2015-06-22 17:47:56 -04:00

README.rst

sprockets.clients.redis
=======================

DEEPRECATED - DO NOT USE

Base functionality for accessing/modifying data in Redis.  Currently
there is only support for interacting with Redis servers in a sharded
manner.

That is to say, there are multiple Redis servers we are distributing reads
and writes among them based on a consistent hash of the key value we're
operating on.  This is also known as "Client Side Partitioning".

More information about setting up or managing Redis in this manner
can be found on the Redis documentation website: http://redis.io/topics/partitioning

|Version| |Downloads| |Status| |Coverage| |License|

Installation
------------
``sprockets.clients.redis`` is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.clients.redis>`_
and can be installed via ``pip`` or ``easy_install``:

.. code:: bash

  pip install sprockets.clients.redis

Documentation
-------------
http://sprockets-clients-redis.readthedocs.org/en/latest/

Requirements
------------
.. include:: requirements.txt

Example
-------
This examples demonstrates how to use a sharded Redis connection
in ``sprockets.clients.redis`` by ...

.. code:: python

    import os
    from sprockets import clients.redis

    os.environ['REDIS_URI'] = 'redis://localhost/'

    shard = clients.redis.ShardedRedisConnection()

    shard.set('foo', 1)
    value = shard.get('foo')
    shard.delete('foo')


Version History
---------------
Available at http://sprockets-clients-redis.readthedocs.org/en/latest/history.html

.. |Version| image:: https://badge.fury.io/py/sprockets.clients.redis.svg?
   :target: http://badge.fury.io/py/sprockets.clients.redis

.. |Status| image:: https://travis-ci.org/sprockets/sprockets.clients.redis.svg?branch=master
   :target: https://travis-ci.org/sprockets/sprockets.clients.redis

.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.clients.redis.svg?
   :target: https://coveralls.io/r/sprockets/sprockets.clients.redis

.. |Downloads| image:: https://pypip.in/d/sprockets.clients.redis/badge.svg?
   :target: https://pypi.python.org/pypi/sprockets.clients.redis

.. |License| image:: https://pypip.in/license/sprockets.clients.redis/badge.svg?
   :target: http://sprockets-clients-redis.readthedocs.org/en/latest/