JecnaAPI
10.3.5indexedAccess school portal data — news, grades, timetable, attendance, teachers, student profiles; order and trade meals via built‑in marketplace; Java-friendly CompletableFuture API.
6
Stars
—
Used by
dependents
62
Health
/ 100
JecnaAPI
English version here
JecnaAPI je Kotlin/Java knihovna, díky které lze přistupovat k datům webu spsejecna.cz. Tato knihovna vznikla primárně pro účely JecnaMobile, ale může ji použít kdokoliv.
JecnaAPI podporuje Kotlin Multiplatform pro tyto targety: jvm, android, wasmJs, js, linuxX64.
Funkce
-
čtení:
Požadavky
- Java 21+ (projekt používá JVM toolchain 21)
- Kotlin 2.2+
Instalace
JecnaAPI je na Maven Central repozitáři.
Gradle
build.gradle.kts
dependencies {
implementation("io.github.tomhula:jecnaapi-core:10.3.5")
/* API na www.spsejecna.cz */
implementation("io.github.tomhula:jecnaapi-jecna:10.3.5")
/* API na www.spsejecna.cz pro Javu */
implementation("io.github.tomhula:jecnaapi-jecna-java:10.3.5")
/* API na jidelnu */
implementation("io.github.tomhula:jecnaapi-canteen:10.3.5")
/* API na jidelnu pro Javu */
// Neexistuje
}
Maven
pom.xml
Nahraďte {platform} platformou pro kterou kompilujete, (jvm, android, js, atd.) protože Maven neumí automaticky resolvovat multiplatform knihovny.
Použití
Knihovna je primárně naprogramovaná v Kotlinu, ale je možné ji používat i z Javy. Chcete‑li ji používat i z Javy, musíte přidat závislost na jecnaapi-java (viz Instalace). V Javě se místo Kotlin Coroutines používá API CompletableFuture.
Vytvoření JecnaClient objektu
Kotlin
val jecnaClient = JecnaClient()
Java
JecnaClientJavaWrapper jecnaClient = new JecnaClientJavaWrapper();
Přihlášení
Přihlášení je nezbytné k čtení dat studenta.
Kotlin
/* runBlocking, nebo jiný coroutine scope. */
runBlocking {
jecnaClient.login("username", "password")
}
Java
// přihlášení (počkejte na dokončení)
jecnaClient.login("username", "password").join();
Čtení dat
Kotlin
/* runBlocking, nebo jiný coroutine scope. */
runBlocking {
val newsPage = jecnaClient.getNewsPage()
val gradesPage = jecnaClient.getGradesPage()
val timetablePage = jecnaClient.getTimetablePage()
val attendancePage = jecnaClient.getAttendancePage()
val teachersPage = jecnaClient.getTeachersPage()
val absencePage = jecnaClient.getAbsencePage()
}
Java
NewsPage newsPage = jecnaClient.getNewsPage().join();
GradesPage gradesPage = jecnaClient.getGradesPage().join();
TimetablePage timetablePage = jecnaClient.getTimetablePage().join();
AttendancePage attendancePage = jecnaClient.getAttendancePage().join();
jecnaClient.getTeachersPage().join();
jecnaClient.getAbsencePage().join();
Některé metody berou období (např. rok) jako parametr.
Kotlin
/* runBlocking, nebo jiný coroutine scope. */
runBlocking {
/* Získání známek z roku 2021/2022 z druhého pololetí. */
val gradesPage = jecnaClient.getGradesPage(SchoolYear(2021), SchoolYearHalf.SECOND)
}
Java
/* Získání známek z roku 2021/2022 z druhého pololetí. */
GradesPage gradesPage = jecnaClient.getGradesPage(new SchoolYear(2021), SchoolYearHalf.SECOND).join();
Více příkladů najdete ve složkách kotlin-examples a java-examples.
Kontribuce
Kontribuce jsou vítané, stačí založit Pull Request. Pokud jde o nějaké zásadní změny (což samozřejmě můžete), je dobré je se mnou nejdříve probrat, ať je neděláte zbytečně.
License
GNU GPLv3 © Tomáš Hůla