bo4e 0.2.3

Python Library that implements the BO4E Standard.

🇩🇪 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. It requires Python >=3.8.

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

• C#/.NET

• Golang

• Kotlin

• TypeScript

Versioning

Short background information about versioning of python packages.

At the moment (2021-02-10) there are seven ways to define the version of your package.

We use setuptools-scm for versioning so we can use the tags of git to define the version.

The tool itself again has several ways how to configure it.

We use the pyproject.toml file to configure setuptools-scm.

There we tell the build-system with "setuptools_scm[toml]>=3.4" that we use setuptools_scm and the version must be at least 3.4.

The [toml] section tells setuptools-scm that it finds all settings in our pyproject.toml file.

[tool.setuptools_scm] in pyproject.toml enables version inference.

In the setup.py we have to use the attribute use_scm_version=True.

To create the version number itself, we stick to the default behavior of setuptools-scm. It will take a look at three things:

1. latest tag (with a version number)

2. the distance to this tag (e.g. number of revisions since latest tag)

3. workdir state (e.g. uncommitted changes since latest tag)

and uses roughly the following logic to render the version:

no distance and clean:

{tag}

distance and clean:

{next_version}.dev{distance}+{scm letter}{revision hash}

no distance and not clean:

{tag}+dYYYYMMDD

distance and not clean:

{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

The next version is calculated by adding 1 to the last numeric component of the tag.

To get the current version run in your working directory:

python setup.py --version

At the moment it is not possible to get the version number at runtime. To achieve this, we have to implement Retrieving package version at runtime.

If you follow the instruction in the release workflow, you will get the version number which you define with the label name.

Hochfrequenz

Hochfrequenz Unternehmensberatung GmbH is a Grünwald (near Munich) based consulting company with offices in Berlin and Bremen. According to Kununu ratings Hochfrequenz is among the most attractive employers within the German energy market. Applications of talented developers are welcome at any time! Please consider visiting our career page that also contains job openings.