========
**deai**
========

deai is an event-driven automation engine that enables you to control your system with simple scripts.

Getting Started
===============

To start, some :doc:`basic concepts <basic_concepts>` could help you understand how to interact with the interfaces provided by deai. After you have written your script, a look at the :doc:`command line interface <how_to_run>` will tell you how you would run them.

.. toctree::
   :hidden:
   :caption: Getting Started

   basic_concepts
   how_to_run


References
==========

:doc:`Here <generated/modules>` is a detailed reference about all the modules and methods provided by deai.

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: References

   generated/modules
   generated/types

Writing a Plugin for deai
=========================

This section is still working in progress.