diff --git a/docs/GuideDeveloppeurs.md b/docs/GuideDeveloppeurs.md index 6be84be..282cedc 100644 --- a/docs/GuideDeveloppeurs.md +++ b/docs/GuideDeveloppeurs.md @@ -388,6 +388,36 @@ Au besoin, mémo: - `flask clear-cache` efface le cache Redis. +## Re-création du virtualenv + +ScoDoc est livré avec un "virtualenv", qui contient tous les modules python +nécessaires. Il se trouve sous `/opt:scodoc/venv`. +Si vous souhaitez repartir de zéro, tester de nouvelles versions de certaines +bibliothèques, ou autres expériences de ce genre, vous pouvez le récréer ainsi: +```bash + # en tant qu'utilisateur scodoc + cd /opt/scodoc + /bin/rm -rf venv # ou mv ... + python3 -m venv venv + source venv/bin/activate + pip install wheel +``` +Puis soit vous installez les versions "officielles" (testées) +``` + pip install -r requirements-3.9.txt +``` +Soit vous prenez les version les plus à jour disponibles. Une façon rapide de +faire ceci est: +```bash + cut -d= -f 1 requirements-3.9.txt | xargs pip install +``` +à adapter selon vos objectifs. +Pour régénérer le fichier indiquant la liste des paquets: +```bash + pip freeze > requirements-3.9.txt +``` + +Note: la mise à jour par `apt` recrée le virtualenv à chaque fois. ## Roadmap Sujets **prioritaires** en 2021: diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 892cba5..df61bee 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -117,15 +117,16 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ * **Exemple de résultat:** `[id_1, id_2, id_3, ...]` - * **`liste_etudiants`** + * **`etudiants`** XXX à revoir * **Méthode:** GET * **Paramètres:** `dept`, `semestre` - * **Routes:** `/api/departements//etudiants/liste/` (_`semestre` étant un paramètre optionnel_) + * **Routes:** `/api/departements//etudiants/liste/` * **Exemple d'utilisation:** `/api/departements/MMI/etudiants/liste` - * **Résultat:** liste des étudiants d'un département - semestre actuel par défaut. + * **Résultat:** liste des étudiants d'un département - semestre actuel par + défaut. XXX à préciser - * **`liste_semestres_actifs`** + * **`liste_semestres_actifs`** XXX à revoir * **Méthode:** GET * **Paramètres:** `dept` * **Routes:** `/api/departements//semestres_actifs` @@ -133,13 +134,14 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ * **Résultat:** Liste des semestres actifs d'un département donné. (_réponse sous format json_) - * **`referenciel_competences`** + * **`referentiel_competences`** *XXX pourquoi le dept est dans la route ?* * **Méthode:** GET - * **Paramètres:** `dept`, `formation` (_`formation` étant un id de formation, un programme pédagogique_) + * **Paramètres:** `dept`, `formation_id` (_`formation_id` étant un id de formation, un programme pédagogique_) * **Routes:** `/api/departements//formations//referentiel_competences` * **Exemple d'utilisation:** `/api/departements/MMI/formations/12/referentiel_competences` * **Résultat:** Le référentiel de compétences d'une formation donnée. (_pas toujours présent_) + * XXX obtenir la liste des référentiels ## Etudiants * **`etud_dept`**