stove/rougail-user-data-questionary
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity

fix: update doc

Browse source
This commit is contained in:
egarette@silique.fr 2025-11-27 21:50:52 +01:00
parent a71b476307
commit b10a45cd37
6 changed files with 52 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,2 +1,19 @@
# rougail-user-data-questionary ---
gitea: none
include_toc: true
---
## Define user data interactively in the console
> **🛈 Informations**
>
> **<a id="questionary" name="questionary">questionary</a>**\
> The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.\
> *`disabled`*\
> **Disabled**: if questionary is not set in "[Select for user datas](#step.user_data)"
| Variable | Description | Default value | Type |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Command line**: <br/>•&nbsp;-qm, --questionary.mandatory<br/>•&nbsp;-nqm, --questionary.no-mandatory<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.MANDATORY | Ask values only for mandatories variables without any value. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Command line**: <br/>•&nbsp;-qs, --questionary.show_secrets<br/>•&nbsp;-nqs, --questionary.no-show_secrets<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.SHOW_SECRETS | Show secrets instead of obscuring them. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |

30
locale/fr/LC_MESSAGES/rougail_user_data_questionary.po
View file

@ -5,8 +5,8 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: \n" "Project-Id-Version: \n"
"POT-Creation-Date: 2025-11-26 20:48+0100\n" "POT-Creation-Date: 2025-11-27 21:49+0100\n"
"PO-Revision-Date: 2025-11-26 20:48+0100\n" "PO-Revision-Date: 2025-11-27 21:49+0100\n"
"Last-Translator: \n" "Last-Translator: \n"
"Language-Team: \n" "Language-Team: \n"
"Language: fr\n" "Language: fr\n"
@ -17,25 +17,29 @@ msgstr ""
"X-Generator: Poedit 3.8\n" "X-Generator: Poedit 3.8\n"
#: src/rougail/user_data_questionary/config.py:32 #: src/rougail/user_data_questionary/config.py:32
msgid "Define values interactivly" msgid "Define user datas interactivly"
msgstr "Définir des valeurs interactivement" msgstr "Définir des données utilisateur interactivement"
#: src/rougail/user_data_questionary/config.py:40 #: src/rougail/user_data_questionary/config.py:38
msgid "when questionary is not set in \"step.user_data\""
msgstr "lorsque questionary n'est pas mis dans step.user_data"
#: src/rougail/user_data_questionary/config.py:41
msgid "Ask values only for mandatories variables without any value" msgid "Ask values only for mandatories variables without any value"
msgstr "Demander des valeurs uniquement pour des variables obligatoires sans valeur" msgstr "Demander des valeurs uniquement pour des variables obligatoires sans valeur"
#: src/rougail/user_data_questionary/config.py:45 #: src/rougail/user_data_questionary/config.py:46
msgid "Show secrets instead of obscuring them" msgid "Show secrets instead of obscuring them"
msgstr "Afficher les secrets plutôt que des obscurcir" msgstr "Afficher les secrets plutôt que de les obscurcir"
#: src/rougail/user_data_questionary/data.py:59 #: src/rougail/user_data_questionary/data.py:61
msgid "questionary is not set in step.user_data" msgid "questionary is not set in step.user_data"
msgstr "questionary n'est pas mis dans step.user_data" msgstr "questionary n'est pas mis dans step.user_data"
#: src/rougail/user_data_questionary/data.py:226 #: src/rougail/user_data_questionary/data.py:229
msgid "Value must not be empty"
msgstr "La valeur ne doit pas être vide"
#: src/rougail/user_data_questionary/data.py:235
msgid "Not a valid {0}" msgid "Not a valid {0}"
msgstr "N'est pas un valide {0}" msgstr "N'est pas un valide {0}"
#: src/rougail/user_data_questionary/data.py:250
msgid "Value must not be empty"
msgstr "La valeur ne doit pas être vide"

24
locale/rougail_user_data_questionary.pot
View file

@ -5,7 +5,7 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-11-26 20:48+0100\n" "POT-Creation-Date: 2025-11-27 21:50+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -16,26 +16,30 @@ msgstr ""
#: src/rougail/user_data_questionary/config.py:32 #: src/rougail/user_data_questionary/config.py:32
msgid "Define values interactivly" msgid "Define user datas interactivly"
msgstr "" msgstr ""
#: src/rougail/user_data_questionary/config.py:40 #: src/rougail/user_data_questionary/config.py:38
msgid "when questionary is not set in \"step.user_data\""
msgstr ""
#: src/rougail/user_data_questionary/config.py:41
msgid "Ask values only for mandatories variables without any value" msgid "Ask values only for mandatories variables without any value"
msgstr "" msgstr ""
#: src/rougail/user_data_questionary/config.py:45 #: src/rougail/user_data_questionary/config.py:46
msgid "Show secrets instead of obscuring them" msgid "Show secrets instead of obscuring them"
msgstr "" msgstr ""
#: src/rougail/user_data_questionary/data.py:59 #: src/rougail/user_data_questionary/data.py:61
msgid "questionary is not set in step.user_data" msgid "questionary is not set in step.user_data"
msgstr "" msgstr ""
#: src/rougail/user_data_questionary/data.py:226 #: src/rougail/user_data_questionary/data.py:229
msgid "Value must not be empty"
msgstr ""
#: src/rougail/user_data_questionary/data.py:235
msgid "Not a valid {0}" msgid "Not a valid {0}"
msgstr "" msgstr ""
#: src/rougail/user_data_questionary/data.py:250
msgid "Value must not be empty"
msgstr ""

3
src/rougail/user_data_questionary/config.py
View file

@ -29,12 +29,13 @@ def get_rougail_config(
"""generate rougail config""" """generate rougail config"""
options = f""" options = f"""
questionary: questionary:
description: {_("Define values interactivly")} description: {_("Define user datas interactivly")}
disabled: disabled:
jinja: | jinja: |
{{% if step.user_data is not propertyerror and 'questionary' not in step.user_data %}} {{% if step.user_data is not propertyerror and 'questionary' not in step.user_data %}}
disabled disabled
{{% endif %}} {{% endif %}}
description: {_('when questionary is not set in "step.user_data"')}
mandatory: mandatory:
description: {_("Ask values only for mandatories variables without any value")} description: {_("Ask values only for mandatories variables without any value")}

2
src/rougail/user_data_questionary/data.py
View file

@ -177,7 +177,7 @@ class RougailUserDataQuestionary:
return text return text
def _display_questionary_frozen(self, args: str, default: any) -> None: def _display_questionary_frozen(self, args: str, default: any) -> None:
qprint(" " + args + str(default)) qprint(" " + args + " " + str(default))
class RougailValidator(Validator): class RougailValidator(Validator):

BIN
src/rougail/user_data_questionary/locale/fr/LC_MESSAGES/rougail_user_data_questionary.mo
View file

Binary file not shown.