######################
ICOstate Documentation
######################

*******
Purpose
*******

The ICOstate package contains a stateful application programming interface (API) for the `ICOtronic system`_. The main intention of this interface is to build an abstraction layer geared towards the usage in web APIs/applications. For other purposes we recommend you use the `ICOtronic Python package`_, which is also the basis for this library.

.. _ICOtronic system: https://www.mytoolit.com/icotronic/
.. _ICOtronic Python package: https://icotronic.readthedocs.io

************
Requirements
************

- `Python 3`_

.. _Python 3: https://www.python.org

*******
Install
*******

.. code-block:: shell

   pip install icostate

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

   usage
   api
   development