aas-standard-parser 0.2.1__tar.gz → 0.3.1__tar.gz

aas_standard_parser-0.3.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: aas-standard-parser
+Version: 0.3.1
+Summary: Some auxiliary functions for parsing standard submodels
+Author-email: Daniel Klein <daniel.klein@em.ag>
+License: MIT License
+        
+        Copyright (c) 2025 Fluid4.0
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fluid40/aas-standard-parser
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing>=3.7.4.3
+Requires-Dist: basyx-python-sdk>=1.2.1
+Dynamic: license-file
+
+# aas-standard-parser
+
+<div align="center">
+<!-- change this to your projects logo if you have on.
+  If you don't have one it might be worth trying chatgpt dall-e to create one for you...
+ -->
+<img src="docs/assets/fluid_logo.svg" alt="aas_standard_parser" width=500 />
+</div>
+
+---
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-%23f8a602?label=License&labelColor=%23992b2e)](LICENSE)
+[![CI](https://github.com/fluid40/aas-standard-parser/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-standard-parser/actions)
+[![PyPI version](https://img.shields.io/pypi/v/aas-standard-parser.svg)](https://pypi.org/project/aas-standard-parser/)
+
+
+This project provides tools for parsing and handling Asset Administration Shell (AAS) standard submodels, with a focus on AID and AIMC submodels. It enables:
+
+- Extraction, interpretation, and mapping of submodel elements and their properties
+- Working with references, semantic IDs, and submodel element collections
+- Representation and processing of mapping configurations and source-sink relations
+- Structured and colored logging, including log file management
+
+These components enable efficient parsing, transformation, and analysis of AAS submodels in Python-based workflows.
+> **Note:** Most functions in this project utilize the [python aas sdk framework](https://github.com/aas-core-works/aas-core3.0-python) for parsing and handling AAS submodels, ensuring compatibility with the official AAS data models and structures.
+---
+
+## Provided Parsers
+
+- **AID Parser**: Parses AID submodels to extract interface descriptions, properties, and security/authentication details.
+- **AIMC Parser**: Parses AIMC submodels to extract and process mapping configurations and source-sink relations.
+- **AAS Parser**: Utilities to extract submodel IDs from an Asset Administration Shell.
+- **Submodel Parser**: Helpers to retrieve submodel elements by semantic ID or by path within a submodel.
+
+## Helper Modules
+
+- **Collection Helpers**: Functions to search and filter submodel elements by semantic ID, idShort, or supplemental semantic ID within collections.
+- **Reference Helpers**: Utilities for working with references, such as constructing idShort paths and extracting values from reference keys.
+- **Utilities**: General utility functions, including loading a submodel from a file.
+
+---
+
+## API References
+- AID Parser
+- AIMC Parser
+- [AAS Parser](docs/api_references/api_aas_parser.md)
+- [Submodel Parser](docs/api_references/api_submodel_parser.md)
+- Collection Helpers
+- [Reference Helpers](docs/api_references/api_reference_helpers.md)
+- [Utilities](docs/api_references/api_utils.md)
+
+## Resources
+
+🤖 [Releases](http://github.com/fluid40/aas-standard-parser/releases)
+
+📦 [Pypi Packages](https://pypi.org/project/aas-standard-parser/)
+
+📜 [MIT License](LICENSE)

aas_standard_parser-0.3.1/README.md

@@ -0,0 +1,58 @@
+# aas-standard-parser
+
+<div align="center">
+<!-- change this to your projects logo if you have on.
+  If you don't have one it might be worth trying chatgpt dall-e to create one for you...
+ -->
+<img src="docs/assets/fluid_logo.svg" alt="aas_standard_parser" width=500 />
+</div>
+
+---
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-%23f8a602?label=License&labelColor=%23992b2e)](LICENSE)
+[![CI](https://github.com/fluid40/aas-standard-parser/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-standard-parser/actions)
+[![PyPI version](https://img.shields.io/pypi/v/aas-standard-parser.svg)](https://pypi.org/project/aas-standard-parser/)
+
+
+This project provides tools for parsing and handling Asset Administration Shell (AAS) standard submodels, with a focus on AID and AIMC submodels. It enables:
+
+- Extraction, interpretation, and mapping of submodel elements and their properties
+- Working with references, semantic IDs, and submodel element collections
+- Representation and processing of mapping configurations and source-sink relations
+- Structured and colored logging, including log file management
+
+These components enable efficient parsing, transformation, and analysis of AAS submodels in Python-based workflows.
+> **Note:** Most functions in this project utilize the [python aas sdk framework](https://github.com/aas-core-works/aas-core3.0-python) for parsing and handling AAS submodels, ensuring compatibility with the official AAS data models and structures.
+---
+
+## Provided Parsers
+
+- **AID Parser**: Parses AID submodels to extract interface descriptions, properties, and security/authentication details.
+- **AIMC Parser**: Parses AIMC submodels to extract and process mapping configurations and source-sink relations.
+- **AAS Parser**: Utilities to extract submodel IDs from an Asset Administration Shell.
+- **Submodel Parser**: Helpers to retrieve submodel elements by semantic ID or by path within a submodel.
+
+## Helper Modules
+
+- **Collection Helpers**: Functions to search and filter submodel elements by semantic ID, idShort, or supplemental semantic ID within collections.
+- **Reference Helpers**: Utilities for working with references, such as constructing idShort paths and extracting values from reference keys.
+- **Utilities**: General utility functions, including loading a submodel from a file.
+
+---
+
+## API References
+- AID Parser
+- AIMC Parser
+- [AAS Parser](docs/api_references/api_aas_parser.md)
+- [Submodel Parser](docs/api_references/api_submodel_parser.md)
+- Collection Helpers
+- [Reference Helpers](docs/api_references/api_reference_helpers.md)
+- [Utilities](docs/api_references/api_utils.md)
+
+## Resources
+
+🤖 [Releases](http://github.com/fluid40/aas-standard-parser/releases)
+
+📦 [Pypi Packages](https://pypi.org/project/aas-standard-parser/)
+
+📜 [MIT License](LICENSE)

aas_standard_parser-0.3.1/aas_standard_parser/__init__.py

@@ -0,0 +1,44 @@
+"""AAS Standard parser Package."""
+
+import importlib.metadata
+from datetime import datetime, timezone
+
+from aas_standard_parser import (
+    aas_parser,
+    aid_parser,
+    aimc_parser,
+    collection_helpers,
+    reference_helpers,
+    submodel_json_parser,
+    submodel_parser,
+    utils,
+)
+from aas_standard_parser.aid_parser import AIDParser
+from aas_standard_parser.version_check import check_for_update
+
+__copyright__ = f"Copyright (C) {datetime.now(tz=timezone.utc).year} Fluid 4.0. All rights reserved."
+__author__ = "Daniel Klein, Celina Adelhardt, Tom Gneuß"
+
+try:
+    __license__ = "MIT"
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0-dev"
+
+__project__ = "aas-standard-parser"
+__package__ = "aas-standard-parser"
+
+
+check_for_update()
+
+__all__ = [
+    "AIDParser",
+    "aas_parser",
+    "aid_parser",
+    "aimc_parser",
+    "collection_helpers",
+    "reference_helpers",
+    "submodel_json_parser",
+    "submodel_parser",
+    "utils",
+]

aas_standard_parser-0.3.1/aas_standard_parser/aas_parser.py

@@ -0,0 +1,24 @@
+"""Module for parsing AAS."""
+
+import logging
+
+from basyx.aas import model
+
+logger = logging.getLogger(__name__)
+
+
+def get_submodel_ids(shell: model.AssetAdministrationShell) -> list[str]:
+    """Get all IDs from the submodels referenced in the given AAS.
+
+    :param shell: The Asset Administration Shell to extract submodel IDs from.
+    :return: A list of submodel IDs referenced in the AAS.
+    """
+    submodel_ids = []
+    for submodel in shell.submodel:
+        if len(submodel.key) < 1 or submodel.key[0].type != model.KeyTypes.SUBMODEL:
+            logger.warning(f"Submodel reference {submodel} does not start with SUBMODEL key type.")
+            continue
+
+        submodel_ids.append(submodel.key[0].value)
+
+    return submodel_ids

{aas_standard_parser-0.2.1 → aas_standard_parser-0.3.1}/aas_standard_parser/aimc_parser.py

@@ -1,64 +1,15 @@
 """Parser for Mapping Configurations in AIMC Submodel."""
 
-import json
 import logging
-from dataclasses import field
 
-import basyx.aas.adapter.json
 from basyx.aas import model
 
 import aas_standard_parser.collection_helpers as ch
+from aas_standard_parser.classes.aimc_parser_classes import MappingConfiguration, MappingConfigurations, ReferenceProperties, SourceSinkRelation
 
 logger = logging.getLogger(__name__)
 
 
-class ReferenceProperties:
-    """Class representing properties of a reference in the mapping configuration."""
-
-    reference: model.ExternalReference = field(metadata={"description": "Reference to the property in the submodel."})
-    submodel_id: str = field(metadata={"description": "Identifier of the submodel used by the reference."})
-    property_name: str = field(metadata={"description": "Name of the mapped property."})
-    parent_path: list[str] = field(metadata={"description": "List of idShorts representing the parent path of the reference."})
-
-
-class SourceSinkRelation:
-    """Class representing a source-sink relation in the mapping configuration."""
-
-    source_properties: ReferenceProperties = field(metadata={"description": "Properties of the source reference."})
-    sink_properties: ReferenceProperties = field(metadata={"description": "Properties of the sink reference."})
-
-    def source_as_dict(self) -> dict:
-        """Convert the source reference to a dictionary.
-
-        :return: The source reference as a dictionary.
-        """
-        dict_string = json.dumps(self.source_properties.reference, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        dict_string = dict_string.replace("GlobalReference", "Submodel").replace("FragmentReference", "SubmodelElementCollection")
-        return json.loads(dict_string)
-
-    def sink_as_dict(self) -> dict:
-        """Convert the sink reference to a dictionary.
-
-        :return: The sink reference as a dictionary.
-        """
-        return json.dumps(self.sink_properties.reference, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-
-
-class MappingConfiguration:
-    """Class representing a mapping configuration."""
-
-    interface_reference: model.ReferenceElement = field(metadata={"description": "Reference to the interface in the AID submodel."})
-    aid_submodel_id: str = field(metadata={"description": "Identifier of the AID submodel used by the interface reference."})
-    source_sink_relations: list[SourceSinkRelation] = field(metadata={"description": "List of source-sink relations in the mapping configuration."})
-
-
-class MappingConfigurations:
-    """Class representing mapping configurations from AIMC submodel."""
-
-    configurations: list[MappingConfiguration] = field(metadata={"description": "List of mapping configurations."})
-    aid_submodel_ids: list[str] = field(metadata={"description": "List of AID submodel IDs used in the mapping configurations."})
-
-
 def get_mapping_configuration_root_element(aimc_submodel: model.Submodel) -> model.SubmodelElementCollection | None:
     """Get the mapping configuration root submodel element collection from the AIMC submodel.
 

aas_standard_parser-0.3.1/aas_standard_parser/classes/aimc_parser_classes.py

@@ -0,0 +1,52 @@
+import json
+from dataclasses import field
+
+import basyx.aas.adapter.json
+from basyx.aas import model
+
+
+class ReferenceProperties:
+    """Class representing properties of a reference in the mapping configuration."""
+
+    reference: model.ExternalReference = field(metadata={"description": "Reference to the property in the submodel."})
+    submodel_id: str = field(metadata={"description": "Identifier of the submodel used by the reference."})
+    property_name: str = field(metadata={"description": "Name of the mapped property."})
+    parent_path: list[str] = field(metadata={"description": "List of idShorts representing the parent path of the reference."})
+
+
+class SourceSinkRelation:
+    """Class representing a source-sink relation in the mapping configuration."""
+
+    source_properties: ReferenceProperties = field(metadata={"description": "Properties of the source reference."})
+    sink_properties: ReferenceProperties = field(metadata={"description": "Properties of the sink reference."})
+
+    def source_reference_as_dict(self) -> dict:
+        """Convert the source reference to a dictionary.
+
+        :return: The source reference as a dictionary.
+        """
+        dict_string = json.dumps(self.source_properties.reference, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        dict_string = dict_string.replace("GlobalReference", "Submodel").replace("FragmentReference", "SubmodelElementCollection")
+        return json.loads(dict_string)
+
+    def sink_reference_as_dict(self) -> dict:
+        """Convert the sink reference to a dictionary.
+
+        :return: The sink reference as a dictionary.
+        """
+        return json.loads(json.dumps(self.sink_properties.reference, cls=basyx.aas.adapter.json.AASToJsonEncoder))
+
+
+class MappingConfiguration:
+    """Class representing a mapping configuration."""
+
+    interface_reference: model.ReferenceElement = field(metadata={"description": "Reference to the interface in the AID submodel."})
+    aid_submodel_id: str = field(metadata={"description": "Identifier of the AID submodel used by the interface reference."})
+    source_sink_relations: list[SourceSinkRelation] = field(metadata={"description": "List of source-sink relations in the mapping configuration."})
+
+
+class MappingConfigurations:
+    """Class representing mapping configurations from AIMC submodel."""
+
+    configurations: list[MappingConfiguration] = field(metadata={"description": "List of mapping configurations."})
+    aid_submodel_ids: list[str] = field(metadata={"description": "List of AID submodel IDs used in the mapping configurations."})

aas_standard_parser-0.3.1/aas_standard_parser/reference_helpers.py

@@ -0,0 +1,38 @@
+"""Helper functions for working with ModelReference objects in the AAS standard parser."""
+
+from basyx.aas.model import ModelReference
+
+
+def construct_id_short_path_from_reference(reference: ModelReference) -> str:
+    """Constructs an idShort path from the given ModelReference.
+
+    :param reference: The ModelReference to construct the idShort path from.
+    :return: The constructed idShort path as a string.
+    """
+    id_short_path: str = ""
+
+    # start from the second Key and omit the Identifiable at the beginning of the list
+    for key in reference.key[1:]:
+        id_short_path += key.value + "."
+
+    # get rid of the trailing dot
+    return id_short_path[:-1]
+
+
+def get_values_from_keys(reference: ModelReference) -> list[str]:
+    """Returns the values from all keys in reference as list.
+
+    :param reference: reference to extract values from
+    :return: list of values from all keys in the reference
+    """
+    return [key.value for key in reference.key]
+
+
+def get_value_from_key_at_index(reference: ModelReference, index: int) -> str:
+    """Returns the value from the key at the given index in reference.
+
+    :param reference: reference to extract value from
+    :param index: index of the key to get the value from
+    :return: value from the key at the given index
+    """
+    return reference.key[index].value

aas_standard_parser-0.3.1/aas_standard_parser/submodel_json_parser.py

@@ -0,0 +1,36 @@
+"""Module for parsing submodels JSON data."""
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def get_value_from_semantic_id_by_index(submodel_data: dict, index: int = 0) -> str | None:
+    """Retrieve the value from the semantic ID from a submodel JSON dictionary by index.
+
+    :param submodel_data: The submodel data as a dictionary.
+    :param index: The index to access if the element is a list or collection, defaults to 0.
+    :return: The value of the found submodel element or None if not found.
+    """
+    if "semanticId" not in submodel_data:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID")
+        return None
+
+    sm_semantic_id = submodel_data.get("semanticId", {})
+    if "keys" not in sm_semantic_id or len(sm_semantic_id["keys"]) == 0:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID keys")
+        return None
+
+    keys = sm_semantic_id.get("keys", [])
+
+    if len(keys) < index + 1:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID key at index {index}")
+        return None
+
+    key = keys[index]
+
+    if "value" not in key:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID value")
+        return None
+
+    return key["value"]

{aas_standard_parser-0.2.1 → aas_standard_parser-0.3.1}/aas_standard_parser/submodel_parser.py

@@ -3,32 +3,19 @@
 import logging
 
 from basyx.aas import model
-from basyx.aas.model import NamespaceSet, SubmodelElement
-
-from aas_standard_parser import collection_helpers
 
 logger = logging.getLogger(__name__)
 
 
-def get_element_by_semantic_id(collection: NamespaceSet[SubmodelElement], semantic_id: str) -> SubmodelElement | None:
-    """Get an element from parent collection by its semantic ID (not recursive).
-
-    :param parent: parent collection to search within
-    :param semantic_id: semantic ID to search for
-    :return: the found submodel element or None if not found
-    """
-    return collection_helpers.find_by_semantic_id(collection, semantic_id)
-
-
-def get_submodel_element_by_path(submodel: model.Submodel, path: str) -> model.SubmodelElement:
-    """Returns a specific submodel element from the submodel at a specific path.
+def get_submodel_element_by_id_short_path(submodel: model.Submodel, id_short_path: str) -> model.SubmodelElement:
+    """Retrieve a specific submodel element from the submodel at a specific idShort path.
 
     :param submodel: The submodel to search within.
-    :param path: IdShort path to the submodel element (dot-separated), e.g., "Element1.Element2[0].Element3".
+    :param id_short_path: IdShort path to the submodel element (dot-separated), e.g., "Element1.Element2[0].Element3".
     :return: The found submodel element or None if not found.
     """
     # Split the path by '.' and traverse the structure
-    parts = path.split(".")
+    parts = id_short_path.split(".")
     current_elements = submodel.submodel_element
     part_index = 0
     for part in parts:

aas_standard_parser-0.3.1/aas_standard_parser/utils.py

@@ -0,0 +1,50 @@
+"""Utility functions for AAS standard parser."""
+
+import json
+import logging
+from pathlib import Path
+from typing import Any
+
+import basyx.aas.adapter.json
+from basyx.aas import model
+
+logger = logging.getLogger(__name__)
+
+
+def create_submodel_from_file(file_path: str) -> model.Submodel:
+    """Loads a Submodel structure from a given JSON file and converts it into a model.Submodel object from the python SDK framework.
+
+    :param file_path: Path to the JSON file containing the Submodel structure.
+    :return: A model.Submodel object representing the loaded Submodel structure.
+    """
+    file = Path(file_path)
+    if not file.exists():
+        raise FileNotFoundError(f"Submodel structure file not found: {file}")
+
+    template_data = {}
+
+    # Load the template JSON file
+    with file.open("r", encoding="utf-8") as f:
+        template_data = json.load(f)
+
+    # Load the template JSON into a Submodel object
+    return _convert_to_object(template_data)
+
+
+def _convert_to_object(content: dict) -> Any | None:
+    """Convert a dictionary to a BaSyx SDK framework object.
+
+    :param content: dictionary to convert
+    :return: BaSyx SDK framework object or None
+    """
+    if not content or len(content) == 0:
+        logger.debug("Empty content provided for conversion to object.")
+        return None
+
+    try:
+        dict_string = json.dumps(content)
+        return json.loads(dict_string, cls=basyx.aas.adapter.json.json_deserialization.AASFromJsonDecoder)
+    except Exception as e:
+        logger.error(f"Decoding error: {e}")
+        logger.error(f"In JSON: {content}")
+        return None

aas_standard_parser-0.3.1/aas_standard_parser/version_check.py

@@ -0,0 +1,28 @@
+"""Utility functions for version checking."""
+
+import importlib.metadata
+import logging
+
+import requests
+
+logger = logging.getLogger(__name__)
+
+
+def check_for_update(package_name="aas-standard-parser"):
+    """Check for updates of the package on PyPI.
+
+    :param package_name: The name of the package to check for updates, defaults to "aas-standard-parser"
+    """
+    try:
+        current_version = importlib.metadata.version(package_name)
+        pypi_url = f"https://pypi.org/pypi/{package_name}/json"
+        latest_version = requests.get(pypi_url, timeout=3).json()["info"]["version"]
+
+        if current_version != latest_version:
+            print(
+                f"⚠️  A new version for package '{package_name}' is available: "
+                f"{latest_version} (currently installed: {current_version}). "
+                f"Use the following command to update the package: pip install --upgrade {package_name}"
+            )
+    except Exception as exc:
+        logger.exception(f"Exception occurred while checking for package update: {exc}")

aas_standard_parser-0.3.1/aas_standard_parser.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: aas-standard-parser
+Version: 0.3.1
+Summary: Some auxiliary functions for parsing standard submodels
+Author-email: Daniel Klein <daniel.klein@em.ag>
+License: MIT License
+        
+        Copyright (c) 2025 Fluid4.0
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fluid40/aas-standard-parser
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing>=3.7.4.3
+Requires-Dist: basyx-python-sdk>=1.2.1
+Dynamic: license-file
+
+# aas-standard-parser
+
+<div align="center">
+<!-- change this to your projects logo if you have on.
+  If you don't have one it might be worth trying chatgpt dall-e to create one for you...
+ -->
+<img src="docs/assets/fluid_logo.svg" alt="aas_standard_parser" width=500 />
+</div>
+
+---
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-%23f8a602?label=License&labelColor=%23992b2e)](LICENSE)
+[![CI](https://github.com/fluid40/aas-standard-parser/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-standard-parser/actions)
+[![PyPI version](https://img.shields.io/pypi/v/aas-standard-parser.svg)](https://pypi.org/project/aas-standard-parser/)
+
+
+This project provides tools for parsing and handling Asset Administration Shell (AAS) standard submodels, with a focus on AID and AIMC submodels. It enables:
+
+- Extraction, interpretation, and mapping of submodel elements and their properties
+- Working with references, semantic IDs, and submodel element collections
+- Representation and processing of mapping configurations and source-sink relations
+- Structured and colored logging, including log file management
+
+These components enable efficient parsing, transformation, and analysis of AAS submodels in Python-based workflows.
+> **Note:** Most functions in this project utilize the [python aas sdk framework](https://github.com/aas-core-works/aas-core3.0-python) for parsing and handling AAS submodels, ensuring compatibility with the official AAS data models and structures.
+---
+
+## Provided Parsers
+
+- **AID Parser**: Parses AID submodels to extract interface descriptions, properties, and security/authentication details.
+- **AIMC Parser**: Parses AIMC submodels to extract and process mapping configurations and source-sink relations.
+- **AAS Parser**: Utilities to extract submodel IDs from an Asset Administration Shell.
+- **Submodel Parser**: Helpers to retrieve submodel elements by semantic ID or by path within a submodel.
+
+## Helper Modules
+
+- **Collection Helpers**: Functions to search and filter submodel elements by semantic ID, idShort, or supplemental semantic ID within collections.
+- **Reference Helpers**: Utilities for working with references, such as constructing idShort paths and extracting values from reference keys.
+- **Utilities**: General utility functions, including loading a submodel from a file.
+
+---
+
+## API References
+- AID Parser
+- AIMC Parser
+- [AAS Parser](docs/api_references/api_aas_parser.md)
+- [Submodel Parser](docs/api_references/api_submodel_parser.md)
+- Collection Helpers
+- [Reference Helpers](docs/api_references/api_reference_helpers.md)
+- [Utilities](docs/api_references/api_utils.md)
+
+## Resources
+
+🤖 [Releases](http://github.com/fluid40/aas-standard-parser/releases)
+
+📦 [Pypi Packages](https://pypi.org/project/aas-standard-parser/)
+
+📜 [MIT License](LICENSE)

{aas_standard_parser-0.2.1 → aas_standard_parser-0.3.1}/aas_standard_parser.egg-info/SOURCES.txt

@@ -2,17 +2,21 @@ LICENSE
 README.md
 pyproject.toml
 aas_standard_parser/__init__.py
+aas_standard_parser/aas_parser.py
 aas_standard_parser/aid_parser.py
 aas_standard_parser/aimc_parser.py
 aas_standard_parser/collection_helpers.py
 aas_standard_parser/reference_helpers.py
+aas_standard_parser/submodel_json_parser.py
 aas_standard_parser/submodel_parser.py
 aas_standard_parser/utils.py
+aas_standard_parser/version_check.py
 aas_standard_parser.egg-info/PKG-INFO
 aas_standard_parser.egg-info/SOURCES.txt
 aas_standard_parser.egg-info/dependency_links.txt
 aas_standard_parser.egg-info/requires.txt
 aas_standard_parser.egg-info/top_level.txt
+aas_standard_parser/classes/aimc_parser_classes.py
 aas_standard_parser/demo/demo_process.py
 aas_standard_parser/demo/logging_handler.py
 tests/test_aimc_parser.py

{aas_standard_parser-0.2.1 → aas_standard_parser-0.3.1}/pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-standard-parser"
-version = "0.2.1"
+version = "0.3.1"
 description = "Some auxiliary functions for parsing standard submodels"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ name = "Daniel Klein", email = "daniel.klein@em.ag" }]
 dependencies = ["typing>=3.7.4.3", "basyx-python-sdk>=1.2.1"]
 [project.urls]
-Homepage = "https://github.com/fluid40/aas-http-client"
+Homepage = "https://github.com/fluid40/aas-standard-parser"
 
 [tool.commitizen]
 name = "cz_conventional_commits"

{aas_standard_parser-0.2.1 → aas_standard_parser-0.3.1}/tests/test_aimc_parser.py

@@ -1,7 +1,7 @@
 import pytest
 from basyx.aas import model
 
-from aas_standard_parser.aimc_parser import MappingConfiguration, SourceSinkRelation, ReferenceProperties
+from aas_standard_parser.classes.aimc_parser_classes import MappingConfiguration, SourceSinkRelation, ReferenceProperties
 import aas_standard_parser.aimc_parser as aimc_parser
 from aas_standard_parser.utils import create_submodel_from_file
 
@@ -120,10 +120,12 @@ def _check_relations_sink(reference_properties: ReferenceProperties):
 
 def _check_relation_methods(relation: SourceSinkRelation):
     # test to_json methods
-    source_json = relation.source_as_dict()
+    source_json = relation.source_reference_as_dict()
+    assert isinstance(source_json, dict)
     assert source_json is not None
     assert "type" in source_json
 
-    sink_json = relation.sink_as_dict()
+    sink_json = relation.sink_reference_as_dict()
+    assert isinstance(sink_json, dict)
     assert sink_json is not None
     assert "type" in sink_json

aas_standard_parser-0.2.1/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: aas-standard-parser
-Version: 0.2.1
-Summary: Some auxiliary functions for parsing standard submodels
-Author-email: Daniel Klein <daniel.klein@em.ag>
-License: MIT License
-        
-        Copyright (c) 2025 Fluid4.0
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/fluid40/aas-http-client
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing>=3.7.4.3
-Requires-Dist: basyx-python-sdk>=1.2.1
-Dynamic: license-file
-
-# aas-standard-parser
-Some auxiliary functions for parsing standard submodels

aas_standard_parser-0.2.1/README.md

@@ -1,2 +0,0 @@
-# aas-standard-parser
-Some auxiliary functions for parsing standard submodels

aas_standard_parser-0.2.1/aas_standard_parser/__init__.py

@@ -1,19 +0,0 @@
-import importlib.metadata
-from datetime import datetime
-
-# TODO: introduce MIT license
-__copyright__ = f"Copyright (C) {datetime.now().year} :em engineering methods AG. All rights reserved."
-__author__ = "Daniel Klein, Celina Adelhardt, Tom Gneuß"
-
-try:
-    __version__ = importlib.metadata.version(__name__)
-except importlib.metadata.PackageNotFoundError:
-    __version__ = "0.0.0-dev"
-
-__project__ = "aas-standard-parser"
-__package__ = "aas-standard-parser"
-
-from aas_standard_parser import aimc_parser
-from aas_standard_parser.aid_parser import AIDParser
-
-__all__ = ["AIDParser", "aimc_parser"]

aas_standard_parser-0.2.1/aas_standard_parser/reference_helpers.py

@@ -1,12 +0,0 @@
-from basyx.aas.model import ModelReference
-
-
-def construct_idshort_path_from_reference(reference: ModelReference) -> str:
-    idshort_path: str = ""
-
-    # start from the second Key and omit the Identifiable at the beginning of the list
-    for key in reference.key[1:]:
-        idshort_path += (key.value + ".")
-
-    # get rid of the trailing dot
-    return idshort_path[:-1]

aas_standard_parser-0.2.1/aas_standard_parser/utils.py

@@ -1,25 +0,0 @@
-import json
-from pathlib import Path
-
-from aas_http_client import sdk_tools
-from basyx.aas import model
-
-
-def create_submodel_from_file(file_path: str) -> model.Submodel:
-    """Creates a Submodel from a given file path.
-
-    :param file_path: Path to the file containing the submodel data.
-    :return: The created Submodel object.
-    """
-    file = Path(file_path)
-    if not file.exists():
-        raise FileNotFoundError(f"Submodel template file not found: {file}")
-
-    template_data = {}
-
-    # Load the template JSON file
-    with open(file, "r", encoding="utf-8") as f:
-        template_data = json.load(f)
-
-    # Load the template JSON into a Submodel object
-    return sdk_tools.convert_to_object(template_data)

aas_standard_parser-0.2.1/aas_standard_parser.egg-info/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: aas-standard-parser
-Version: 0.2.1
-Summary: Some auxiliary functions for parsing standard submodels
-Author-email: Daniel Klein <daniel.klein@em.ag>
-License: MIT License
-        
-        Copyright (c) 2025 Fluid4.0
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/fluid40/aas-http-client
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing>=3.7.4.3
-Requires-Dist: basyx-python-sdk>=1.2.1
-Dynamic: license-file
-
-# aas-standard-parser
-Some auxiliary functions for parsing standard submodels