Skip to content

Commit

Permalink
docs: extend readme (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
hf-kklein authored Dec 5, 2024
1 parent ecc612d commit 1e3aa36
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ assert {awf.pruefidentifikator for awf in ahb.anwendungsfaelle} == {
}
```

Die vollständigen Beispiele finden sich in den [unittests](unittests).
Die vollständigen Beispiele finden sich in den [unittests](unittests):
- Beispiel [AHB UTILTS](unittests/example_ahb_utilts_11d.py)
- Beispiel [MIG UTILTS](https://github.com/Hochfrequenz/xml-fundamend-python/blob/main/unittests/example_migs.py)

### Verwendung mit Pydantic
Per default verwendet fundamend die [dataclasses aus der Python-Standardlibrary](https://docs.python.org/3/library/dataclasses.html).
Expand All @@ -88,7 +90,7 @@ pip install fundamend[pydantic]
```
mit installiert wird, dann sind Datenmodelle, die von `AhbReader` und `MigReader` zurückgegeben werden, automatisch pydantic Objekte.

Mit Pydantic können die Ergebnisse auch leicht bspw. als JSON exportiert werden:
Mit Pydantic können die Ergebnisse auch leicht bspw. als JSON exportiert werden (was auch über ein CLI-Tool im nächsten Abschnitt) noch einfacher möglich ist.
```python
from pathlib import Path

Expand Down

0 comments on commit 1e3aa36

Please sign in to comment.