master > master: code py - README (make -> just)

This commit is contained in:
RD 2022-06-09 18:12:35 +02:00
parent 8111b8ef07
commit 57bc1e68e6
1 changed files with 11 additions and 11 deletions

View File

@ -10,9 +10,7 @@ die Methoden mit Daten ausprobieren.
## Voraussetzungen ## ## Voraussetzungen ##
1. Der Python-Compiler **`^3.10.*`** wird benötigt. 1. Der Python-Compiler **`^3.10.*`** wird benötigt.
2. Es ist auch empfehlenswert, **`make`** zu installieren. 2. Es ist auch empfehlenswert, **`justfile`** zu installieren (siehe <https://github.com/casey/just#installation>).
- Linux/OSX: siehe <https://formulae.brew.sh/formula/make>.
- Windows: siehe <https://community.chocolatey.org/packages/make>.
## Setup -> Test -> Run ## ## Setup -> Test -> Run ##
@ -20,25 +18,27 @@ In einem IDE in dem Repo zu diesem Ordner navigieren.
</br> </br>
Eine bash-Konsole aufmachen und folgende Befehle ausführen: Eine bash-Konsole aufmachen und folgende Befehle ausführen:
Wer **make** installiert hat: Wer das **justfile**-Tool hat:
```bash ```bash
# Zeige alle Befehle:
just
# Zur Installation der Requirements (nur nach Änderungen): # Zur Installation der Requirements (nur nach Änderungen):
make setup; just setup;
# Zur Ausführung der unit tests: # Zur Ausführung der unit tests:
make tests; just tests;
# Zur Ausführung des Programms # Zur Ausführung des Programms
make run; just run;
# Zur Bereinigung aller Artefakte # Zur Bereinigung aller Artefakte
make clean; just clean;
``` ```
Wer _kein_ make hat: Wer das justfile-Tool hat:
```bash ```bash
# Zur Installation der Requirements (nur nach Änderungen): # Zur Installation der Requirements (nur nach Änderungen):
python3 -m pip install -r requirements; python3 -m pip install -r requirements.txt;
# Zur Ausführung der unit tests: # Zur Ausführung der unit tests:
python3 -m pytest tests --cache-clear --verbose -k test_; python3 -m pytest tests --cache-clear --verbose -k test_;
# Zur Ausführung des Programms: # Zur Ausführung des Programms:
python3 src/main.py python3 main.py
``` ```
Auf Windows verwendet man `py -3` od. `py -310` statt `python3`. Auf Windows verwendet man `py -3` od. `py -310` statt `python3`.