Home
====

.. toctree::
   :maxdepth: 2
   :caption: Contents:

rlock.api
=========
Interact with the RedLock API at `Learn more at redlock.io <https://redlock.io>`_

View code at: https://github.com/cloudcraeft/rlock

Installation:
``pip install rlock``

Client
======
.. autoclass:: rlock.api.Client
   :members:

Policies
========
.. autoclass:: rlock.api.Policies
   :members:
   :inherited-members:

Policy
======
.. autoclass:: rlock.api.Policy
   :members:
   :inherited-members:

Criteria
========
.. autoclass:: rlock.api.Criteria
   :members:
   :inherited-members:

Criterion
=========
.. autoclass:: rlock.api.Criterion
   :members:
   :inherited-members:

Alerts
======
.. autoclass:: rlock.api.Alerts
   :members:
   :inherited-members:

Alert
=====
.. autoclass:: rlock.api.Alert
   :members:
   :inherited-members:


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

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