.. meta::
   :description: Rougail python library home page
   :keywords: python, Rougail, Tiramisu
   :http-equiv=Pragma: no-cache

.. title:: Rougail

Rougail
===========

.. todolist::


.. todo:: définir les termes suivants

    family.rst:25: WARNING: label non défini: 'convention on variable names'
    /family.rst:114: WARNING: term not in glossary: 'calculation'
    /variable.rst:39: WARNING: label non défini: 'convention on variable names'
    /variable.rst:83: WARNING: term not in glossary: 'leading'
    /variable.rst:100: WARNING: term not in glossary: 'required'
    /variable.rst:102: WARNING: term not in glossary: 'leader'
    /variable.rst:102: WARNING: term not in glossary: 'follower'
    /variable.rst:126: WARNING: term not in glossary: 'multiple'
    /variable.rst:126: WARNING: term not in glossary: 'multiple'
    /variable.rst:131: WARNING: term not in glossary: 'calculation'
    /variable.rst:143: WARNING: term not in glossary: 'calculation'
    /variable.rst:148: WARNING: term not in glossary: 'calculation'
    /variable.rst:153: WARNING: term not in glossary: 'calculation'
    /dictionary.rst:9: WARNING: term not in glossary: 'templates'
    /dictionary.rst:19: WARNING: term not in glossary: 'redefine'
    /dictionary.rst:24: WARNING: term not in glossary: 'variable_namespace'


.. image:: images/logo.png

- is a `delicious cooked dish <https://fr.wikipedia.org/wiki/Rougail>`_ from the Mauritius  and Reunion Islands,

- it is also a `Python <https://www.python.org/>`_ library  which enables us to conveniently load application :term:`variable`\ s in a simple `YAML <https://yaml.org/>`_ format in such a way that the end user consumer can handle them consistently (that is, against an user-defined consistency).

In other words, using Rougail in your application or your python libraries can tansform end user consumer defined consistency rules into highly consistent business objects.

We then have to say that the handling system used to ensure the variables integrity is another python library, called :term:`Tiramisu`. Rougail is currently strongly affiliated with Tiramisu.

.. note:: Rougail is currently intended to work in coordination with :term:`Tiramisu` and **is not** intended to be connected with any other consistency handling system.

Explained differently, Rougail allows you to easily implement an integration of the powerful tiramisu consistency handling system.

.. toctree::
   :titlesonly:
   :caption: Getting started

   gettingstarted
   tutorial/index

.. toctree::
   :titlesonly:
   :caption: The dictionaries

   dictionary
   dict_convention

.. toctree::
   :titlesonly:
   :caption: The variables

   variable
   family
   fill
   Value checks <check>
   condition

.. toctree::
   :titlesonly:
   :caption: The library

   library
   configuration

.. toctree::
   :titlesonly:
   :caption: Notes

   developer

.. rubric:: Index page

- :ref:`genindex`
