Rougail

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’

• is a delicious cooked dish from the Mauritius and Reunion Islands,

• it is also a Python library which enables us to conveniently load application variables in a simple YAML format in such a way that the end user consumer can handle them consistently (that is, against an user-defined consistency).

What is it all about

• Abstract presentation
• Tutorial with a real world sample
  • Getting started
  • A variable with possible values
  • Group variables inside families
  • Some suitable types
  • The disabled property
  • The hidden property
  • A dynamic family
  • Calculation with a jinja type

The structured files

• The structure files
• File naming convention

The variables

• The variables
• The families
• The variable tags
• Calculated default values
• Value checks
• Calculated properties

Load values from user datas

• Rougail’s user datas description
  • Load user datas from a YAML file
  • Load user datas from a environment variable
  • Load user datas from commandline parser
  • Load user datas from Bitwarden server
  • Load user datas from a command line interface
• Customizing Rougail’s configuration

The library

• Rougail’s library description
  • Load user datas
  • Display the result
  • Retrieve all variables and families
  • Use tag informations
  • Load Rougail configuration from Rougail command line informations
  • Let’s convert an extra namespace structural file
  • Let’s create a custom function
  • Create your own type
  • Upgrade dictionnaries to upper version
• Customizing Rougail’s configuration

Notes

• Developer notes
• Documentation standards

Index page

• Index