Rougail

Todo

définir les termes suivants

1 check.rst:9: WARNING: term not in glossary: ‘validator’ 2 check.rst:56: WARNING: term not in glossary: ‘follower’ 3 configuration.rst:43: WARNING: term not in glossary: ‘multiple’ 4 family.rst:25: WARNING: label non défini: ‘convention on variable names’ 5 structfile.rst:89: WARNING: term not in glossary: ‘variable_namespace’ 6 tutorial/tutorial.rst:437: WARNING: term not in glossary: ‘leadership’ 7 tutorial/tutorial.rst:546: WARNING: term not in glossary: ‘leader’ 8 tutorial/tutorial.rst:547: WARNING: term not in glossary: ‘follower’ 9 variable.rst:38: WARNING: label non défini: ‘convention on variable names’

10 variable.rst:137: WARNING: term not in glossary: ‘leading’ 11 variable.rst:154: WARNING: term not in glossary: ‘required’ 12 variable.rst:156: WARNING: term not in glossary: ‘leader’ 13 variable.rst:156: WARNING: term not in glossary: ‘follower’ 14 variable.rst:186: WARNING: term not in glossary: ‘multiple’ 15 variable.rst:186: WARNING: term not in glossary: ‘multiple’

• 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
  • Calculated default value for a variable
  • Define access to variable or family
  • A dynamically built family
  • Playing with Jinja
  • Custom 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

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