diff --git a/README.rst b/README.rst index 97c22d17d..a09140f7b 100644 --- a/README.rst +++ b/README.rst @@ -45,67 +45,9 @@ Andere nennenswerte BO4E Implementierungen * `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: - -.. code-block:: Python - - 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. - - .. _`BO4E website`: https://www.bo4e.de/dokumentation .. _`C#/.NET`: https://github.com/Hochfrequenz/BO4E-dotnet .. _`Golang`: https://github.com/Hochfrequenz/go-bo4e/ .. _`Kotlin`: https://github.com/openEnWi/ktBO4E-lib .. _`TypeScript`: https://github.com/openEnWi/tsBO4E-lib -.. _`Hochfrequenz Unternehmensberatung GmbH`: https://www.hochfrequenz.de -.. _`Kununu ratings`: https://www.kununu.com/de/hochfrequenz-unternehmensberatung1 -.. _`career page`: https://www.hochfrequenz.de/karriere/stellenangebote/full-stack-entwickler/ -.. _`master branch`: https://github.com/Hochfrequenz/BO4E-python/tree/master -.. _`tox`: https://pypi.org/project/tox/ .. _`Contribution Guide`: CONTRIBUTING.md -.. _`Retrieving package version at runtime`: https://pypi.org/project/setuptools-scm/ -.. _`regex101`: https://regex101.com/r/JWeb51/2