Getting started

HEXscrapePy soll das Scraping von Vorlesungsverzeichnissen deutscher Universitäten erleichtern. Aktuell unterstützt HEXscrapePy das Scraping von HISinOne- (hexscrapepy.his_scraper) und LSF-VVZs (hexscrapepy.lsf_scraper). Die Unterstützung weiterer VVZ-Typen folgt ggf.

Womit anfangen?

Der einfachste Einstieg sind die Wrapper-Funktionen. Sie steuern den gesamten Ablauf – Semester auswählen, Basisdaten laden, Kursdaten scrapen, Ergebnisse speichern – und benötigen nur wenige Parameter:

  • HISinOne: his_scrape_all_semesters()
  • LSF: lsf_scrape_all_semesters()

Wenn du mehr Kontrolle benötigst, kannst du die einzelnen Funktionen auch direkt aufrufen – zum Beispiel um nur einen bestimmten Schritt auszuführen, einen Parser isoliert zu testen oder einen Fehler gezielt einzugrenzen.

Aufbau der Dokumentation

  1. Workflows – beschreibt den typischen Ablauf eines kompletten Scraping-Laufs für HISinOne bzw. LSF.
  2. API – listet alle Funktionen mit ihrer Aufgabe, ihrem Einsatzpunkt und einer Einordnung als öffentlich oder intern.

Die vollständige API-Referenz findest du auf den Seiten zu HISinOne und LSF.