From 861f03eb6de623c905d1255fa69578ae7ad59f58 Mon Sep 17 00:00:00 2001 From: Emmy D'ANELLO Date: Mon, 29 Aug 2022 11:54:27 +0200 Subject: [PATCH] [scripts] Remove README and add link to documentation Signed-off-by: Emmy D'ANELLO --- README.md | 62 +------------------------------------------------------ 1 file changed, 1 insertion(+), 61 deletions(-) diff --git a/README.md b/README.md index 34ddfd3..e8535d1 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,3 @@ # Script de la NoteKfet 2020 -## Commandes Django - -> les commandes sont documentées: -> `./manage.py command --help` - -- `import_nk15` : - - Importe un dump de la NoteKfet 2015. - -- `make_su [--STAFF|-s] [--SUPER|-S]` : - - Rend actifs les pseudos renseignés. - - * Si `--STAFF` ou `-s` est renseigné, donne en plus le statut d'équipe aux pseudos renseignés, - permettant l'accès à l'interface admin. - * Si `--SUPER` ou `-S` est renseigné, donne en plus le statut de super-utilisateur aux pseudos renseignés, - octroyant tous les droits sur la plateforme. - -- `wei_algorithm` : - - Lance l'algorithme de répartition des 1A au dernier WEI. Cela a pour effet de suggérer un bus pour tous les 1A - inscrits au dernier WEI en fonction des données rentrées dans le sondage, la validation se faisant ensuite - manuellement via l'interface Web. - -- `extract_ml_registrations --type {members, clubs, events, art, sport} [--year|-y YEAR]` : - - Récupère la liste des adresses mail à inscrire à une liste de diffusion donnée. - - * `members` : Liste des adresses mail des utilisateurs ayant une adhésion BDE (et non Kfet) active. - * `clubs` : Liste des adresses mail de contact de tous les clubs BDE enregistrés. - * `events` : Liste de toutes les adresses mails des utilisateurs inscrits au WEI ayant demandé à s'inscrire sur - la liste de diffusion des événements du BDE. - * `art` : Liste de toutes les adresses mails des utilisateurs inscrits au WEI ayant demandé à s'inscrire sur - la liste de diffusion concertnant les actualités artistiques du BDA. - * `sport` : Liste de toutes les adresses mails des utilisateurs inscrits au WEI ayant demandé à s'inscrire sur - la liste de diffusion concertnant les actualités sportives du BDS. - - Le champ `--year` est optionnel : il permet de choisir l'année du WEI en question (pour les trois dernières - options). Si non renseigné, il s'agit du dernier WEI. - - Par défaut, si `--type` est non renseigné, la liste des adhérents BDE est renvoyée. - -- `extract_wei_registrations [--year|-y YEAR] [--bus|-b BUS] [--team|-t TEAM] [--sep SEP]` : - - Récupère la liste des inscriptions au WEI et l'exporte au format CSV. Arguments possibles, optionnels : - - * `--year YEAR` : sélectionne l'année du WEI. Par défaut, il s'agit du dernier WEI ayant eu lieu. - * `--bus BUS` : filtre par bus, en récupérant uniquement les inscriptions sur un bus. Par défaut, on affiche - tous les bus. - * `--team TEAM` : filtre par équipe, en récupérant uniquement les inscriptions sur une équipe. Par défaut, on - affiche toutes les équipes. Entrer `"none"` filtre les inscriptions sans équipe (chefs de bus,…) - * `--sep` : définit le caractère de séparation des colonnes du fichier CSV. Par défaut, il s'agit du caractère `|`. - Merci de ne pas rentrer plus d'un caractère. - - -## Shell - -- Tabula rasa : -```shell script -sudo -u postgres sh -c "dropdb note_db && psql -c 'CREATE DATABASE note_db OWNER note;'" -``` +La documentation est disponible sur .