Merge pull request #597 from eclipse-basyx/develop

Release 2.1.0

Author: s-heppner

.github/workflows/ci.yml

@@ -53,7 +53,7 @@ jobs:
       # that you want to use to test the serialization adapter against.
       # Currently, we need to update this manually, however I'm afraid this is not possible to automatically infer,
       # since it's heavily dependant of the version of the AAS specification we support.
-      AAS_SPECS_RELEASE_TAG: "IDTA-01001-3-0-1_schemasV3.0.8"
+      AAS_SPECS_RELEASE_TAG: "IDTA-01001-3-1-2"
     services:
       couchdb:
         image: couchdb:3
@@ -203,7 +203,6 @@ jobs:
         chmod +x ./etc/scripts/set_copyright_year.sh
         ./etc/scripts/set_copyright_year.sh --check
 
-
   compliance-tool-test:
     # This job runs the unittests on the python versions specified down at the matrix
     runs-on: ubuntu-latest
@@ -216,12 +215,17 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        # TODO(#592): revisit when the sdk<->compliance_tool version pinning is fixed.
+        # Need tags so setuptools_scm builds the local sdk as >=1.0.0, else the loose
+        # `basyx-python-sdk>=1.0.0` pin lets pip replace it with the PyPI release.
+        fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Python dependencies
-      # install the local sdk in editable mode so it does not get overwritten
+      # install the local sdk first so its version satisfies the >=1.0.0 pin and pip keeps it instead of PyPI
       run: |
         python -m pip install --upgrade pip
         python -m pip install ../sdk
@@ -243,12 +247,17 @@ jobs:
         working-directory: ./compliance_tool
     steps:
     - uses: actions/checkout@v4
+      with:
+        # TODO(#592): revisit when the sdk<->compliance_tool version pinning is fixed.
+        # Need tags so setuptools_scm builds the local sdk as >=1.0.0, else the loose
+        # `basyx-python-sdk>=1.0.0` pin lets pip replace it with the PyPI release.
+        fetch-depth: 0
     - name: Set up Python ${{ env.X_PYTHON_MIN_VERSION }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ env.X_PYTHON_MIN_VERSION }}
     - name: Install Python dependencies
-      # install the local sdk in editable mode so it does not get overwritten
+      # install the local sdk first so its version satisfies the >=1.0.0 pin and pip keeps it instead of PyPI
       run: |
         python -m pip install --upgrade pip
         python -m pip install ../sdk
@@ -292,7 +301,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 }}
@@ -302,26 +311,26 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install ../../sdk
+        python -m pip install ../sdk
         python -m pip install .[dev]
     - name: Check typing with MyPy
       run: |
-        python -m mypy .
+        python -m mypy app test
     - name: Check code style with PyCodestyle
       run: |
-        python -m 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

@@ -4,6 +4,9 @@ on:
   release:
     types: [published]
 
+env:
+  TARGET_PLATFORM: "linux/amd64,linux/arm/v7,linux/arm64"
+
 jobs:
   sdk-publish:
     # This job publishes the package to PyPI
@@ -59,7 +62,54 @@ jobs:
         with:
           password: ${{ secrets.PYPI_ORG_TOKEN }}
 
-  server-publish:
+  server-repository-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-repository
+          # 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 Repository Service
+            org.opencontainers.image.description=Eclipse BaSyx Python SDK - Repository 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: Setup QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build and Push Repository Docker Image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./server/docker/repository/Dockerfile
+          platforms: ${{ env.TARGET_PLATFORM }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  server-discovery-publish:
     # This job publishes the server docker image to DockerHub
     runs-on: ubuntu-latest
     defaults:
@@ -73,14 +123,14 @@ jobs:
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: eclipsebasyx/basyx-python-server
+          images: eclipsebasyx/basyx-python-discovery
           # 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.title=BaSyx Python Discovery Service
+            org.opencontainers.image.description=Eclipse BaSyx Python SDK - Discovery HTTP Server
             org.opencontainers.image.source=https://github.com/eclipse-basyx/basyx-python-sdk/tree/main/server
             org.opencontainers.image.licenses=MIT
 
@@ -90,11 +140,65 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
 
-      - name: Build and Push Docker Image
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build and Push Repository Docker Image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./server/docker/discovery/Dockerfile
+          platforms: ${{ env.TARGET_PLATFORM }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  server-registry-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-registry
+          # 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 Registry Service
+            org.opencontainers.image.description=Eclipse BaSyx Python SDK - Registry 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: Setup QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build and Push Repository Docker Image
         uses: docker/build-push-action@v6
         with:
           context: .
-          file: ./server/Dockerfile  # Todo: Update paths
+          file: ./server/docker/registry/Dockerfile
+          platforms: ${{ env.TARGET_PLATFORM }}
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -32,5 +32,8 @@ compliance_tool/aas_compliance_tool/version.py
 server/app/version.py
 
 # Ignore the content of the server storage
-server/input/
-server/storage/
+server/example_configurations/repository_standalone/input/
+server/example_configurations/repository_standalone/storage/
+server/example_configurations/registry_standalone/input/
+server/example_configurations/registry_standalone/storage/
+server/example_configurations/discovery_standalone/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

@@ -7,13 +7,14 @@ for Industry 4.0 Systems.
 
 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                                                                                                                                                                         |
-|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Part 1: Metamodel                     | [v3.0.1 (01001-3-0-1)](https://industrialdigitaltwin.org/wp-content/uploads/2024/06/IDTA-01001-3-0-1_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf)                   |
-| Schemata (JSONSchema, XSD)            | [v3.0.8 (IDTA-01001-3-0-1_schemasV3.0.8)](https://github.com/admin-shell-io/aas-specs/releases/tag/IDTA-01001-3-0-1_schemasV3.0.8)                                              |
-| Part 2: API                           | [v3.0 (01002-3-0)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2023/06/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API_.pdf)                 |
-| 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)           |
+| Specification                         | Version                                                                                                                                            |
+|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| Part 1: Metamodel                     | [v3.1.2 (01001-3-1-2)](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/index.html)                                           |
+| Schemata (JSONSchema, XSD)            | [v3.1.2 (IDTA-01001-3-1-2)](https://github.com/admin-shell-io/aas-specs-metamodel/releases/tag/v3.1.2)                                             |
+| Part 2: API                           | [v3.1.1 (01002)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2025/08/IDTA-01002-3-1-1_AAS-Specification_Part2_API.pdf)         |
+| Part 3a: Data Specification IEC 61360 | [v3.1.1 (01003-a)](https://industrialdigitaltwin.org/wp-content/uploads/2025/08/IDTA-01003-a-3-1-1_AAS-Specification_Part3a_DataSpecification.pdf) |
+| Part 5: Package File Format (AASX)    | [v3.1 (01005)](https://industrialdigitaltwin.org/wp-content/uploads/2025/06/IDTA_01005-25-01_AAS-Specification_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.
@@ -22,7 +23,7 @@ Each of them has a similar table at the top of the release notes.
 This repository is structured into separate packages. 
 The `sdk` directory provides the AAS metamodel as Python objects and fundamental functionalities to handle AAS.
 The `server` implements a specification-compliant Docker HTTP server for AASs.
-The `compliance_tool` is to be determined.
+The `compliance_tool` is a command-line tool for checking whether JSON and XML files comply with the AAS specification.
 
 * [SDK](./sdk/README.md):
   * Modelling of AASs as Python objects
@@ -35,6 +36,9 @@ The `compliance_tool` is to be determined.
 * [Server](./server/README.md): Docker Image of a specification compliant HTTP Server implementing the interfaces:
   * Asset Administration Shell Repository
   * Submodel Repository
+  * Asset Administration Shell Registry Service
+  * Submodel Registry Service
+  * Discovery
 * [Compliance Tool](./compliance_tool/README.md): A command-line tool for checking compliance of JSON and XML files
   to the specification of the AAS
 

compliance_tool/README.md

@@ -10,6 +10,38 @@ Shell elements
 * check if the data in a given xml, json or aasx file is the same as the example data
 * check if two given xml, json or aasx files contain the same Asset Administration Shell elements in any order 
 
+## Installation
+
+### Default installation
+Install the latest release from PyPI:
+
+```bash
+pip install basyx-compliance-tool
+```
+
+### Developer installation
+When working from a checkout of this repository, install the sibling SDK from the source tree *first*, then the 
+compliance tool:
+
+```bash
+pip install ./sdk
+pip install ./compliance_tool
+```
+
+Installing the local SDK first is what lets the tool check against your in-development metamodel: `pip` keeps the 
+already-installed local SDK instead of pulling a release from PyPI.
+
+> [!IMPORTANT]
+> The compliance checks are only as current as the installed `basyx-python-sdk` — the tool reports compliance against 
+> whatever metamodel version that SDK implements, not against the version named in this README. Because the dependency 
+> is currently declared loosely (`basyx-python-sdk>=1.0.0`), `pip` will **not** replace an SDK that is already installed 
+> and satisfies that constraint, even if it is older than the one you intend to test against. This happens silently, with 
+> no error. To be sure you are checking against the intended metamodel, install or upgrade the SDK explicitly, e.g. the 
+> local source tree with `pip install ./sdk` or a specific release with `pip install --upgrade "basyx-python-sdk==2.1.0"`.
+>
+> This manual version matching is a temporary workaround; see #592.
+
+## Usage
 Invoking should work with either `python -m aas_compliance_tool.cli` or (when installed correctly and PATH is set 
 correctly) with `aas-compliance-check` on the command line.