Python Library that implements the BO4E Standard.
Project description
🇩🇪 Dies ist eine BO4E Referenz-Implementierung in Python. Gleichzeitig ist dieses Repository der Ort, um Fragen und Erweiterungen des BO4E-Standards zu diskutieren.
🇬🇧 This is a Python library that implements Business Objects for Energy BO4E.
Grundsätzliche Überlegungen
Pflichtfelder (nicht nullable Attributes)
Der BO4E Standard soll (in Zukunft, Stand 2023-10-05) keine fachlichen Pflichtfelder mehr enthalten. Die Entscheidung, was in welchen Fällen ein Pflichtfeld ist, obliegt den Anwendungen, die den Standard nutzen. Entsprechend ist auch die Validierung der Pflichtfelder nicht Teil des BO4E Standards sondern anwendungsspezifisch. Davon sind auch technische Pflichtfelder, namentlich _typ und _version nicht ausgenommen. Ob sie anzugeben sind, entscheidet die Anwendung. BO4E gibt sinnvolle Datenstrukturen vor, wie diese in der Praxis genutzt werden können und wollen wir aber nicht vorschreiben.
Verknüpfungen zwischen Objekten
Viele Objekte verweisen aufeinander und sind miteinander verknüpft. Dabei sind unsere Designentscheidungen:
Alle Verknüpfungen sind optional.
Verknüpfungen sind, wo sie naheliegend sind, im BO4E Standard vordefiniert (z.B. 1 Messlokation hat n Zähler).
Aber wir haben nicht jede theoretisch denkbare Verknüpfungen implementiert (z.B. allein dass User Zähler unter Angabe einer Email-Adresse suchen können, heißt nicht, dass der Zähler eine optionale Eigenschaft emailAdresse haben muss.)
Generell sollen zwischen zwei BOs bi-direktional sein, zwischen BOs und COMs aber nur unidirektional (z.B. soll jeder Zähler wissen zu welcher Messlokation er gehört aber eine Adresse muss nicht wissen, welchem Geschäftspartner, welcher Messlokation oder welcher Rechnung sie zugeordnet ist).
Zwischen COMs sollen keine Verknüpfungen bestehen (d.h. es sollen keine COMs in COMs eingebettet werden).
Dokumentation / Fragen und Anregungen zum BO4E Datenmodell
Eine Dokumentation des Datenmodells und JSON Schemata zur Erzeugung von Beispieldaten finden sich auf read the docs.
Bei Fragen oder Anregungen, bitte einfach ein Issue in diesem Repo aufmachen.
Code Beiträge
Änderungsvorschläge (sowohl an das Datenmodell als auch an die Implementierung in Python) können direkt als Code in Form von Pull Requests eingereicht werden. Details dazu finden sich im Contribution Guide.
Andere nennenswerte BO4E Implementierungen
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
