Modernize python build setup, protoc dependency

This moves most meta-data to pyproject.toml, automates the version
handling and makes it available at runtime, depends on protoc via
the protoc-wheel-0 package, makes sdist and bdist distributions
work correctly, and removes dependencies that are not build
dependencies, but rather used only in CI.

Signed-off-by: Pierre R. Mai <pmai@pmsf.de>

Author: pmai

.github/workflows/antora-generator.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
     - name: Trigger generator
       if: ${{ env.MUP_KEY != '' }}
-      uses: peter-evans/repository-dispatch@v2
+      uses: peter-evans/repository-dispatch@v3
       with:
         token: ${{ secrets.MACHINE_USER_PAT }}
         event-type: antora-build-trigger

.github/workflows/protobuf.yml

@@ -30,17 +30,19 @@ jobs:
     - name: Install Python Dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -r requirements_develop.txt
+        python -m pip install build
+        python -m pip install -r requirements_tests.txt
 
     - name: Check black format
-      run: black --check --diff .
+      run: |
+        black --check --diff .
 
     - name: Install Doxygen
       run: sudo apt-get install doxygen graphviz
 
     - name: Cache Dependencies
       id: cache-depends
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: protobuf-${{ env.PROTOBUF_VERSION }}
         key: ${{ runner.os }}-v2-depends
@@ -73,10 +75,14 @@ jobs:
     - name: Prepare C++ Build
       run: mkdir build
 
-    # Versioning
-    - name: Get versioning
+    - name: Add Development Version Suffix
+      if: ${{ !startsWith(github.ref, 'refs/tags') }}
+      run: |
+        echo "VERSION_SUFFIX = .dev`date -u '+%Y%m%d%H%M%S'`" >> VERSION
+
+    - name: Get git Version
       id: get_version
-      run: echo "VERSION=$(git describe --always)" >> $GITHUB_OUTPUT 
+      run: echo "VERSION=$(git describe --tags --always)" >> $GITHUB_OUTPUT 
 
     - name: Prepare Documentation Build
       run: |
@@ -93,7 +99,7 @@ jobs:
       run: cmake --build . --config Release -j 4
 
     - name: Build Python
-      run: python setup.py build && python setup.py sdist
+      run: python -m build
 
     - name: Install Python
       run: python -m pip install .
@@ -133,11 +139,14 @@ jobs:
         python-version: '3.8'
 
     - name: Install Python Dependencies
-      run: python -m pip install --upgrade pip setuptools wheel pyyaml
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install build
+        python -m pip install -r requirements_tests.txt
 
     - name: Cache Dependencies
       id: cache-depends
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: protobuf-${{ env.PROTOBUF_VERSION }}
         key: ${{ runner.os }}-v2-depends
@@ -172,6 +181,11 @@ jobs:
         bash convert-to-proto3.sh
         rm *.pb2
 
+    - name: Add Development Version Suffix
+      if: ${{ !startsWith(github.ref, 'refs/tags') }}
+      run: |
+        echo "VERSION_SUFFIX = .dev`date -u '+%Y%m%d%H%M%S'`" >> VERSION
+
     - name: Configure C++ Build
       working-directory: build
       run: cmake ${{ env.PROTOBUF_VARIANT =='' && '-DCMAKE_CXX_STANDARD=17' }} ..
@@ -181,7 +195,7 @@ jobs:
       run: cmake --build . --config Release -j 4
 
     - name: Build Python
-      run: python setup.py build && python setup.py sdist
+      run: python -m build
 
     - name: Install Python
       run: python -m pip install .

.gitignore

@@ -20,8 +20,6 @@ build
 cmake_install.cmake
 install_manifest.txt
 osi_version.proto
-version.py
-pyproject.toml
 
 compile_commands.json
 

MANIFEST.in

@@ -0,0 +1 @@
+include VERSION

pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "protoc-wheel-0==24.4",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "open-simulation-interface"
+description = "ASAM Open Simulation Interface Python Bindings."
+authors = [
+    {name = "ASAM Open Simulation Interface Project", email = "osi@asam.net"},
+]
+maintainers = [
+    {name = "ASAM Open Simulation Interface Project", email = "osi@asam.net"},
+]
+dependencies = [
+    "protobuf>=4.24.4",
+]
+
+license = {file = "LICENSE"}
+readme = "README.md"
+classifiers = [
+    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/OpenSimulationInterface/open-simulation-interface"
+Repository = "https://github.com/OpenSimulationInterface/open-simulation-interface.git"
+"Bug Tracker" = "https://github.com/OpenSimulationInterface/open-simulation-interface/issues"

requirements_develop.txt renamed to requirements_tests.txt

@@ -1,4 +1,2 @@
-setuptools
-wheel
 pyyaml
 black==23.12.1

setup.py

@@ -7,38 +7,41 @@
 import re
 from distutils.spawn import find_executable
 
-# setuptool is dependend on wheel package
 from setuptools import setup
+from setuptools.command.sdist import sdist
 from setuptools.command.build_py import build_py
 
-# configure the version number
-from shutil import copyfile
-
-copyfile("VERSION", "version.py")
-from version import *
+# protoc
+from protoc import PROTOC_EXE
 
-with open("osi_version.proto.in", "rt") as fin:
-    with open("osi_version.proto", "wt") as fout:
-        for line in fin:
-            lineConfigured = line.replace("@VERSION_MAJOR@", str(VERSION_MAJOR))
-            lineConfigured = lineConfigured.replace(
-                "@VERSION_MINOR@", str(VERSION_MINOR)
-            )
-            lineConfigured = lineConfigured.replace(
-                "@VERSION_PATCH@", str(VERSION_PATCH)
-            )
-            fout.write(lineConfigured)
+# configure the version number
+VERSION_MAJOR = None
+VERSION_MINOR = None
+VERSION_PATCH = None
+VERSION_SUFFIX = None
+with open("VERSION", "rt") as versionin:
+    for line in versionin:
+        if line.startswith("VERSION_MAJOR"):
+            VERSION_MAJOR = int(line.split("=")[1].strip())
+        if line.startswith("VERSION_MINOR"):
+            VERSION_MINOR = int(line.split("=")[1].strip())
+        if line.startswith("VERSION_PATCH"):
+            VERSION_PATCH = int(line.split("=")[1].strip())
+        if line.startswith("VERSION_SUFFIX"):
+            VERSION_SUFFIX = line.split("=")[1].strip()
 
 package_name = "osi3"
 package_path = os.path.join(os.getcwd(), package_name)
 
 
-class GenerateProtobufCommand(build_py):
+class ProtobufGenerator:
     @staticmethod
     def find_protoc():
         """Locates protoc executable"""
 
-        if "PROTOC" in os.environ and os.path.exists(os.environ["PROTOC"]):
+        if os.path.exists(PROTOC_EXE):
+            protoc = PROTOC_EXE
+        elif "PROTOC" in os.environ and os.path.exists(os.environ["PROTOC"]):
             protoc = os.environ["PROTOC"]
         else:
             protoc = find_executable("protoc")
@@ -89,7 +92,19 @@ def find_protoc():
 
     """ Generate Protobuf Messages """
 
-    def run(self):
+    def generate(self):
+        sys.stdout.write("Generating Protobuf Version Message\n")
+        with open("osi_version.proto.in", "rt") as fin:
+            with open("osi_version.proto", "wt") as fout:
+                for line in fin:
+                    lineConfigured = line.replace("@VERSION_MAJOR@", str(VERSION_MAJOR))
+                    lineConfigured = lineConfigured.replace(
+                        "@VERSION_MINOR@", str(VERSION_MINOR)
+                    )
+                    lineConfigured = lineConfigured.replace(
+                        "@VERSION_PATCH@", str(VERSION_PATCH)
+                    )
+                    fout.write(lineConfigured)
         pattern = re.compile('^import "osi_')
         for source in self.osi_files:
             with open(source) as src_file:
@@ -103,38 +118,46 @@ def run(self):
             source_path = os.path.join(package_name, source)
             subprocess.check_call([self.find_protoc(), "--python_out=.", source_path])
 
+    def maybe_generate(self):
+        if os.path.exists("osi_version.proto.in"):
+            self.generate()
+
+
+class CustomBuildPyCommand(build_py):
+    def run(self):
+        ProtobufGenerator().maybe_generate()
         build_py.run(self)
 
 
+class CustomSDistCommand(sdist):
+    def run(self):
+        ProtobufGenerator().generate()
+        sdist.run(self)
+
+
 try:
     os.mkdir(package_path)
 except Exception:
     pass
 
 try:
-    open(os.path.join(package_path, "__init__.py"), "a").close()
+    with open(os.path.join(package_path, "__init__.py"), "wt") as init_file:
+        init_file.write(
+            f"__version__ = '{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_PATCH}{VERSION_SUFFIX or ''}'\n"
+        )
 except Exception:
     pass
 
 setup(
-    name="open-simulation-interface",
-    version=str(VERSION_MAJOR) + "." + str(VERSION_MINOR) + "." + str(VERSION_PATCH),
-    description="A generic interface for the environmental perception of"
-    "automated driving functions in virtual scenarios.",
-    author="Carlo van Driesten, Timo Hanke, Nils Hirsenkorn,"
-    "Pilar Garcia-Ramos, Mark Schiementz, Sebastian Schneider",
-    author_email="Carlo.van-Driesten@bmw.de, Timo.Hanke@bmw.de,"
-    "Nils.Hirsenkorn@tum.de, Pilar.Garcia-Ramos@bmw.de,"
-    "Mark.Schiementz@bmw.de, Sebastian.SB.Schneider@bmw.de",
+    version=str(VERSION_MAJOR)
+    + "."
+    + str(VERSION_MINOR)
+    + "."
+    + str(VERSION_PATCH)
+    + (VERSION_SUFFIX or ""),
     packages=[package_name],
-    install_requires=["protobuf"],
     cmdclass={
-        "build_py": GenerateProtobufCommand,
+        "sdist": CustomSDistCommand,
+        "build_py": CustomBuildPyCommand,
     },
-    url="https://github.com/OpenSimulationInterface/open-simulation-interface",
-    license="MPL 2.0",
-    classifiers=[
-        "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
-    ],
-    data_files=[("", ["LICENSE"])],
 )