Metadata-Version: 2.4
Name: rougail.user_data_yaml
Version: 1.0.0
Summary: Rougail user_data yaml
Author-email: Emmanuel Garette <gnunux@gnunux.info>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Natural Language :: French
License-File: LICENSE
Requires-Dist: rougail-base >= 1.2.0,<2
Requires-Dist: ruamel.yaml ~= 0.19.1
Project-URL: Home, https://forge.cloud.silique.fr/stove/rougail-user-data-yaml

---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)

## Charge user data from YAML file

> [!NOTE]
> 
> **Path**: yaml\
> *`disabled`*\
> **Disabled**: if yaml is not set in "[Select for user datas](#step.user_data)"

| Variable                                                                                                                                                                                             | Description                                                                                                                                                                   | Default value   | Type                                                                                                             | Validator                                                                                                                                        |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="yaml.filename" name="yaml.filename">yaml.filename</a>**<br/>**Command line**: <br/>-yf, --yaml.filename<br/>**Environment variable**: YAML.FILENAME                                         | File or directory names where user data are stored.<br/>If a directory is set, all files with &quot;yml&quot; ou &quot;yaml&quot; extension will be load with alphanum order. |                 | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `unique`<br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;this file must exist<br/>•&nbsp;file type allowed: "directory" and "file". |
| **<a id="yaml.file_with_secrets" name="yaml.file_with_secrets">yaml.file_with_secrets</a>**<br/>**Command line**: <br/>--yaml.file_with_secrets<br/>**Environment variable**: YAML.FILE_WITH_SECRETS | File that may contain secrets.<br/>By default, all files can contain secrets. It might be useful to define more precisely which files can contain these secrets.              | all             | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                   | **Choices**: <br/>•&nbsp;all<br/>•&nbsp;first<br/>•&nbsp;last<br/>•&nbsp;none                                                                    |



