Nutzung per Kommandozeile

Das qsfw ist primär auf die Nutzung der CLI-Schnittstelle ausgelegt, wobei der Aufruf über eine Kommandozeile erfolgt.

Hinweise zur Nutzung der CLI-Schnittstelle

Folgendes wird vorausgesetzt:

• Grundlagen im Umgang mit der Kommandozeile (Terminal unter Linux/macOS, Eingabeaufforderung unter Windows), bspw. Kommandozeilenargumente, Umgebungsvariablen
• Wissen über Arbeitsverzeichnis (Working Directory) beim Aufruf eines Kommandos/Skripts
• funktionierende Python-Umgebung
• installierte Abhängigkeiten

qsfw kann mit oder ohne Python venv's genutzt werden. Wichtig dabei ist, dass in der entsprechenden Umgebung alle Abhängigkeiten installiert sind! Die nachfolgenden Schritte gehen davon aus, dass Python richtig installiert und eingerichtet ist, also über die PATH-Umgebungsvariablen des Systems auffindbar ist. Sofern Tools wie Anaconda genutzt werden, ist das nicht möglicherweise nicht der Fall, sodass zusätzliche Schritte zur Einrichtung erforderlich sein können.

Wie man die Schnittstelle nutzt

Der Aufruf des qsfw erfolgt grundsätzlich aus dem root-Verzeichnis des Projekts heraus. Genauer bedeutet das, lädt man das qsfw aus dem Github-Repository herunter und entpackt es lokal, öffnet man die Kommandozeile (unter Linux/macOS Terminal; unter Windows Kommandozeile oder PowerShell) und wechselt in das Verzeichnis, in das das qsfw entpackt wurde.
Anschließend erfolgt der grundsätzliche Aufruf mit, hier mit dem Argument -h zur Anzeige der Hilfe:

python3 -m qsfw -h

Die Hilfe-Anzeige gibt grundsätzliche Informationen über die CLI-Schnittstelle des qsfw, im Detail welche Parameter unterstützt/erfordert sind und wie sie anzugeben sind.

Ein Aufruf aus einem anderen Verzeichnis heraus ist grundsätzlich möglich, erfordert jedoch einen erhöhten Aufwand zur Einrichtung. Python sucht standardmäßig nur in bestimmten Pfaden nach Modulen, demnach müsste dann der Pfad erst zur Umgebungsvariablen, die Python nutzt, hinzugefügt werden.

Hat man bereits eine Schnittstellendatei/ein Skript vorliegen, das mit dem qsfw ausgeführt werden soll, nutzt man:

python3 -m qsfw <optionen> <pfad zum skript>

Der Pfad zum Skript kann dabei absolut oder relativ angegeben werden. Bei einer relativen Angabe muss darauf geachtet werden, dass die Angabe relativ zum Arbeitsverzeichnis(Working Directory) erfolgen muss, also dem bereits angesprochenen root-Verzeichnis des qsfw (sofern der Aufruf von dort aus erfolgt).

Im Ordner examples des qsfw sind mehrere Beispiele zu finden, die zuerst getestet werden können. Die Beispiele, die als Python-Skript vorliegen, werden wie folgt aufgerufen:

python3 examples/<beispiel>

Die .qs-Dateien, die beispielhaften Skript-Code für der qsfw enthalten, können auch wie bereits beschrieben dem qsfw direkt übergeben werden:

python3 -m qsfw examples/code.qs