forked from kompetenzinventar/ki-backend
update readme
This commit is contained in:
parent
5dc0f7153d
commit
09669cf369
23
README.md
23
README.md
@ -9,6 +9,7 @@
|
|||||||
- Python 3.8
|
- Python 3.8
|
||||||
- [Pipenv](https://github.com/pypa/pipenv)
|
- [Pipenv](https://github.com/pypa/pipenv)
|
||||||
|
|
||||||
|
|
||||||
### Entwicklungsumgebung aufbauen und starten
|
### Entwicklungsumgebung aufbauen und starten
|
||||||
|
|
||||||
Ggf. vorher aufräumen
|
Ggf. vorher aufräumen
|
||||||
@ -39,26 +40,24 @@ pre-commit install
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Tests ausführen
|
### `alembic` Befehle
|
||||||
|
|
||||||
|
`alembic` ist über [Flask-Migrate](https://flask-migrate.readthedocs.io/en/latest/index.html) eingebunden.
|
||||||
|
Es wird über `flask db ...` aufgerufen.
|
||||||
|
|
||||||
|
|
||||||
|
### QA
|
||||||
|
|
||||||
```
|
```
|
||||||
python -m unittest discover ki
|
python -m unittest discover ki
|
||||||
```
|
|
||||||
|
|
||||||
|
# Code formatieren
|
||||||
|
yapf -i --recursive ki/
|
||||||
|
|
||||||
### Linting
|
# Code-Style prüfen
|
||||||
|
|
||||||
```
|
|
||||||
flake8
|
flake8
|
||||||
```
|
```
|
||||||
|
|
||||||
### Formatierung
|
|
||||||
|
|
||||||
Um ein einheitliches Quellcode-Erlebnis zu haben, kann der Code mit yapf neu formatiert werden:
|
|
||||||
|
|
||||||
```
|
|
||||||
yapf -i --recursive ki/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testbenutzer
|
### Testbenutzer
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user