From e99a066894f8801a4b7872d2c984d5994bed0f41 Mon Sep 17 00:00:00 2001 From: viennet Date: Sun, 13 Feb 2022 15:16:39 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20liste=20commandes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/GuideConfig.md | 64 ++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/GuideConfig.md b/docs/GuideConfig.md index 7eee76d1..42fb3697 100644 --- a/docs/GuideConfig.md +++ b/docs/GuideConfig.md @@ -131,12 +131,17 @@ Exemple: ## Liste des commandes Flask/ScoDoc ``` +Usage: app [OPTIONS] COMMAND [ARGS]... + +Options: + --help Show this message and exit. + Commands: clear-cache Clear ScoDoc cache This cache (currently... create-dept Create new departement create-role Create a new role - delete-role Delete a role delete-dept Delete existing departement + delete-role Delete a role dumphelp edit-role Add [-a] and/or remove [-r] a permission... import-scodoc7-dept Import département ScoDoc 7: dept:... @@ -151,7 +156,8 @@ Commands: scodoc-database print the database connexion string user-create Create a new user user-db-clear Erase all users and roles from the... - user-password Set (or change) user's password + user-delete Try to delete this user. + user-password Set (or change) user’s password user-role Add or remove a role to the given user... Usage: app sco-db-init [OPTIONS] @@ -161,14 +167,12 @@ Usage: app sco-db-init [OPTIONS] Options: --erase / --no-erase - --help Show this message and exit. Usage: app user-db-clear [OPTIONS] Erase all users and roles from the database ! -Options: - --help Show this message and exit. + Usage: app user-create [OPTIONS] USERNAME ROLE DEPT @@ -177,22 +181,23 @@ Usage: app user-create [OPTIONS] USERNAME ROLE DEPT Options: -n, --nom TEXT -p, --prenom TEXT - --help Show this message and exit. + +Usage: app user-delete [OPTIONS] USERNAME + + Try to delete this user. Fails if it’s associated to some scodoc objects. + Usage: app user-password [OPTIONS] USERNAME - Set (or change) user's password + Set (or change) user’s password Options: --password TEXT - --help Show this message and exit. Usage: app create-role [OPTIONS] ROLENAME [PERMISSIONS]... Create a new role -Options: - --help Show this message and exit. Usage: app edit-role [OPTIONS] ROLENAME @@ -205,7 +210,13 @@ Usage: app edit-role [OPTIONS] ROLENAME Options: -a, --add TEXT -r, --remove TEXT - --help Show this message and exit. + +Usage: app delete-role [OPTIONS] ROLENAME + + Delete a role + +Options: + --help Show this message and exit. Usage: app user-role [OPTIONS] USERNAME @@ -222,22 +233,20 @@ Usage: app delete-dept [OPTIONS] DEPT Delete existing departement Options: + --yes --help Show this message and exit. Usage: app create-dept [OPTIONS] DEPT Create new departement -Options: - --help Show this message and exit. Usage: app list-depts [OPTIONS] [DEPTS]... If dept exists, print it, else nothing. Called without arguments, list all depts along with their ids. -Options: - --help Show this message and exit. + Usage: app scodoc-database [OPTIONS] @@ -246,7 +255,7 @@ Usage: app scodoc-database [OPTIONS] Options: -n, --name show database name instead of connexion string (required for dropdb/createdb commands) - --help Show this message and exit. + Usage: app import-scodoc7-users [OPTIONS] @@ -255,54 +264,43 @@ Usage: app import-scodoc7-users [OPTIONS] script is typically run as unix user "scodoc". The original SCOUSERS database is left unmodified. -Options: - --help Show this message and exit. Usage: app import-scodoc7-dept [OPTIONS] DEPT DEPT_DB_NAME Import département ScoDoc 7: dept: InfoComm, dept_db_name: SCOINFOCOMM -Options: - --help Show this message and exit. Usage: app migrate-scodoc7-dept-archives [OPTIONS] [DEPT] Post-migration: renomme les archives en fonction des id de ScoDoc 9 -Options: - --help Show this message and exit. Usage: app migrate-scodoc7-dept-logos [OPTIONS] [DEPT] Post-migration: renomme les logos en fonction des id / dept de ScoDoc 9 -Options: - --help Show this message and exit. Usage: app localize-logo [OPTIONS] LOGO DEPT Make local to a dept a global logo (both logo and dept names are mandatory) -Options: - --help Show this message and exit. Usage: app photos-import-files [OPTIONS] FORMSEMESTRE_ID XLSFILE ZIPFILE -Options: - --help Show this message and exit. + Import des photos d’étudiants à partir d’une liste excel et d’un zip avec les images. Usage: app clear-cache [OPTIONS] Clear ScoDoc cache This cache (currently Redis) is persistent between - invocation and it may be necessary to clear it during development or tests. + invocation and it may be necessary to clear it during upgrades, development + or tests. Options: - --help Show this message and exit. + --sanitize / --no-sanitize Usage: app dumphelp [OPTIONS] -Options: - --help Show this message and exit. + Génère la page d’aide complète pour la doc. Usage: app profile [OPTIONS] @@ -316,6 +314,8 @@ Options: --help Show this message and exit. ``` +(*la liste ci-dessus est générée à l'aide de la commande* `flask dumphelp`). + ## Changement des logos apparaissant sur les documents *Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*.