wip

Author: hf-kklein

README.md

@@ -1,11 +1,55 @@
 # FUNDAMEND - Formate und DAtenModelle für die ENergiewirtschaft in Deutschland
 
+Dieses Repository enthält das Python-Paket `fundamend`.
 
-<!--- you need to replace the `organization/repo_name` in the status badge URLs --->
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 ![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/fundamend.svg)
 ![Pypi status badge](https://img.shields.io/pypi/v/fundamend)
 ![Unittests status badge](https://github.com/Hochfrequenz/xml-fundamend-python/workflows/Unittests/badge.svg)
 ![Coverage status badge](https://github.com/Hochfrequenz/xml-fundamend-python/workflows/Coverage/badge.svg)
 ![Linting status badge](https://github.com/Hochfrequenz/xml-fundamend-python/workflows/Linting/badge.svg)
 ![Black status badge](https://github.com/Hochfrequenz/xml-fundamend-python/workflows/Formatting/badge.svg)
+
+## Sinn und Zweck
+Seit 2024 bietet der BDEW (endlich) maschinenlesbare MIG- und AHB-Spezifikationen an, wo zuvor nur PDF oder Word-Dateien veröffentlicht wurden.
+Das ist ein wichtiger Schritt für eine echte Digitalisierung der Marktkommunikation im deutschen Energiemarkt.
+
+Die nun maschinenlesbaren Informationen sind XML-basiert.
+
+Dieses Repository enthält ein kleines Python-Paket, das die XML-Dateien einliest und als Python-Objekte zur Verfügung stellt, damit sich niemand mit XML herumschlagen muss.
+Das ist alles.
+
+## Installation und Verwendung
+Das Paket ist auf PyPI verfügbar und kann mit pip installiert werden:
+```bash
+pip install fundamend
+```
+
+```python
+from pathlib import Path
+from fundamend import MigReader, MessageImplementationGuide
+
+# Angenommen, mig_utilts.xml enthält:
+# <?xml version="1.0" encoding="UTF-8"?>
+# <M_UTILTS Versionsnummer="1.1c"
+#    Veroeffentlichungsdatum="24.10.2023"
+#    Author="BDEW">
+# ...
+# </M_UTILTS>
+
+reader = MigReader(Path("pfad/zur/mig_utils.xml"))
+mig = reader.read()
+assert isinstance(mig, MessageImplementationGuide)
+assert mig.format == "UTILTS"
+```
+
+Aktuell (Version 0.1) können nur MIGs gelesen werden.
+Der AHB-Teil soll aber folgen.
+
+## Verwendung und Mitwirken
+Der Code ist MIT-lizenziert und kann daher frei verwendet werden.
+Wir freuen uns über Pull Requests an den main-Branch dieses Repositories.
+
+## Hochfrequenz
+Die [Hochfrequenz Unternehmensberatung GmbH](https://www.hochfrequenz.de) ist eine Beratung für Energieversorger im deutschsprachigen Raum.
+Wir arbeiten größtenteils remote, haben aber auch Büros in Berlin, Bremen, Leipzig, Köln und Grünwald und attraktive [Stellenangebote](https://www.hochfrequenz.de/index.php/karriere/aktuelle-stellenausschreibungen/full-stack-entwickler).

domain-specific-terms.txt

@@ -1,3 +1,7 @@
 # contains 1 lower case word per line which are ignored in the spell_check
 autor
 formate
+fundamend
+oder
+ist
+als

src/fundamend/__init__.py

@@ -2,3 +2,7 @@
 fundamend contains Formate und Datenmodelle für die Energiewirtschaft in Deutschland.
 pip install xml-fundamend
 """
+from .models import MessageImplementationGuide
+from .reader import MigReader
+
+__all__ = ["MigReader", "MessageImplementationGuide"]

src/fundamend/models/__init__.py

@@ -1 +1,4 @@
 """contains model classes representing MIGs and AHBs"""
+from .messageimplementationguide import MessageImplementationGuide
+
+__all__ = ["MessageImplementationGuide"]