Mise à jour liste commandes

This commit is contained in:
Emmanuel Viennet 2022-02-13 15:16:39 +01:00
parent d7bbb11113
commit e99a066894

View File

@ -131,12 +131,17 @@ Exemple:
## Liste des commandes Flask/ScoDoc ## Liste des commandes Flask/ScoDoc
``` ```
Usage: app [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands: Commands:
clear-cache Clear ScoDoc cache This cache (currently... clear-cache Clear ScoDoc cache This cache (currently...
create-dept Create new departement create-dept Create new departement
create-role Create a new role create-role Create a new role
delete-role Delete a role
delete-dept Delete existing departement delete-dept Delete existing departement
delete-role Delete a role
dumphelp dumphelp
edit-role Add [-a] and/or remove [-r] a permission... edit-role Add [-a] and/or remove [-r] a permission...
import-scodoc7-dept Import département ScoDoc 7: dept:... import-scodoc7-dept Import département ScoDoc 7: dept:...
@ -151,7 +156,8 @@ Commands:
scodoc-database print the database connexion string scodoc-database print the database connexion string
user-create Create a new user user-create Create a new user
user-db-clear Erase all users and roles from the... 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) users password
user-role Add or remove a role to the given user... user-role Add or remove a role to the given user...
Usage: app sco-db-init [OPTIONS] Usage: app sco-db-init [OPTIONS]
@ -161,14 +167,12 @@ Usage: app sco-db-init [OPTIONS]
Options: Options:
--erase / --no-erase --erase / --no-erase
--help Show this message and exit.
Usage: app user-db-clear [OPTIONS] Usage: app user-db-clear [OPTIONS]
Erase all users and roles from the database ! Erase all users and roles from the database !
Options:
--help Show this message and exit.
Usage: app user-create [OPTIONS] USERNAME ROLE DEPT Usage: app user-create [OPTIONS] USERNAME ROLE DEPT
@ -177,22 +181,23 @@ Usage: app user-create [OPTIONS] USERNAME ROLE DEPT
Options: Options:
-n, --nom TEXT -n, --nom TEXT
-p, --prenom TEXT -p, --prenom TEXT
--help Show this message and exit.
Usage: app user-delete [OPTIONS] USERNAME
Try to delete this user. Fails if its associated to some scodoc objects.
Usage: app user-password [OPTIONS] USERNAME Usage: app user-password [OPTIONS] USERNAME
Set (or change) user's password Set (or change) users password
Options: Options:
--password TEXT --password TEXT
--help Show this message and exit.
Usage: app create-role [OPTIONS] ROLENAME [PERMISSIONS]... Usage: app create-role [OPTIONS] ROLENAME [PERMISSIONS]...
Create a new role Create a new role
Options:
--help Show this message and exit.
Usage: app edit-role [OPTIONS] ROLENAME Usage: app edit-role [OPTIONS] ROLENAME
@ -205,7 +210,13 @@ Usage: app edit-role [OPTIONS] ROLENAME
Options: Options:
-a, --add TEXT -a, --add TEXT
-r, --remove 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 Usage: app user-role [OPTIONS] USERNAME
@ -222,22 +233,20 @@ Usage: app delete-dept [OPTIONS] DEPT
Delete existing departement Delete existing departement
Options: Options:
--yes
--help Show this message and exit. --help Show this message and exit.
Usage: app create-dept [OPTIONS] DEPT Usage: app create-dept [OPTIONS] DEPT
Create new departement Create new departement
Options:
--help Show this message and exit.
Usage: app list-depts [OPTIONS] [DEPTS]... Usage: app list-depts [OPTIONS] [DEPTS]...
If dept exists, print it, else nothing. Called without arguments, list all If dept exists, print it, else nothing. Called without arguments, list all
depts along with their ids. depts along with their ids.
Options:
--help Show this message and exit.
Usage: app scodoc-database [OPTIONS] Usage: app scodoc-database [OPTIONS]
@ -246,7 +255,7 @@ Usage: app scodoc-database [OPTIONS]
Options: Options:
-n, --name show database name instead of connexion string (required for -n, --name show database name instead of connexion string (required for
dropdb/createdb commands) dropdb/createdb commands)
--help Show this message and exit.
Usage: app import-scodoc7-users [OPTIONS] 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 script is typically run as unix user "scodoc". The original SCOUSERS
database is left unmodified. database is left unmodified.
Options:
--help Show this message and exit.
Usage: app import-scodoc7-dept [OPTIONS] DEPT DEPT_DB_NAME Usage: app import-scodoc7-dept [OPTIONS] DEPT DEPT_DB_NAME
Import département ScoDoc 7: dept: InfoComm, dept_db_name: SCOINFOCOMM 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] Usage: app migrate-scodoc7-dept-archives [OPTIONS] [DEPT]
Post-migration: renomme les archives en fonction des id de ScoDoc 9 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] Usage: app migrate-scodoc7-dept-logos [OPTIONS] [DEPT]
Post-migration: renomme les logos en fonction des id / dept de ScoDoc 9 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 Usage: app localize-logo [OPTIONS] LOGO DEPT
Make local to a dept a global logo (both logo and dept names are mandatory) 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 Usage: app photos-import-files [OPTIONS] FORMSEMESTRE_ID XLSFILE ZIPFILE
Options: Import des photos détudiants à partir dune liste excel et dun zip avec les images.
--help Show this message and exit.
Usage: app clear-cache [OPTIONS] Usage: app clear-cache [OPTIONS]
Clear ScoDoc cache This cache (currently Redis) is persistent between 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: Options:
--help Show this message and exit. --sanitize / --no-sanitize
Usage: app dumphelp [OPTIONS] Usage: app dumphelp [OPTIONS]
Options: Génère la page daide complète pour la doc.
--help Show this message and exit.
Usage: app profile [OPTIONS] Usage: app profile [OPTIONS]
@ -316,6 +314,8 @@ Options:
--help Show this message and exit. --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 ## Changement des logos apparaissant sur les documents
*Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*. *Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*.