Merge branch 'develop' into update/api_V3.1

Author: s-heppner

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: ci
 on: [push, pull_request]
 
 env:
-  X_PYTHON_MIN_VERSION: "3.9"
+  X_PYTHON_MIN_VERSION: "3.10"
   X_PYTHON_MAX_VERSION: "3.12"
 
 jobs:
@@ -22,7 +22,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r ./check_python_versions_requirements.txt
+          python -m pip install -r ./check_python_versions_requirements.txt
       - name: Check Supported Python Versions
         run: |
           python check_python_versions_supported.py \
@@ -45,7 +45,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.12"]
+        python-version: ["3.10", "3.12"]
     env:
       COUCHDB_ADMIN_PASSWORD: "yo0Quai3"
       # (2024-10-11, s-heppner)
@@ -85,17 +85,17 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .[dev]
+        python -m pip install .[dev]
     - name: Setup test config and CouchDB database server
       run: |
         python test/_helper/setup_testdb.py -u "admin" -p "$COUCHDB_ADMIN_PASSWORD"
     - name: Test with coverage + unittest
       run: |
-        coverage run --source=basyx -m unittest
+        python -m coverage run --source=basyx -m unittest
     - name: Report test coverage
       if: ${{ always() }}
       run: |
-        coverage report -m
+        python -m coverage report -m
 
   sdk-static-analysis:
     # This job runs static code analysis, namely pycodestyle and mypy
@@ -112,13 +112,13 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .[dev]
+        python -m pip install .[dev]
     - name: Check typing with MyPy
       run: |
-        mypy basyx test
+        python -m mypy basyx test
     - name: Check code style with PyCodestyle
       run: |
-        pycodestyle --count --max-line-length 120 basyx test
+        python -m pycodestyle --count --max-line-length 120 basyx test
 
   sdk-readme-codeblocks:
     # This job runs the same static code analysis (mypy and pycodestyle) on the codeblocks in our docstrings.
@@ -135,16 +135,17 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .[dev]
+        python -m pip install .[dev]
     - name: Check typing with MyPy
+      shell: bash
       run: |
-        mypy <(codeblocks python README.md)
+        python -m mypy <(python -m codeblocks python README.md)
     - name: Check code style with PyCodestyle
       run: |
-        codeblocks --wrap python README.md | pycodestyle --count --max-line-length 120 -
+        python -m codeblocks --wrap python README.md | python -m pycodestyle --count --max-line-length 120 -
     - name: Run readme codeblocks with Python
       run: |
-        codeblocks python README.md | python
+        python -m codeblocks python README.md | python
 
   sdk-docs:
     # This job checks, if the automatically generated documentation using sphinx can be compiled
@@ -161,7 +162,7 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .[docs]
+        python -m pip install .[docs]
     - name: Check documentation for errors
       run: |
         SPHINXOPTS="-a -E -n -W --keep-going" make -C docs html
@@ -181,7 +182,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build
+        python -m pip install build
     - name: Create source and wheel dist
       run: |
         python -m build
@@ -208,7 +209,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.12"]
+        python-version: ["3.10", "3.12"]
     defaults:
       run:
         working-directory: ./compliance_tool
@@ -223,15 +224,15 @@ jobs:
       # install the local sdk in editable mode so it does not get overwritten
       run: |
         python -m pip install --upgrade pip
-        pip install -e ../sdk[dev]
-        pip install .[dev]
+        python -m pip install ../sdk
+        python -m pip install .[dev]
     - name: Test with coverage + unittest
       run: |
-        coverage run --source=aas_compliance_tool -m unittest
+        python -m coverage run --source=aas_compliance_tool -m unittest
     - name: Report test coverage
       if: ${{ always() }}
       run: |
-        coverage report -m
+        python -m coverage report -m
 
   compliance-tool-static-analysis:
     # This job runs static code analysis, namely pycodestyle and mypy
@@ -250,14 +251,14 @@ jobs:
       # install the local sdk in editable mode so it does not get overwritten
       run: |
         python -m pip install --upgrade pip
-        pip install -e ../sdk[dev]
-        pip install .[dev]
+        python -m pip install ../sdk
+        python -m pip install .[dev]
     - name: Check typing with MyPy
       run: |
-        mypy aas_compliance_tool test
+        python -m mypy aas_compliance_tool test
     - name: Check code style with PyCodestyle
       run: |
-        pycodestyle --count --max-line-length 120 aas_compliance_tool test
+        python -m pycodestyle --count --max-line-length 120 aas_compliance_tool test
 
   compliance-tool-package:
     # This job checks if we can build our compliance_tool package
@@ -275,7 +276,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build
+        python -m pip install build
     - name: Create source and wheel dist
       run: |
         python -m build
@@ -291,7 +292,7 @@ jobs:
 
     defaults:
       run:
-        working-directory: ./server/app
+        working-directory: ./server
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
@@ -301,26 +302,26 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install ../../sdk
-        pip install .[dev]
+        python -m pip install ../sdk
+        python -m pip install .[dev]
     - name: Check typing with MyPy
       run: |
-        mypy .
+        python -m mypy app test
     - name: Check code style with PyCodestyle
       run: |
-        pycodestyle --count --max-line-length 120 .
+        python -m pycodestyle --count --max-line-length 120 app test
 
-  server-package:
+  server-repository-docker:
     # This job checks if we can build our server package
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./server
+        working-directory: ./server/docker/repository
     steps:
       - uses: actions/checkout@v4
       - name: Build the Docker image
         run: |
-          docker build -t basyx-python-server -f Dockerfile ..
+          docker build -t basyx-python-server -f Dockerfile ../../..
       - name: Run container
         run: |
            docker run -d --name basyx-python-server basyx-python-server

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   sdk-publish:
-    # This job publishes the SDK package to PyPI
+    # This job publishes the package to PyPI
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -58,3 +58,43 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_ORG_TOKEN }}
+
+  server-publish:
+    # This job publishes the server docker image to DockerHub
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./server
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Extract Docker image metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: eclipsebasyx/basyx-python-server
+          # This fetches the latest git tag and adds an additional "latest" to it, so e.g. `2.1.0,latest`
+          tags: |
+            type=semver,pattern={{version}}
+            type=raw,value=latest
+          labels: |
+            org.opencontainers.image.title=BaSyx Python Server
+            org.opencontainers.image.description=Eclipse BaSyx Python SDK - HTTP Server
+            org.opencontainers.image.source=https://github.com/eclipse-basyx/basyx-python-sdk/tree/main/server
+            org.opencontainers.image.licenses=MIT
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKER_HUB_USER }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+
+      - name: Build and Push Docker Image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./server/Dockerfile  # Todo: Update paths
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -21,7 +21,7 @@ htmlcov/
 docs/build/
 .hypothesis/
 
-# customized config files
+# Customized config files
 sdk/test/test_config.ini
 # Schema files needed for testing
 sdk/test/adapter/schemas
@@ -31,5 +31,6 @@ sdk/basyx/version.py
 compliance_tool/aas_compliance_tool/version.py
 server/app/version.py
 
-# ignore the content of the server storage
+# Ignore the content of the server storage
+server/input/
 server/storage/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 the Eclipse BaSyx Authors
+Copyright (c) 2019-2026 the Eclipse BaSyx Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,10 +1,11 @@
 # Eclipse BaSyx Python SDK
 
-(formerly known as PyI40AAS – Python Industry 4.0 Asset Administration Shell)
-
 The Eclipse BaSyx Python project focuses on providing a Python implementation of the Asset Administration Shell (AAS) 
-for Industry 4.0 Systems. 
-These are the currently implemented specifications:
+for Industry 4.0 Systems.
+
+**Please note that the SDK version number is independent of the supported AAS versions!**
+
+These are the implemented AAS specifications of the [current SDK release](https://github.com/eclipse-basyx/basyx-python-sdk/releases/latest), which can be also found on [PyPI](https://pypi.org/project/basyx-python-sdk/):
 
 | Specification                         | Version                                                                                                                                                                         |
 |---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -14,6 +15,9 @@ These are the currently implemented specifications:
 | Part 3a: Data Specification IEC 61360 | [v3.0 (01003-a-3-0)](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01003-a-3-0_SpecificationAssetAdministrationShell_Part3a_DataSpecification_IEC61360.pdf) |
 | Part 5: Package File Format (AASX)    | [v3.0 (01005-3-0)](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01005-3-0_SpecificationAssetAdministrationShell_Part5_AASXPackageFileFormat.pdf)           |
 
+If you need support to an older version of the specifications, please refer to our [prior releases](https://github.com/eclipse-basyx/basyx-python-sdk/releases). 
+Each of them has a similar table at the top of the release notes.
+
 ## Features
 This repository is structured into separate packages. 
 The `sdk` directory provides the AAS metamodel as Python objects and fundamental functionalities to handle AAS.