.. walrus documentation master file, created by
   sphinx-quickstart on Sun Jan  4 00:39:19 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: http://media.charlesleifer.com/blog/photos/walrus-logo-0.png

.. py:module:: walrus

Lightweight Python utilities for working with `Redis <http://redis.io>`_.

The purpose of `walrus <https://github.com/coleifer/walrus>`_ is to make working with Redis in Python a little easier by wrapping rich objects in Pythonic containers. walrus consists of:

* Containers for the Redis object types :py:class:`Hash`, :py:class:`List`, :py:class:`Set`, :py:class:`ZSet`, :py:class:`HyperLogLog` as well as a custom :py:class:`Array` type.
* :py:class:`Cache` implementation that exposes several decorators for caching function calls.
* :py:class:`Lock` implementation that can also be used as a context manager or decorator.
* :py:class:`Model` layer that support persisting structured information and performing queries using secondary indexes.

Contents:

.. toctree::
   :maxdepth: 2
   :glob:

   installation
   getting-started
   containers
   autocomplete
   cache
   graph
   rate-limit
   models
   api
   alt-backends
   contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. walrus documentation master file, created by
   sphinx-quickstart on Sun Jan  4 00:39:19 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: http://media.charlesleifer.com/blog/photos/walrus-logo-0.png

.. py:module:: walrus

Python utilities for working with `Redis <http://redis.io>`_:

* container classes
* autocomplete
* cache
* graph store
* rate limiting
* active-record models (secondary indexes, full-text search)
* locks
* more? more!

My hope is that walrus saves you time developing your application by providing
useful Redis-specific components. If you have an idea for a new feature, please
don't hesitate to `tell me about it <https://github.com/coleifer/walrus/issues/new>`_.

Contents:

.. toctree::
   :maxdepth: 2
   :glob:

   installation
   getting-started
   containers
   autocomplete
   cache
   graph
   rate-limit
   models
   api
   alt-backends
   contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Update docs to try and trick sphinx.
Update docs to try and trick sphinx.
