README.md

NateMan

Hinweis: NateMan ist als Schulprojekt für das Abitur („Besondere Lernleistung“) entstanden. Es wird von mir seit 2022 nur noch minimal auf dem neuesten Stand gehalten (z.B. bezüglich des Dockerfiles) und nicht mehr weiterentwickelt. Benutzung auf eigene Gefahr. 😉

NateMan (Nachschreibtermin-Manager) ist eine Webanwendung zur Koordination von Klausuren gymnasialer Oberstufen. Klausurpläne können aus verschiedenen Formaten importiert oder direkt im Webinterface erstellt werden und sind anschließend öffentlich einsehbar. Über eigene Lehrerkonten können Klausuraufsichten nach einer Klausur Versäumnisse eintragen. Beratungslehrer und Oberstufenkoordinatoren können diese Bearbeitungen einsehen, bei Bedarf ändern und Atteste für Versäumnisse eintragen.

Funktionen

• Import und Bearbeitung von Klausurlisten (aus einem CSV-Format oder Kurs42)
• administrierbares Anmeldesystem für Lehrkräfte
• Eintragung von Klausurversäumnissen und Attesten
• Versäumnislisten für Beratungslehrer
• Excel-Export von Nachschreibplänen mit automatischer Terminzuordnung
• Klausurerinnerungen an Lehrkräfte per E-Mail
• öffentlich einsehbare Klausurpläne
• individuelle Klausurplanansicht für Schüler und Schülerinnen

Schnelle Installation

Die schnelle Installation ist nur zum Ausprobieren geeignet und sollte nicht produktiv eingesetzt werden!

Dieser Abschnitt beschreibt die manuelle Installation von NateMan. Zur Installation mit Docker steht ein Dockerfile zur Verfügung.

1. Installieren Sie Python und Python-Venv.

   Details

   Unter Linux (Debian und Derivate) installieren Sie die Pakete python3 und python3-venv.
   Unter Windows und macOS laden Sie den Python-Installer herunter und führen Sie ihn aus. Python-Venv wird standardmäßig mitinstalliert.

2. Legen Sie eine virtuelle Python-Umgebung an und betreten Sie diese.

   Details

   Linux/macOS:

   mkdir nateman
   cd nateman
   python3 -m venv venv
   source venv/bin/activate

   Windows:

   mkdir nateman
   cd nateman
   py -3 -m venv venv
   venv\Scripts\activate
   

3. Laden Sie das aktuellste Installationspaket herunter (Dateiendung: .whl).

4. Installation:

   pip install NateMan-X.Y.Z-py3-none-any.whl

5. Start:

   python3 -m nateman

Öffnen Sie nun den frisch installierten NateMan unter http://127.0.0.1:8080/ und melden Sie sich mit dem Kürzel admin und dem Passwort admin an.

Über die Entwicklung

NateMan ist im Schuljahr 2019/2020 als Besondere Lernleistung entstanden.

An der Entwicklung sind beteiligt:

• Niklas Elsbrock (Hauptentwickler)
• Johannes Bingel (Exportfunktion und Excel-Importfunktion)
• Dipl.-Inform. Christian Wolf, OStR (Idee und Betreuung)