aas-http-client 0.2.5__tar.gz → 0.2.7__tar.gz

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.5
+Version: 0.2.7
 Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/aas_http_client/client.py

@@ -1,4 +1,5 @@
 """Client for HTTP API communication with AAS server."""
+
 import json
 import logging
 import time
@@ -8,12 +9,13 @@ import basyx.aas.adapter.json
 import basyx.aas.adapter.json.json_serialization as js
 import requests
 from basyx.aas.model import Reference, Submodel
-from aas_http_client.core.encoder import decode_base_64
 from pydantic import BaseModel, PrivateAttr, ValidationError
 from requests import Session
 from requests.auth import HTTPBasicAuth
 from requests.models import Response
 
+from aas_http_client.core.encoder import decode_base_64
+
 logger = logging.getLogger(__name__)
 
 STATUS_CODE_200 = 200
@@ -55,7 +57,7 @@ def log_response_errors(response: Response):
                     result_error_messages.append(str(message))
         elif "error" in response_content_dict:
             result_error_messages.append(response_content_dict.get("error", ""))
-        
+
         if len(result_error_messages) == 0 and response.text:
             result_error_messages.append(response.text)
 
@@ -121,7 +123,7 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-# region shells
+    # region shells
 
     def post_asset_administration_shell(self, aas_data: dict) -> dict | None:
         """Creates a new Asset Administration Shell.
@@ -242,7 +244,6 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-
     def get_asset_administration_shell_by_id_reference_aas_repository(self, aas_id: str) -> Reference | None:
         """Returns a specific Asset Administration Shell as a Reference.
 
@@ -278,7 +279,7 @@ class AasHttpClient(BaseModel):
         decoded_submodel_id: str = decode_base_64(submodel_id)
 
         url = f"{self.base_url}/shells/{decoded_aas_id}/submodels/{decoded_submodel_id}"
-        #/shells/{aasIdentifier}/submodels/{submodelIdentifier}
+        # /shells/{aasIdentifier}/submodels/{submodelIdentifier}
 
         try:
             response = self._session.get(url, headers=HEADERS, timeout=self.time_out)
@@ -318,9 +319,9 @@ class AasHttpClient(BaseModel):
 
         return True
 
-# endregion
+    # endregion
 
-# region submodels
+    # region submodels
 
     def post_submodel(self, submodel_data: dict) -> dict | None:
         """Creates a new Submodel.
@@ -509,10 +510,12 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
+
 # endregion
 
 # region client
 
+
 def create_client_by_url(
     base_url: str,
     username: str = "",
@@ -547,6 +550,7 @@ def create_client_by_url(
     config_string = json.dumps(config_dict, indent=4)
     return _create_client(config_string, password)
 
+
 def create_client_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
     """Create a AAS HTTP client from the given parameters.
 
@@ -565,6 +569,7 @@ def create_client_by_config(config_file: Path, password: str = "") -> AasHttpCli
 
     return _create_client(config_string, password)
 
+
 def _create_client(config_string: str, password) -> AasHttpClient | None:
     try:
         connection_settings = AasHttpClient.model_validate_json(config_string)
@@ -590,6 +595,7 @@ def _create_client(config_string: str, password) -> AasHttpClient | None:
 
     return client
 
+
 def _connect_to_api(client: AasHttpClient) -> bool:
     start_time = time.time()
     logger.debug(f"Try to connect to REST API '{client.base_url}' for {client.connection_time_out} seconds")
@@ -609,4 +615,5 @@ def _connect_to_api(client: AasHttpClient) -> bool:
         logger.warning(f"Retrying connection (attempt: {counter})")
         time.sleep(1)
 
-# endregion
+
+# endregion

aas_http_client-0.2.7/aas_http_client/demo/demo_process.py

@@ -0,0 +1,95 @@
+"""Main process for the demo."""
+
+import logging
+from pathlib import Path
+
+from basyx.aas import model
+
+from aas_http_client.client import AasHttpClient, create_client_by_config
+from aas_http_client.utilities import model_builder
+from aas_http_client.wrapper.sdk_wrapper import SdkWrapper, create_wrapper_by_config
+
+logger = logging.getLogger(__name__)
+
+
+def start() -> None:
+    """Start the demo process."""
+    # create a submodel element
+    sme_short_id: str = model_builder.create_unique_short_id("poc_sme")
+    sme = model_builder.create_base_submodel_element_Property(sme_short_id, model.datatypes.String, "Sample Value")
+
+    # create a submodel
+    sm_short_id: str = model_builder.create_unique_short_id("poc_sm")
+    submodel = model_builder.create_base_submodel(sm_short_id)
+    # add submodel element to submodel
+    # submodel.submodel_element.add(sme)
+
+    # create an AAS
+    aas_short_id: str = model_builder.create_unique_short_id("poc_aas")
+    aas = model_builder.create_base_ass(aas_short_id)
+
+    # add submodel to AAS
+    model_builder.add_submodel_to_aas(aas, submodel)
+
+    wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/python_server_config.json"))
+    # dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.json"))
+
+    for existing_shell in wrapper.get_all_asset_administration_shells():
+        logger.warning(f"Delete shell '{existing_shell.id}'")
+        wrapper.delete_asset_administration_shell_by_id(existing_shell.id)
+
+    for existing_submodel in wrapper.get_all_submodels():
+        logger.warning(f"Delete submodel '{existing_submodel.id}'")
+        wrapper.delete_submodel_by_id(existing_submodel.id)
+
+    wrapper.post_asset_administration_shell(aas)
+    wrapper.post_submodel(submodel)
+
+    tmp = wrapper.get_asset_administration_shell_by_id_reference_aas_repository(aas.id)
+
+    shell = wrapper.get_asset_administration_shell_by_id(aas.id)
+    submodel = wrapper.get_submodel_by_id(submodel.id)
+
+    wrapper.post_submodel_element_submodel_repo(submodel.id, sme)
+
+    submodel = wrapper.get_submodel_by_id(submodel.id)
+
+    for existing_shell in wrapper.get_all_asset_administration_shells():
+        logger.warning(f"Delete shell '{existing_shell.id}'")
+        wrapper.delete_asset_administration_shell_by_id(existing_shell.id)
+
+    for existing_submodel in wrapper.get_all_submodels():
+        logger.warning(f"Delete submodel '{existing_submodel.id}'")
+        wrapper.delete_submodel_by_id(existing_submodel.id)
+
+
+def _create_client(config: Path) -> AasHttpClient:
+    """Create a HTTP client from a given configuration file.
+
+    :param config: Given configuration file
+    :return: HTTP client
+    """
+    try:
+        file = config
+        client = create_client_by_config(file, password="")
+
+    except Exception as e:
+        logger.error(f"Failed to create client for {file}: {e}")
+
+    return client
+
+
+def _create_sdk_wrapper(config: Path) -> SdkWrapper:
+    """Create a SDK wrapper from a given configuration file.
+
+    :param config: Given configuration file
+    :return: SDK wrapper
+    """
+    try:
+        file = config
+        client = create_wrapper_by_config(file, password="")
+
+    except Exception as e:
+        logger.error(f"Failed to create client for {file}: {e}")
+
+    return client

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/aas_http_client/utilities/model_builder.py

@@ -4,9 +4,10 @@ Provides some helper methods for easier work with basyx sdk data model
 """
 
 import uuid
+from typing import Any
 
 from basyx.aas import model
-from typing import Any
+
 
 def create_unique_short_id(id_short: str) -> str:
     """Generate a unique identifier string by appending a UUID to the provided ID short.
@@ -16,41 +17,39 @@ def create_unique_short_id(id_short: str) -> str:
     """
     return f"{id_short}_{str(uuid.uuid4()).replace('-', '_')}"
 
-def create_base_submodel_element_Property(id_short: str, type: model.datatypes, value: Any, display_name: str = "", description: str = "") -> model.Property:
-    """Create a basic Property Submodel Element.
-    """
-    sme = model.Property(
-        id_short=id_short, 
-        value_type=type,
-        value=value)     
-    
+
+def create_base_submodel_element_Property(
+    id_short: str, type: model.datatypes, value: Any, display_name: str = "", description: str = ""
+) -> model.Property:
+    """Create a basic Property Submodel Element."""
+    sme = model.Property(id_short=id_short, value_type=type, value=value)
+
     if not description:
         description = f"This is the submodel element with ID short '{id_short}'"
 
     description_text = {"en": f"{description}"}
     sme.description = model.MultiLanguageTextType(description_text)
-    
+
     if not display_name:
         display_name = "POC Submodel Element"
 
     display_name_text = {"en": f"{display_name}"}
     sme.display_name = model.MultiLanguageTextType(display_name_text)
-    
+
     return sme
 
-def create_base_submodel(id_short: str, namespace: str = "basyx_python_aas_server", display_name: str = "", description: str = "") -> model.Submodel:
+
+def create_base_submodel(id_short: str, namespace: str = "fluid40", display_name: str = "", description: str = "") -> model.Submodel:
     """Create a basic Submodel.
 
     :param id_short: ID short of the Submodel
-    :param namespace: namespace of the Submodel , defaults to "basyx_python_aas_server"
+    :param namespace: namespace of the Submodel , defaults to "fluid40"
     :param display_name: display name of the Submodel, defaults to ""
     :param description: description of the Submodel, defaults to ""
     :return: Submodel instance
     """
-    if namespace:
-        identifier = f"{namespace}/{id_short}"
-    else:   
-        identifier = id_short
+    identifier = f"{namespace}/{id_short}" if namespace else id_short
+
     sm = model.Submodel(identifier)
     sm.id_short = id_short
 
@@ -69,9 +68,7 @@ def create_base_submodel(id_short: str, namespace: str = "basyx_python_aas_serve
     return sm
 
 
-def create_base_ass(
-    id_short: str, namespace: str = "basyx_python_aas_server", display_name: str = "", description: str = ""
-) -> model.AssetAdministrationShell:
+def create_base_ass(id_short: str, namespace: str = "fluid40", display_name: str = "", description: str = "") -> model.AssetAdministrationShell:
     """Create a basic AAS.
 
     :param id_short: ID short of the AAS
@@ -117,10 +114,7 @@ def create_base_asset_information(id_short: str, namespace: str = "basyx_python_
     :param namespace: namespace of the AssetInformation, defaults to "basyx_python_aas_server"
     :return: AssetInformation instance
     """
-    if namespace:
-        identifier = f"{namespace}/{id_short}"
-    else:   
-        identifier = id_short
+    identifier = f"{namespace}/{id_short}" if namespace else id_short
     return model.AssetInformation(model.AssetKind.INSTANCE, identifier)
 
 

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/aas_http_client/wrapper/sdk_wrapper.py

@@ -6,17 +6,20 @@ from pathlib import Path
 from typing import Any
 
 import basyx.aas.adapter.json
-
 from basyx.aas import model
+
 from aas_http_client.client import AasHttpClient, _create_client
+
 logger = logging.getLogger(__name__)
 
-class SdkWrapper():
+
+class SdkWrapper:
     """Represents a wrapper for the BaSyx Python SDK to communicate with a REST API."""
-    _client: AasHttpClient = None  
-    base_url: str = ""   
 
-# region shells
+    _client: AasHttpClient = None
+    base_url: str = ""
+
+    # region shells
 
     def post_asset_administration_shell(self, aas: model.AssetAdministrationShell) -> model.AssetAdministrationShell | None:
         """Creates a new Asset Administration Shell.
@@ -54,7 +57,7 @@ class SdkWrapper():
         :return: Asset Administration Shells objects or None if an error occurred
         """
         content: dict = self._client.get_all_asset_administration_shells()
-        
+
         if not content:
             return None
 
@@ -79,16 +82,16 @@ class SdkWrapper():
 
     def get_asset_administration_shell_by_id(self, aas_id: str) -> model.AssetAdministrationShell | None:
         """Returns a specific Asset Administration Shell.
-        
+
         :param aas_id: ID of the AAS to retrieve
         :return: Asset Administration Shells object or None if an error occurred
         """
         content: dict = self._client.get_asset_administration_shell_by_id(aas_id)
-        
+
         if not content:
             logger.warning(f"No shell found with ID '{aas_id}' on server.")
             return None
-        
+
         return _to_object(content)
 
     def get_asset_administration_shell_by_id_reference_aas_repository(self, aas_id: str) -> model.Reference | None:
@@ -97,12 +100,12 @@ class SdkWrapper():
         :param aas_id: ID of the AAS reference to retrieve
         :return: Asset Administration Shells reference object or None if an error occurred
         """
-        #workaround because serialization not working
+        # workaround because serialization not working
         aas = self.get_asset_administration_shell_by_id(aas_id)
         return model.ModelReference.from_referable(aas)
-        
-        # content: dict = self._client.get_shells_reference_by_id(aas_id)
-        # return json.loads(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+        # content: dict = self._client.get_asset_administration_shell_by_id_reference_aas_repository(aas_id)
+        # return _to_object(content)
 
     def get_submodel_by_id_aas_repository(self, aas_id: str, submodel_id: str) -> model.Submodel | None:
         """Returns the Submodel.
@@ -122,9 +125,9 @@ class SdkWrapper():
         """
         return self._client.delete_asset_administration_shell_by_id(aas_id)
 
-# endregion
+    # endregion
 
-# region submodels
+    # region submodels
 
     def post_submodel(self, submodel: model.Submodel) -> model.Submodel | None:
         """Creates a new Submodel.
@@ -186,15 +189,15 @@ class SdkWrapper():
         if not content:
             logger.warning(f"No submodel found with ID '{submodel_id}' on server.")
             return None
-        
+
         return _to_object(content)
 
     def patch_submodel_by_id(self, submodel_id: str, submodel: model.Submodel):
-        """Updates an existing Submodel
+        """Updates an existing Submodel.
 
         :param submodel_id: Encoded ID of the Submodel to delete
         :return: True if the patch was successful, False otherwise
-        """        
+        """
         sm_data = _to_dict(submodel)
         return self._client.patch_submodel_by_id(submodel_id, sm_data)
 
@@ -206,15 +209,17 @@ class SdkWrapper():
         """
         return self._client.delete_submodel_by_id(submodel_id)
 
-    def get_all_submodel_elements_submodel_repository(self, submodel_id: str, ) -> list[model.SubmodelElement] | None:
-        """Returns all submodel elements including their hierarchy.
-        !!! Serialization to model.SubmodelElement currently not possible
+    def get_all_submodel_elements_submodel_repository(
+        self,
+        submodel_id: str,
+    ) -> list[model.SubmodelElement] | None:
+        """Returns all submodel elements including their hierarchy. !!!Serialization to model.SubmodelElement currently not possible.
 
         :param submodel_id: Encoded ID of the Submodel to retrieve elements from
         :return: List of Submodel elements or None if an error occurred
         """
         content = self._client.get_all_submodel_elements_submodel_repository(submodel_id)
-        
+
         if not content:
             return []
 
@@ -238,9 +243,8 @@ class SdkWrapper():
         return submodel_elements
 
     def post_submodel_element_submodel_repo(self, submodel_id: str, submodel_element: model.SubmodelElement) -> model.SubmodelElement | None:
-        """Creates a new submodel element.
-        !!! Serialization to model.SubmodelElements currently not possible
-        
+        """Creates a new submodel element. !!!Serialization to model.SubmodelElements currently not possible.
+
         :param submodel_id: Encoded ID of the submodel to create elements for
         :param submodel_element: Submodel element to create
         :return: List of submodel element objects or None if an error occurred
@@ -252,6 +256,7 @@ class SdkWrapper():
 
 # endregion
 
+
 def _to_object(content: dict) -> Any | None:
     try:
         dict_string = json.dumps(content)
@@ -260,7 +265,8 @@ def _to_object(content: dict) -> Any | None:
         logger.error(f"Decoding error: {e}")
         logger.error(f"In JSON: {content}")
         return None
-    
+
+
 def _to_dict(object: Any) -> dict | None:
     try:
         data_string = json.dumps(object, cls=basyx.aas.adapter.json.AASToJsonEncoder)
@@ -268,10 +274,12 @@ def _to_dict(object: Any) -> dict | None:
     except Exception as e:
         logger.error(f"Encoding error: {e}")
         logger.error(f"In object: {object}")
-        return None    
+        return None
+
 
 # region wrapper
 
+
 def create_wrapper_by_url(
     base_url: str,
     username: str = "",
@@ -304,17 +312,18 @@ def create_wrapper_by_url(
     config_dict["connection_time_out"] = connection_time_out
     config_dict["ssl_verify"] = ssl_verify
     config_string = json.dumps(config_dict, indent=4)
-    
+
     wrapper = SdkWrapper()
-    client = _create_client(config_string, password)      
-    
+    client = _create_client(config_string, password)
+
     if not client:
         return None
-    
+
     wrapper._client = client
-    wrapper.base_url = client.base_url      
+    wrapper.base_url = client.base_url
     return wrapper
-    
+
+
 def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrapper | None:
     """Create a wrapper for the BaSyx Python SDK from the given parameters.
 
@@ -332,12 +341,13 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrappe
 
     wrapper = SdkWrapper()
     client = _create_client(config_string, password)
-    
+
     if not client:
         return None
-    
-    wrapper._client = client  
-    wrapper.base_url = client.base_url             
+
+    wrapper._client = client
+    wrapper.base_url = client.base_url
     return wrapper
 
-# endregion
+
+# endregion

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/aas_http_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.5
+Version: 0.2.7
 Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License

{aas_http_client-0.2.5 → aas_http_client-0.2.7}/aas_http_client.egg-info/SOURCES.txt

@@ -13,4 +13,6 @@ aas_http_client/demo/demo_process.py
 aas_http_client/demo/logging_handler.py
 aas_http_client/utilities/__init__.py
 aas_http_client/utilities/model_builder.py
-aas_http_client/wrapper/sdk_wrapper.py
+aas_http_client/wrapper/sdk_wrapper.py
+tests/test_client.py
+tests/test_wrapper.py

aas_http_client-0.2.7/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aas-http-client"
+version = "0.2.7"
+description = "Generic python HTTP client for communication with various types of AAS servers"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [{ name = "Daniel Klein", email = "daniel.klein@em.ag" }]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/fluid40/aas-http-client"
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "0.1.0"
+
+[tool.commitizen.branch]
+allowed = "^(main|master|develop|feature/.*|fix/.*|hotfix/.*)$"