consulate
=========
Consulate is a Python client library and set of application for the Consul
service discovery and configuration system.

|Version| |Downloads| |License|

Installation
------------
consulate may be installed via the Python package index with the tool of
your choice. I prefer pip:

.. code:: bash

    pip install consulate

Requirements
------------
- requests

API Documentation
-----------------

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

   consul
   acl
   agent
   catalog
   events
   health
   kv
   session
   status


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

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

Source
------
consulate source is available on Github at `https://github.com/gmr/consulate <https://github.com/gmr/consulate>`_

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

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

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


.. |Version| image:: https://img.shields.io/pypi/v/consulate.svg?
   :target: http://badge.fury.io/py/consulate

.. |Downloads| image:: https://img.shields.io/pypi/dm/consulate.svg?
   :target: https://pypi.python.org/pypi/consulate

.. |License| image:: https://img.shields.io/pypi/l/consulate.svg?
   :target: https://consulate.readthedocs.org