Metadata-Version: 2.1
Name: webuntis-cli
Version: 0.6.6
Summary: WebUntis CLI
Home-page: https://tbs1-bo.github.io/webuntis_cli/
License: MIT
Keywords: cli,untis,stundenplan,timetable
Author: Marco Bakera
Author-email: marco@bakera.de
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Education
Requires-Dist: webuntis (>=0.1.11,<0.2.0)
Description-Content-Type: text/markdown

Das Projekt `webuntis-cli` stellt eine Kommandozeile
für [WebUntis](https://www.untis.at) zur Verfügung. Bei Webuntis
handelt es sich um eine Software zum Erstellen und Verwalten von
Stundenplänen in Schulen.


Installation/Upgrade
====================

Benutze `pip` (oder `pip3`) für eine einfache Installation. Hierfür muss 
[python](https://www.python.org) installiert sein. 

    $ pip install --upgrade webuntis-cli

Mit der Option `--upgrade` wird immer die jeweils aktuelle Version installiert. 


Benutzung
=========

Nach der Installation steht der Befehl `webuntis-cli` zur Verfügung. Dieser 
verfügt über eine Hilfefunktion.

    $ webuntis-cli --help

Nach dem ersten Aufruf wird die Konfigurationsdatei  `.webuntis-cli.ini` im 
Home-Verzeichnis des Nutzers angelegt. Diese muss bearbeitet und mit den 
korrekten Nutzerdaten wie Schulname, Server, Benutzername und Passwort befüllt 
werden. 

Wenn das Speichern von Passwörtern in einer Datei unerwünscht ist, kann
der Eintrag für das Passwort aus der Konfigurationsdatei entfernt werden. In 
diesem Falle muss es bei jeder Ausführung eingegen werden.

Beispiele
---------

Ein Aufruf für den aktuellen Stundenplan von Herr Mustermann würde wie folgt
aussehen:

    $ webuntis-cli --lehrer Mustermann    

Es können auch mehrere Personen angegeben werden:

    $ webuntis-cli --lehrer Mustermann Musterfrau
    
Ebeso können die Pläne für verschiedene Räume oder Klassen angezeigt werden.

    $ webuntis-cli --raum 12 13 14
    $ webuntis-cli --klasse 10a 10b 10c

Der anzuzeigende Zeitraum kann über die folgenden Optionen festgelegt werden:

- `--start` der erste Termin
- `--tage` die Anzahl der angezeigten Tage


    $ webuntis-cli --lehrer Mustermann --start 1.1. --tage 3


Probleme, Fehler oder Verbesserungsvorschläge
=============================================

Fehler, Probleme oder Vorschläge für Verbesserungen kannst du über den [Bugtracker bei
github](https://github.com/tbs1-bo/webuntis_cli/issues/new) melden. Hierfür 
benötigst du einen einen Account bei github.

Entwicklerdokumentation
=======================

Es können Debugausgaben aktiviert werden, indem die Umgebungsvariable 
`WEBUNTIS_CLI_DEBUG` mit einem belibiegen Wert initialisiert wird.

    $ WEBUNTIS_CLI_DEBUG=1 webuntis-cli --help
    

