Assiduité : Nouvelles documentations #65
@ -23,8 +23,8 @@ l'association et leur permettra d'accéder aux nouvelles fonctionnalités, mise
|
|||||||
jour et support technique.
|
jour et support technique.
|
||||||
|
|
||||||
Plusieurs types d'adhésion sont possibles, voir le [bulletin d'adhésion
|
Plusieurs types d'adhésion sont possibles, voir le [bulletin d'adhésion
|
||||||
PDF](papers/Adhesion-2023-2024-Association-ScoDoc.pdf) ([version
|
PDF](papers/Adhesion-2024-2025-Association-ScoDoc.pdf) ([version
|
||||||
Word](papers/Adhesion-2023-2024-Association-ScoDoc.docx)), à renvoyer à
|
Word](papers/Adhesion-2024-2025-Association-ScoDoc.docx)), à renvoyer à
|
||||||
<emmanuel.viennet@gmail.com>. (note: toutes les informations nécessaires à la
|
<emmanuel.viennet@gmail.com>. (note: toutes les informations nécessaires à la
|
||||||
"création fournisseur" sont sur le bulletin d'adhésion).
|
"création fournisseur" sont sur le bulletin d'adhésion).
|
||||||
|
|
||||||
|
@ -139,38 +139,44 @@ Exemple:
|
|||||||
|
|
||||||
### Liste des commandes Flask/ScoDoc
|
### Liste des commandes Flask/ScoDoc
|
||||||
|
|
||||||
Dans l'encart ci-dessous, `app` désigne `flask`, comme dans les exemple donnés plus haut.
|
Dans l'encart ci-dessous, `app` désigne `flask`, comme dans les exemples donnés plus haut.
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage: app [OPTIONS] COMMAND [ARGS]...
|
Usage: app [OPTIONS] COMMAND [ARGS]...
|
||||||
|
|
||||||
Options:
|
|
||||||
--help Show this message and exit.
|
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
|
anonymize-db Anonymise la base de nom indiqué (et non...
|
||||||
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-dept Delete existing departement
|
delete-dept Delete existing departement
|
||||||
delete-role Delete a role
|
delete-role Delete a role
|
||||||
dumphelp
|
downgrade-assiduites-module Supprime les assiduites et/ou les...
|
||||||
list-roles List roles
|
dumphelp Génère la page d'aide complète pour la doc.
|
||||||
edit-role Add [-a] and/or remove [-r] a permission...
|
edit-role Add [-a] and/or remove [-r] a permission...
|
||||||
|
entreprises-reset-db Remet a zéro les tables du module...
|
||||||
|
gen-api-map Génère la carte des routes de l'API.
|
||||||
|
generate-ens-calendars Génère les calendrier enseignants à...
|
||||||
import-scodoc7-dept Import département ScoDoc 7: dept:...
|
import-scodoc7-dept Import département ScoDoc 7: dept:...
|
||||||
import-scodoc7-users Import users defined in ScoDoc7...
|
import-scodoc7-users Import users defined in ScoDoc7...
|
||||||
|
init-test-database Initialise les objets en base pour les...
|
||||||
list-depts If dept exists, print it, else nothing.
|
list-depts If dept exists, print it, else nothing.
|
||||||
|
list-roles List all defined roles
|
||||||
localize-logo Make local to a dept a global logo (both...
|
localize-logo Make local to a dept a global logo (both...
|
||||||
|
migrate-abs-to-assiduites Permet de migrer les absences vers le...
|
||||||
migrate-scodoc7-dept-archives Post-migration: renomme les archives en...
|
migrate-scodoc7-dept-archives Post-migration: renomme les archives en...
|
||||||
migrate-scodoc7-dept-logos Post-migration: renomme les logos en...
|
migrate-scodoc7-dept-logos Post-migration: renomme les logos en...
|
||||||
photos-import-files
|
photos-import-files Import des photos d'étudiants à partir...
|
||||||
profile Start the application under the profiler...
|
profile Start the application under the code...
|
||||||
sco-db-init Initialize the database.
|
sco-db-init Initialize the database.
|
||||||
scodoc-database print the database connexion string
|
scodoc-database print the database connexion string
|
||||||
|
user-change-login Change user's login (user_name)
|
||||||
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-delete Try to delete this user.
|
user-delete Try to delete this user.
|
||||||
user-password Set (or change) user’s password
|
user-password Set (or change) user's password
|
||||||
user-role Display roles, or 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]
|
||||||
|
|
||||||
@ -179,12 +185,21 @@ Usage: app sco-db-init [OPTIONS]
|
|||||||
|
|
||||||
Options:
|
Options:
|
||||||
--erase / --no-erase
|
--erase / --no-erase
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app anonymize-db [OPTIONS] DATABASE
|
||||||
|
|
||||||
|
Anonymise la base de nom indiqué (et non pas la base courante!)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--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
|
||||||
|
|
||||||
@ -193,23 +208,36 @@ 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
|
Usage: app user-delete [OPTIONS] USERNAME
|
||||||
|
|
||||||
Try to delete this user. Fails if it’s associated to some scodoc objects.
|
Try to delete this user. Fails if it's associated to some scodoc objects.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app user-password [OPTIONS] USERNAME
|
Usage: app user-password [OPTIONS] USERNAME
|
||||||
|
|
||||||
Set (or change) user’s password
|
Set (or change) user's 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 list-roles [OPTIONS]
|
||||||
|
|
||||||
|
List all defined roles
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app edit-role [OPTIONS] ROLENAME
|
Usage: app edit-role [OPTIONS] ROLENAME
|
||||||
|
|
||||||
@ -217,11 +245,12 @@ Usage: app edit-role [OPTIONS] ROLENAME
|
|||||||
permissions are not associated to users but to roles. Each user has a set of
|
permissions are not associated to users but to roles. Each user has a set of
|
||||||
roles in each departement.
|
roles in each departement.
|
||||||
|
|
||||||
Example: `flask edit-role -a ScoEditApo Ens`
|
Example: `flask edit-role -a EditApogee Ens`
|
||||||
|
|
||||||
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
|
Usage: app delete-role [OPTIONS] ROLENAME
|
||||||
|
|
||||||
@ -240,25 +269,36 @@ Options:
|
|||||||
-r, --remove TEXT
|
-r, --remove TEXT
|
||||||
--help Show this message and exit.
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app user-change-login [OPTIONS] USER_NAME NEW_USER_NAME
|
||||||
|
|
||||||
|
Change user's login (user_name)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app delete-dept [OPTIONS] DEPT
|
Usage: app delete-dept [OPTIONS] DEPT
|
||||||
|
|
||||||
Delete existing departement
|
Delete existing departement
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--yes
|
-y, --yes
|
||||||
|
-f, --force ignore non-existing departement
|
||||||
--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]
|
||||||
|
|
||||||
@ -267,7 +307,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]
|
||||||
|
|
||||||
@ -276,30 +316,44 @@ 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
|
||||||
|
|
||||||
Import des photos d’étudiants à partir d’une liste excel et d’un zip avec les images.
|
Import des photos d'étudiants à partir d'une liste excel et d'un zip avec
|
||||||
|
les images.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app clear-cache [OPTIONS]
|
Usage: app clear-cache [OPTIONS]
|
||||||
|
|
||||||
@ -309,10 +363,29 @@ Usage: app clear-cache [OPTIONS]
|
|||||||
|
|
||||||
Options:
|
Options:
|
||||||
--sanitize / --no-sanitize
|
--sanitize / --no-sanitize
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app init-test-database [OPTIONS]
|
||||||
|
|
||||||
|
Initialise les objets en base pour les tests API (à appliquer sur
|
||||||
|
SCODOC_TEST ou SCODOC_DEV)
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app entreprises-reset-db [OPTIONS]
|
||||||
|
|
||||||
|
Remet a zéro les tables du module relations entreprises
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app dumphelp [OPTIONS]
|
Usage: app dumphelp [OPTIONS]
|
||||||
|
|
||||||
Génère la page d’aide complète pour la doc.
|
Génère la page d'aide complète pour la doc.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
Usage: app profile [OPTIONS]
|
Usage: app profile [OPTIONS]
|
||||||
|
|
||||||
@ -324,6 +397,45 @@ Options:
|
|||||||
--length INTEGER Number of functions to include in the profiler report.
|
--length INTEGER Number of functions to include in the profiler report.
|
||||||
--profile-dir TEXT Directory where profiler data files are saved.
|
--profile-dir TEXT Directory where profiler data files are saved.
|
||||||
--help Show this message and exit.
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app migrate-abs-to-assiduites [OPTIONS]
|
||||||
|
|
||||||
|
Permet de migrer les absences vers le nouveau module d'assiduités
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-d, --dept TEXT Restreint la migration au dept sélectionné (ACRONYME)
|
||||||
|
-m, --morning TEXT Spécifie l'heure de début des cours format `hh:mm`
|
||||||
|
-n, --noon TEXT Spécifie l'heure de fin du matin format `hh:mm`
|
||||||
|
-a, --afternoon TEXT Spécifie l'heure de début de l'après-midi format
|
||||||
|
`hh:mm` valeur identique à --noon si non spécifié
|
||||||
|
-e, --evening TEXT Spécifie l'heure de fin des cours format `hh:mm`
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app downgrade-assiduites-module [OPTIONS]
|
||||||
|
|
||||||
|
Supprime les assiduites et/ou les justificatifs de tous les départements ou
|
||||||
|
du département sélectionné
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-d, --dept TEXT Restreint la suppression au dept sélectionné (ACRONYME)
|
||||||
|
-a, --assiduites Supprime les assiduités de scodoc
|
||||||
|
-j, --justificatifs Supprime les justificatifs de scodoc
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app generate-ens-calendars [OPTIONS]
|
||||||
|
|
||||||
|
Génère les calendrier enseignants à partir des ics semestres
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--help Show this message and exit.
|
||||||
|
|
||||||
|
Usage: app gen-api-map [OPTIONS]
|
||||||
|
|
||||||
|
Génère la carte des routes de l'API.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-e, --endpoint TEXT Endpoint à partir duquel générer la carte des routes
|
||||||
|
--help Show this message and exit.
|
||||||
```
|
```
|
||||||
|
|
||||||
(*la liste ci-dessus est générée à l'aide de la commande* `flask dumphelp`).
|
(*la liste ci-dessus est générée à l'aide de la commande* `flask dumphelp`).
|
||||||
|
@ -234,7 +234,11 @@ permet de rechercher une entrée à partir du résultat attendu.
|
|||||||
|
|
||||||
### Carte syntaxique
|
### Carte syntaxique
|
||||||
|
|
||||||
![carte_syntaxique](img/API_Chart.svg)
|
<div style="overflow: scroll;">
|
||||||
|
<div style="width: 1200px;">
|
||||||
|
![carte_syntaxique](img/API_Chart.svg)
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
### Tableau récapitulatif des entrées de l'API
|
### Tableau récapitulatif des entrées de l'API
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
Before Width: | Height: | Size: 865 KiB After Width: | Height: | Size: 865 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/papers/Adhesion-2024-2025-Association-ScoDoc.docx
Normal file
BIN
docs/papers/Adhesion-2024-2025-Association-ScoDoc.docx
Normal file
Binary file not shown.
BIN
docs/papers/Adhesion-2024-2025-Association-ScoDoc.pdf
Normal file
BIN
docs/papers/Adhesion-2024-2025-Association-ScoDoc.pdf
Normal file
Binary file not shown.
Loading…
Reference in New Issue
Block a user