sprockets.clients.memcached/docs/index.rst

sprockets.clients.memcached
===========================
Memcached client wrapper that is configured via environment variables

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

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

.. code:: bash

   pip install sprockets.clients.memcached

Requirements
------------
-  `python-memcached <https://pypi.python.org/pypi/python-memcached>`_

API Documentation
-----------------
.. toctree::
   :maxdepth: 2

   api
   examples
   history

Version History
---------------
See :doc:`history`

Issues
------
Please report any issues to the Github project at `https://github.com/sprockets/sprockets.clients.memcached/issues <https://github.com/sprockets/sprockets.clients.memcached/issues>`_

Source
------
``sprockets.clients.memcached`` source is available on Github at `https://github.com/sprockets/sprockets.clients.memcached <https://github.com/sprockets/sprockets.clients.memcached>`_

License
-------
``sprockets.clients.memcached`` is released under the `3-Clause BSD license <https://github.com/sprockets/sprockets.clients.memcached/blob/master/LICENSE>`_.

Indices and tables
------------------

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

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

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

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

.. |License| image:: https://img.shields.io/github/license/sprockets/sprockets.clients.memcached.svg
   :target: https://sprocketsclientsmemcached.readthedocs.io