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
Raw data
{
"_id": null,
"home_page": "https://tbs1-bo.github.io/webuntis_cli/",
"name": "webuntis-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "cli, untis, stundenplan, timetable",
"author": "Marco Bakera",
"author_email": "marco@bakera.de",
"download_url": "https://files.pythonhosted.org/packages/a8/cb/abacdad72a4f4e7b97521b1e4b24496aa53184481c275593024d51427d99/webuntis_cli-0.6.6.tar.gz",
"platform": null,
"description": "Das Projekt `webuntis-cli` stellt eine Kommandozeile\nf\u00fcr [WebUntis](https://www.untis.at) zur Verf\u00fcgung. Bei Webuntis\nhandelt es sich um eine Software zum Erstellen und Verwalten von\nStundenpl\u00e4nen in Schulen.\n\n\nInstallation/Upgrade\n====================\n\nBenutze `pip` (oder `pip3`) f\u00fcr eine einfache Installation. Hierf\u00fcr muss \n[python](https://www.python.org) installiert sein. \n\n $ pip install --upgrade webuntis-cli\n\nMit der Option `--upgrade` wird immer die jeweils aktuelle Version installiert. \n\n\nBenutzung\n=========\n\nNach der Installation steht der Befehl `webuntis-cli` zur Verf\u00fcgung. Dieser \nverf\u00fcgt \u00fcber eine Hilfefunktion.\n\n $ webuntis-cli --help\n\nNach dem ersten Aufruf wird die Konfigurationsdatei `.webuntis-cli.ini` im \nHome-Verzeichnis des Nutzers angelegt. Diese muss bearbeitet und mit den \nkorrekten Nutzerdaten wie Schulname, Server, Benutzername und Passwort bef\u00fcllt \nwerden. \n\nWenn das Speichern von Passw\u00f6rtern in einer Datei unerw\u00fcnscht ist, kann\nder Eintrag f\u00fcr das Passwort aus der Konfigurationsdatei entfernt werden. In \ndiesem Falle muss es bei jeder Ausf\u00fchrung eingegen werden.\n\nBeispiele\n---------\n\nEin Aufruf f\u00fcr den aktuellen Stundenplan von Herr Mustermann w\u00fcrde wie folgt\naussehen:\n\n $ webuntis-cli --lehrer Mustermann \n\nEs k\u00f6nnen auch mehrere Personen angegeben werden:\n\n $ webuntis-cli --lehrer Mustermann Musterfrau\n \nEbeso k\u00f6nnen die Pl\u00e4ne f\u00fcr verschiedene R\u00e4ume oder Klassen angezeigt werden.\n\n $ webuntis-cli --raum 12 13 14\n $ webuntis-cli --klasse 10a 10b 10c\n\nDer anzuzeigende Zeitraum kann \u00fcber die folgenden Optionen festgelegt werden:\n\n- `--start` der erste Termin\n- `--tage` die Anzahl der angezeigten Tage\n\n\n $ webuntis-cli --lehrer Mustermann --start 1.1. --tage 3\n\n\nProbleme, Fehler oder Verbesserungsvorschl\u00e4ge\n=============================================\n\nFehler, Probleme oder Vorschl\u00e4ge f\u00fcr Verbesserungen kannst du \u00fcber den [Bugtracker bei\ngithub](https://github.com/tbs1-bo/webuntis_cli/issues/new) melden. Hierf\u00fcr \nben\u00f6tigst du einen einen Account bei github.\n\nEntwicklerdokumentation\n=======================\n\nEs k\u00f6nnen Debugausgaben aktiviert werden, indem die Umgebungsvariable \n`WEBUNTIS_CLI_DEBUG` mit einem belibiegen Wert initialisiert wird.\n\n $ WEBUNTIS_CLI_DEBUG=1 webuntis-cli --help\n \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "WebUntis CLI",
"version": "0.6.6",
"project_urls": {
"Homepage": "https://tbs1-bo.github.io/webuntis_cli/"
},
"split_keywords": [
"cli",
" untis",
" stundenplan",
" timetable"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bfb7bf430d01ed6baf08a78762ad2244f37a2905e57a806cd56446e3d563a76",
"md5": "ec8e734f16bc16b302daf92d1545b780",
"sha256": "0438c227217812145a6a51606f6ea6151977bd6999f18d1ed4aa6343901bad93"
},
"downloads": -1,
"filename": "webuntis_cli-0.6.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec8e734f16bc16b302daf92d1545b780",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 5250,
"upload_time": "2024-09-08T14:26:10",
"upload_time_iso_8601": "2024-09-08T14:26:10.083772Z",
"url": "https://files.pythonhosted.org/packages/8b/fb/7bf430d01ed6baf08a78762ad2244f37a2905e57a806cd56446e3d563a76/webuntis_cli-0.6.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8cbabacdad72a4f4e7b97521b1e4b24496aa53184481c275593024d51427d99",
"md5": "2631a26b2cb25af78393c33e3b2f0ea1",
"sha256": "6639ba55adaeddc349a048f85575b68bd5d21e3e4802399c5034e99bff286f11"
},
"downloads": -1,
"filename": "webuntis_cli-0.6.6.tar.gz",
"has_sig": false,
"md5_digest": "2631a26b2cb25af78393c33e3b2f0ea1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 4717,
"upload_time": "2024-09-08T14:26:11",
"upload_time_iso_8601": "2024-09-08T14:26:11.170820Z",
"url": "https://files.pythonhosted.org/packages/a8/cb/abacdad72a4f4e7b97521b1e4b24496aa53184481c275593024d51427d99/webuntis_cli-0.6.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-08 14:26:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "webuntis-cli"
}
JSON