README.md

Tomuss API Wrapper for Java

Obtenir ses notes de Tomuss

A propos

Ce projet est un wrapper Java pour Tomuss. Il permet de récupérer les semestres et les notes d'un étudiant (en se connectant via le CAS).
Il existe aussi un wrapper Tomuss en TypeScript.

Pour commencer

Pour installer en tant que dépendance Maven / Gradle, vous devez d'abord build le projet avec Gradle (voir instructions ci-dessous).

Contribuer / Modifier le code source

Clonez le repository et installez les dépendances :

git clone https://github.com/Shawiizz/tomuss-api-wrapper-java.git
cd tomuss-api-wrapper-java

Setup le projet avec gradle (devrait se faire automatiquement sur IntelliJ IDEA) :

./gradlew.bat build

Pour obtenir le jar projet, exécutez :

./gradlew.bat shadowJar

Tout les fichiers compilés se trouvent dans le dossier build/libs/ (le fichier -all devrait contenir toutes les dépendances du projet).

Exemples

Comment obtenir ses notes

// Pour se connecter via le CAS
CASAuthService authService = new CASAuthService();
authService.login("username", "password");

// Pour obtenir les semestres disponibles
TomussService tomussService = TomussService.withAuth(authService);
List<Semester> semesters = tomussService.getAvailableSemesters();

// Obtenir les modules (matières) d'un ou plusieurs semestres
Semester firstSemester = semesters.get(0);
// La méthode getModules() peut prendre plusieurs semestres en argument si nécéssaire.
List<TomussModule> modules = tomussService.getModules(firstSemester); 
// Traitez vos modules (voir les propriétés de TomussModule)