{"id":36438659,"url":"https://github.com/bo4e/BO4E-python","last_synced_at":"2026-01-27T00:01:22.141Z","repository":{"id":37100179,"uuid":"267630909","full_name":"bo4e/BO4E-python","owner":"bo4e","description":"Python  Library that Implements the BO4E Standard","archived":false,"fork":false,"pushed_at":"2026-01-13T21:47:53.000Z","size":35689,"stargazers_count":18,"open_issues_count":86,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-13T23:58:46.038Z","etag":null,"topics":["bo4e","energiewirtschaft","pydantic-models"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bo4e.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"docs/contributing_guide.rst","funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-28T15:47:28.000Z","updated_at":"2025-12-23T17:20:32.000Z","dependencies_parsed_at":"2023-02-13T02:00:19.552Z","dependency_job_id":"22929251-4785-4e54-b242-cb202bfac7df","html_url":"https://github.com/bo4e/BO4E-python","commit_stats":null,"previous_names":["hochfrequenz/bo4e-python"],"tags_count":123,"template":false,"template_full_name":null,"purl":"pkg:github/bo4e/BO4E-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bo4e%2FBO4E-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bo4e%2FBO4E-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bo4e%2FBO4E-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bo4e%2FBO4E-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bo4e","download_url":"https://codeload.github.com/bo4e/BO4E-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bo4e%2FBO4E-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28792638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bo4e","energiewirtschaft","pydantic-models"],"created_at":"2026-01-11T20:00:26.762Z","updated_at":"2026-01-27T00:01:22.119Z","avatar_url":"https://github.com/bo4e.png","language":"Python","funding_links":[],"categories":["Open Source Projekte"],"sub_categories":[],"readme":"=============\nBO4E\n=============\n|PyPi|_\n|license|_\n|code style|_\n|PyPI pyversions|_\n\n\n.. |PyPi| image:: https://img.shields.io/pypi/v/bo4e.svg\n.. _PyPi: https://img.shields.io/pypi/v/bo4e\n\n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\n.. _license: https://github.com/Hochfrequenz/BO4E-python/blob/main/LICENSE.rst\n\n.. |code style| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n.. _`code style`: https://github.com/psf/black\n\n.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/bo4e.svg\n.. _`PyPI pyversions`: https://pypi.python.org/pypi/bo4e/\n\n\n🇩🇪 Dies ist eine BO4E Referenz-Implementierung in Python.\nGleichzeitig ist dieses Repository der Ort, um Fragen und Erweiterungen des BO4E-Standards zu diskutieren.\n\n🇬🇧 This is a Python library that implements Business Objects for Energy `BO4E \u003chttps://www.bo4e.de/\u003e`_.\n\nGrundsätzliche Überlegungen\n===========================\n\nPflichtfelder (nicht nullable Attributes)\n-----------------------------------------\nDer BO4E Standard soll (in Zukunft, Stand 2023-10-05) keine fachlichen Pflichtfelder mehr enthalten.\nDie Entscheidung, was in welchen Fällen ein Pflichtfeld ist, obliegt den Anwendungen, die den Standard nutzen.\nEntsprechend ist auch die Validierung der Pflichtfelder nicht Teil des BO4E Standards sondern anwendungsspezifisch.\nDavon sind auch technische Pflichtfelder, namentlich `_typ` und `_version` nicht ausgenommen.\nOb sie anzugeben sind, entscheidet die Anwendung.\nBO4E gibt sinnvolle Datenstrukturen vor, wie diese in der Praxis genutzt werden können und wollen wir aber nicht vorschreiben.\n\nVerweise zwischen Objekten\n-------------------------------\nViele Objekte verweisen aufeinander und sind miteinander verknüpft.\nDabei sind unsere Designentscheidungen:\n\n* Alle Verweise sind optional.\n* Verweise sind, wo sie naheliegend sind, im BO4E Standard vordefiniert (z.B. 1 Messlokation hat n Zähler).\n* Aber wir haben nicht jede theoretisch denkbare Verweise 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.)\n* Generell sollen Verweise 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).\n* COMs können zwar weitere COMs beinhalten, jedoch sollte dies nicht dafür genutzt werden von einem COM eines BOs auf das COM eines anderen BOs zu verweisen.\n  Bsp.: Die Adresse in Ansprechpartner ist identisch zur Lokationsadresse in der Marktlokation. Dann sollen beide Adressen als vollständiges COM dargestellt werden, statt nur als Verweis von einer Adresse auf die andere.\n* Oder anders formuliert: wir können aus einem BO oder einem COM auf ein anderes BO verweisen.\n\nDokumentation / Fragen und Anregungen zum BO4E Datenmodell\n==========================================================\nDie Dokumentation ist verfügbar unter `\u003chttps://bo4e.github.io/BO4E-python/\u003e`_.\nDie Doku wird erst seit Version `v202401.0.3 \u003chttps://bo4e.github.io/BO4E-python/v202401.0.3\u003e`_ mittels\nGitHub Pages gehosted.\nDie früheren Versionen sind auf `read the docs \u003chttps://bo4e-python.readthedocs.io/en/latest/api/modules.html\u003e`_\neinsehbar.\n\nUnter `/latest` findet sich die Dokumentation des aktuellen Stands des main-Branches. `/stable` zeigt immer auf die\nletzte veröffentlichte Version (Release candidates ausgeschlossen).\nZusätzlich ist jede Version (inklusive Release candidates) unter `/v\u003cversion\u003e` auffindbar.\n\nDie Doku bietet eine Übersicht über alle Klassen und Attribute, die im BO4E Standard definiert sind. Außerdem\nwerden alle Beziehungen zwischen den Klassen durch Diagramme visualisiert. Die JSON-Schemas sind ebenfalls verlinkt.\nAlternativ können die JSON-Schemas auch direkt von GitHub heruntergeladen werden: `\u003chttps://github.com/bo4e/BO4E-Schemas\u003e`_.\nSeit Version `v202401.1.1 \u003chttps://bo4e.github.io/BO4E-python/v202401.1.1\u003e`_ gibt es zusätzlich eine\n`Kompatibilitätsmatrix \u003chttps://bo4e.github.io/BO4E-python/v202401.1.1/changelog.html\u003e`_,\ndie für jedes Objekt zeigt, zwischen welchen Versionen es einen \"breaking change\" gab.\n\nBei Fragen oder Anregungen, bitte `einfach ein Issue in diesem Repo aufmachen \u003chttps://github.com/Hochfrequenz/BO4E-python/issues/new?assignees=\u0026labels=BO4E+Enhancement+Proposal\u0026template=funktionale-anforderung-an-den-bo4e-standard.md\u0026title=Ein+aussagekr%C3%A4ftiger+Titel%3A+Hunde-+und+Katzentarife+k%C3%B6nnen+nicht+abgebildet+werden\u003e`_.\n\nCode Beiträge\n=============\nÄ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.\nDetails dazu finden sich im `Contribution Guide \u003chttps://bo4e.github.io/BO4E-python/latest/contributing_guide.html\u003e`_.\n\nNutzung als Python Library\n==========================\nIn Python kann diese Library als Paket installiert werden:\n\n.. code-block::\n\n       pip install bo4e\n\n\nAndere nennenswerte BO4E Implementierungen\n==========================================\n\n* `C#/.NET \u003chttps://github.com/Hochfrequenz/BO4E-dotnet\u003e`_\n* `Golang \u003chttps://github.com/Hochfrequenz/go-bo4e/\u003e`_\n* `Kotlin \u003chttps://github.com/openEnWi/ktBO4E-lib\u003e`_\n* `TypeScript (handcrafted) \u003chttps://github.com/openEnWi/tsBO4E-lib\u003e`_\n* `TypeScript (autogenerated, inherently consistent with the .NET library) \u003chttps://github.com/Hochfrequenz/bo4e-dotnet-ts-models\u003e`_\n* `PHP \u003chttps://github.com/conuti-gmbh/bo4e-php/\u003e`_ (und `Schemas \u003chttps://github.com/conuti-gmbh/bo4e-schema\u003e`_)\n\n.. _`BO4E website`: https://www.bo4e.de/dokumentation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbo4e%2FBO4E-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbo4e%2FBO4E-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbo4e%2FBO4E-python/lists"}