Skip to content

MrMxffin/uni_leipzig_scheduler

Repository files navigation

Scheduler für Stundenplanbenachrichtigungen

Dieses Projekt ermöglicht es, den Stundenplan ander Universität Leipzig abzurufen und Benachrichtigungen über Telegram zu erhalten. Jeden Sonntag sendet der Telegram-Bot den Stundenplan der nächsten Woche um 12 Uhr

Inhaltsverzeichnis

  1. Einleitung
  2. Funktionsweise
  3. Verwendung
  4. Konfiguration
  5. Installation
  6. Beitragen
  7. Lizenz

Einleitung

Falls man sich - wie ich - nicht merken kann, wann und wo man Unterricht hat, kann es nützlich sein, den Stundenplan regelmäßig zugesendet zu bekommen. Dieses Scheduler-Tool wurde entwickelt, damit ich meine schöne Lebenszeit nicht damit verbringen muss, jeden Tag AlmaWeb zu öffnen.

Funktionsweise

Das System verwendet einen Flask-Server als Proxy, um zwischen dem Skript und der AlmaWeb-Plattform zu vermitteln. Dies ermöglicht es, das von AlmaWeb erzwungene CORS zu umgehen und eine reibungslose Kommunikation zu gewährleisten. Der Ablauf des Systems ist wie folgt:

Authentifizierung und Anfrage: Das Skript führt jeden Sonntag eine Authentifizierung auf der AlmaWeb-Plattform durch und fragt den Wochenplans für den folgenden Tag ab. Datenverarbeitung: Die empfangenen Daten werden analysiert und die relevanten Informationen extrahiert. Dazu gehört die Aufbereitung des Stundenplans für eine benutzerfreundliche Darstellung. Benachrichtigung: Die aufbereiteten Daten werden dann per Bot an einen benutzerdefinierten Chat gesendet. Dies ermöglicht es den Benutzern, den Wochenplan bequem und zeitnah zu erhalten. Durch diese Prozesse bietet das System eine effiziente und zuverlässige Möglichkeit, den Stundenplan abzurufen und Benachrichtigungen über Telegram zu erhalten.

Verwendung

Um den Scheduler zu verwenden, müssen Sie die Konfiguration entsprechend anpassen und das Hauptskript ausführen. Der Scheduler ruft den Stundenplan automatisch ab und sendet Benachrichtigungen über Telegram.

Konfiguration

Die Konfiguration erfolgt über Umgebungsvariablen, die in einer .env-Datei bereitgestellt werden. Folgende Variablen müssen konfiguriert werden:

  • ALMAWEB_USERNAME: Benutzername für den Zugriff auf die AlmaWeb-Plattform.
  • ALMAWEB_PASSWORD: Passwort für den Zugriff auf die AlmaWeb-Plattform.
  • TELEGRAM_BOT_TOKEN: Token für den Zugriff auf den Telegram-Bot.
  • TELEGRAM_CHAT_ID: Chat-ID des Telegram-Chats, an den Benachrichtigungen gesendet werden sollen.

Installation

Um das Projekt lokal auszuführen, müssen Sie die folgenden Schritte ausführen:

  1. Klonen Sie das Repository: git clone https://github.com/MrMxffin/uni_leipzig_scheduler.git
  2. Wechseln Sie in das Verzeichnis: cd uni_leipzig_scheduler
  3. Installieren Sie die Abhängigkeiten: pip install -r requirements.txt
  4. Erstellen Sie eine .env-Datei und konfigurieren Sie die erforderlichen Umgebungsvariablen.
  5. Führen Sie das Hauptskript aus: python main.py

Beitragen

Beiträge sind immer willkommen! Wenn Sie Verbesserungen vornehmen möchten, öffnen Sie bitte ein Issue oder senden Sie eine Pull-Anfrage.

Lizenz

Dieses Projekt ist unter der Unlicense lizenziert. Das bedeutet, dass es sich um freie und gemeinfreie Software handelt, die in die Public Domain entlassen wurde. Du bist frei, die Software zu kopieren, zu modifizieren, zu veröffentlichen, zu verwenden, zu kompilieren, zu verkaufen oder zu verteilen, sowohl in Quellcode-Form als auch als kompilierte Binärdatei, für jeden Zweck, kommerziell oder nicht kommerziell, und auf jede erdenkliche Weise.

Weitere Informationen findest du in der Lizenzdatei.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages