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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.4
+Version: 0.2.5
 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
@@ -153,6 +153,8 @@ Wrappers are currently available for the following frameworks:
 
 🤖 [Releases](http://github.com/fluid40/aas-http-client/releases)
 
+📝 [Changelog](CHANGELOG.md)
+
 📦 [Pypi Packages](https://pypi.org/project/aas-http-client/)
 
 📜 [em AG Software License](LICENSE)

{aas_http_client-0.2.4 → aas_http_client-0.2.5}/README.md

@@ -41,6 +41,8 @@ Wrappers are currently available for the following frameworks:
 
 🤖 [Releases](http://github.com/fluid40/aas-http-client/releases)
 
+📝 [Changelog](CHANGELOG.md)
+
 📦 [Pypi Packages](https://pypi.org/project/aas-http-client/)
 
 📜 [em AG Software License](LICENSE)

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

@@ -123,8 +123,8 @@ class AasHttpClient(BaseModel):
 
 # region shells
 
-    def post_shells(self, aas_data: dict) -> dict | None:
-        """Post an Asset Administration Shell (AAS) to the REST API.
+    def post_asset_administration_shell(self, aas_data: dict) -> dict | None:
+        """Creates a new Asset Administration Shell.
 
         :param aas_data: Json data of the Asset Administration Shell to post
         :return: Response data as a dictionary or None if an error occurred
@@ -147,8 +147,8 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def put_shells(self, identifier: str, aas_data: dict) -> bool:
-        """Update an Asset Administration Shell (AAS) by its ID in the REST API.
+    def put_asset_administration_shell_by_id(self, identifier: str, aas_data: dict) -> bool:
+        """Creates or replaces an existing Asset Administration Shell.
 
         :param identifier: Identifier of the AAS to update
         :param aas_data: Json data of the Asset Administration Shell data to update
@@ -171,8 +171,8 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def put_shells_submodels_by_id(self, aas_id: str, submodel_id: str, submodel_data: dict) -> bool:
-        """Update a submodel by its ID for a specific Asset Administration Shell (AAS).
+    def put_submodel_by_id_aas_repository(self, aas_id: str, submodel_id: str, submodel_data: dict) -> bool:
+        """Updates the Submodel.
 
         :param aas_id: ID of the AAS to update the submodel for
         :param submodel_data: Json data to the Submodel to update
@@ -196,8 +196,8 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def get_shells(self) -> list[dict] | None:
-        """Get all Asset Administration Shells (AAS) from the REST API.
+    def get_all_asset_administration_shells(self) -> list[dict] | None:
+        """Returns all Asset Administration Shells.
 
         :return: List of paginated Asset Administration Shells data or None if an error occurred
         """
@@ -218,8 +218,8 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def get_shells_by_id(self, aas_id: str) -> dict | None:
-        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
+    def get_asset_administration_shell_by_id(self, aas_id: str) -> dict | None:
+        """Returns a specific Asset Administration Shell.
 
         :param aas_id: ID of the AAS to retrieve
         :return: Asset Administration Shells data or None if an error occurred
@@ -243,7 +243,12 @@ class AasHttpClient(BaseModel):
         return json.loads(content)
 
 
-    def get_shells_reference_by_id(self, aas_id: str) -> Reference | None:
+    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.
+
+        :param aas_id: ID of the AAS reference to retrieve
+        :return: Asset Administration Shells reference data or None if an error occurred
+        """
         decoded_aas_id: str = decode_base_64(aas_id)
         url = f"{self.base_url}/shells/{decoded_aas_id}/$reference"
 
@@ -262,8 +267,8 @@ class AasHttpClient(BaseModel):
         ref_dict_string = response.content.decode("utf-8")
         return json.loads(ref_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
 
-    def get_shells_submodels_by_id(self, aas_id: str, submodel_id: str) -> Submodel | None:
-        """Get a submodel by its ID for a specific Asset Administration Shell (AAS).
+    def get_submodel_by_id_aas_repository(self, aas_id: str, submodel_id: str) -> Submodel | None:
+        """Returns the Submodel.
 
         :param aas_id: ID of the AAS to retrieve the submodel from
         :param submodel_id: ID of the submodel to retrieve
@@ -290,8 +295,8 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def delete_shells_by_id(self, aas_id: str) -> bool:
-        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
+    def delete_asset_administration_shell_by_id(self, aas_id: str) -> bool:
+        """Deletes an Asset Administration Shell.
 
         :param aas_id: ID of the AAS to retrieve
         :return: True if the deletion was successful, False otherwise
@@ -317,8 +322,8 @@ class AasHttpClient(BaseModel):
 
 # region submodels
 
-    def post_submodels(self, submodel_data: dict) -> dict | None:
-        """Create a new Submodel.
+    def post_submodel(self, submodel_data: dict) -> dict | None:
+        """Creates a new Submodel.
 
         :param Submodel_data: Json data of the Submodel to post
         :return: Submodel data or None if an error occurred
@@ -364,8 +369,8 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def get_submodels(self) -> list[dict] | None:
-        """Returns all Submodels
+    def get_all_submodels(self) -> list[dict] | None:
+        """Returns all Submodels.
 
         :return: List of Submodel data or None if an error occurred
         """
@@ -386,7 +391,7 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def get_submodels_by_id(self, submodel_id: str) -> dict | None:
+    def get_submodel_by_id(self, submodel_id: str) -> dict | None:
         """Returns a specific Submodel.
 
         :param submodel_id: Encoded ID of the Submodel to retrieve
@@ -411,7 +416,7 @@ class AasHttpClient(BaseModel):
         return json.loads(content)
 
     def patch_submodel_by_id(self, submodel_id: str, submodel_data: dict) -> bool:
-        """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
@@ -433,8 +438,8 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def delete_submodels_by_id(self, submodel_id: str) -> bool:
-        """Deletes a existing Submodel.
+    def delete_submodel_by_id(self, submodel_id: str) -> bool:
+        """Deletes a Submodel.
 
         :param submodel_id: Encoded ID of the Submodel to delete
         :return: True if the deletion was successful, False otherwise
@@ -456,8 +461,8 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def get_submodels_submodel_elements(self, submodel_id: str) -> list[dict] | None:
-        """Returns all Submodel elements including their hierarchy.
+    def get_all_submodel_elements_submodel_repository(self, submodel_id: str) -> list[dict] | None:
+        """Returns all submodel elements including their hierarchy.
 
         :param submodel_id: Encoded ID of the Submodel to retrieve elements from
         :return: List of Submodel element data or None if an error occurred
@@ -480,8 +485,8 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def post_submodels_submodel_elements(self, submodel_id: str, submodel_element_data: dict) -> dict | None:
-        """Create a new Submodel element.
+    def post_submodel_element_submodel_repo(self, submodel_id: str, submodel_element_data: dict) -> dict | None:
+        """Creates a new submodel element.
 
         :param submodel_id: Encoded ID of the Submodel to create elements for
         :return: Submodel element data or None if an error occurred

{aas_http_client-0.2.4 → aas_http_client-0.2.5}/aas_http_client/demo/demo_process.py

@@ -33,23 +33,25 @@ def start():
     java_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/java_server_config.json"))
     # dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.json"))
 
-    for existing_shell in java_sdk_wrapper.get_shells():
+    for existing_shell in java_sdk_wrapper.get_all_asset_administration_shells():
         logger.warning(f"Delete shell '{existing_shell.id}'")
-        java_sdk_wrapper.delete_shells_by_id(existing_shell.id)
+        java_sdk_wrapper.delete_asset_administration_shell_by_id(existing_shell.id)
 
-    for existing_submodel in java_sdk_wrapper.get_submodels():
+    for existing_submodel in java_sdk_wrapper.get_all_submodels():
         logger.warning(f"Delete submodel '{existing_submodel.id}'")
-        java_sdk_wrapper.delete_submodels_by_id(existing_submodel.id)
+        java_sdk_wrapper.delete_submodel_by_id(existing_submodel.id)
 
-    java_sdk_wrapper.post_shells(aas)
-    java_sdk_wrapper.post_submodels(submodel)
+    java_sdk_wrapper.post_asset_administration_shell(aas)
+    java_sdk_wrapper.post_submodel(submodel)
 
-    shell = java_sdk_wrapper.get_shells_by_id(aas.id)    
-    submodel = java_sdk_wrapper.get_submodels_by_id(submodel.id)
+    tmp = java_sdk_wrapper.get_asset_administration_shell_by_id_reference_aas_repository(aas.id)
 
-    java_sdk_wrapper.post_submodels_submodel_elements(submodel.id, sme)
+    shell = java_sdk_wrapper.get_asset_administration_shell_by_id(aas.id)    
+    submodel = java_sdk_wrapper.get_submodel_by_id(submodel.id)
 
-    submodel = java_sdk_wrapper.get_submodels_by_id(submodel.id)
+    java_sdk_wrapper.post_submodel_element_submodel_repo(submodel.id, sme)
+
+    submodel = java_sdk_wrapper.get_submodel_by_id(submodel.id)
     
 
 def _create_shell() -> basyx.aas.model.AssetAdministrationShell:

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

@@ -14,45 +14,46 @@ logger = logging.getLogger(__name__)
 class SdkWrapper():
     """Represents a wrapper for the BaSyx Python SDK to communicate with a REST API."""
     _client: AasHttpClient = None  
+    base_url: str = ""   
 
 # region shells
 
-    def post_shells(self, aas: model.AssetAdministrationShell) -> model.AssetAdministrationShell | None:
-        """Post an Asset Administration Shell (AAS) to the REST API.
+    def post_asset_administration_shell(self, aas: model.AssetAdministrationShell) -> model.AssetAdministrationShell | None:
+        """Creates a new Asset Administration Shell.
 
         :param aas: Asset Administration Shell to post
         :return: Response data as a dictionary or None if an error occurred
         """
         aas_data = _to_dict(aas)
-        content: dict = self._client.post_shells(aas_data)
+        content: dict = self._client.post_asset_administration_shell(aas_data)
         return _to_object(content)
 
-    def put_shells(self, identifier: str, aas: model.AssetAdministrationShell) -> bool:
-        """Update an Asset Administration Shell (AAS) by its ID in the REST API.
+    def put_asset_administration_shell_by_id(self, identifier: str, aas: model.AssetAdministrationShell) -> bool:
+        """Creates or replaces an existing Asset Administration Shell.
 
         :param identifier: Identifier of the AAS to update
         :param aas: Asset Administration Shell data to update
         :return: True if the update was successful, False otherwise
         """
         aas_data = _to_dict(aas)
-        return self._client.put_shells(identifier, aas_data)
+        return self._client.put_asset_administration_shell_by_id(identifier, aas_data)
 
-    def put_shells_submodels_by_id(self, aas_id: str, submodel_id: str, submodel: model.Submodel) -> bool:
-        """Update a submodel by its ID for a specific Asset Administration Shell (AAS).
+    def put_submodel_by_id_aas_repository(self, aas_id: str, submodel_id: str, submodel: model.Submodel) -> bool:
+        """Updates the Submodel.
 
         :param aas_id: ID of the AAS to update the submodel for
         :param submodel: Submodel data to update
         :return: True if the update was successful, False otherwise
         """
         sm_data = _to_dict(submodel)
-        return self._client.put_shells_submodels_by_id(aas_id, submodel_id, sm_data)
+        return self._client.put_submodel_by_id_aas_repository(aas_id, submodel_id, sm_data)
 
-    def get_shells(self) -> list[model.AssetAdministrationShell] | None:
-        """Get all Asset Administration Shells (AAS) from the REST API.
+    def get_all_asset_administration_shells(self) -> list[model.AssetAdministrationShell] | None:
+        """Returns all Asset Administration Shells.
 
-        :return: AAS objects or None if an error occurred
+        :return: Asset Administration Shells objects or None if an error occurred
         """
-        content: dict = self._client.get_shells()
+        content: dict = self._client.get_all_asset_administration_shells()
         
         if not content:
             return None
@@ -76,13 +77,13 @@ class SdkWrapper():
 
         return aas_list
 
-    def get_shells_by_id(self, aas_id: str) -> model.AssetAdministrationShell | None:
-        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
-
+    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: AAS object or None if an error occurred
+        :return: Asset Administration Shells object or None if an error occurred
         """
-        content: dict = self._client.get_shells_by_id(aas_id)
+        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.")
@@ -90,48 +91,53 @@ class SdkWrapper():
         
         return _to_object(content)
 
-    def get_shells_reference_by_id(self, aas_id: str) -> model.Reference | None:
+    def get_asset_administration_shell_by_id_reference_aas_repository(self, aas_id: str) -> model.Reference | None:
+        """Returns a specific Asset Administration Shell as a Reference.
+
+        :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
-        aas = self.get_shells_by_id(aas_id)
+        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)
 
-    def get_shells_submodels_by_id(self, aas_id: str, submodel_id: str) -> model.Submodel | None:
-        """Get a submodel by its ID for a specific Asset Administration Shell (AAS).
+    def get_submodel_by_id_aas_repository(self, aas_id: str, submodel_id: str) -> model.Submodel | None:
+        """Returns the Submodel.
 
         :param aas_id: ID of the AAS to retrieve the submodel from
         :param submodel_id: ID of the submodel to retrieve
         :return: Submodel object or None if an error occurred
         """
-        content: dict = self._client.get_shells_submodels_by_id(aas_id, submodel_id)
+        content: dict = self._client.get_submodel_by_id_aas_repository(aas_id, submodel_id)
         return _to_object(content)
 
-    def delete_shells_by_id(self, aas_id: str) -> bool:
-        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
+    def delete_asset_administration_shell_by_id(self, aas_id: str) -> bool:
+        """Deletes an Asset Administration Shell.
 
         :param aas_id: ID of the AAS to retrieve
         :return: True if the deletion was successful, False otherwise
         """
-        return self._client.delete_shells_by_id(aas_id)
+        return self._client.delete_asset_administration_shell_by_id(aas_id)
 
 # endregion
 
 # region submodels
 
-    def post_submodels(self, submodel: model.Submodel) -> model.Submodel | None:
-        """Post a submodel to the REST API.
+    def post_submodel(self, submodel: model.Submodel) -> model.Submodel | None:
+        """Creates a new Submodel.
 
         :param submodel: submodel data as a dictionary
         :return: Response data as a dictionary or None if an error occurred
         """
         sm_data = _to_dict(submodel)
-        content: dict = self._client.post_submodels(sm_data)
+        content: dict = self._client.post_submodel(sm_data)
         return _to_object(content)
 
     def put_submodels_by_id(self, identifier: str, submodel: model.Submodel) -> bool:
-        """Update a submodel by its ID in the REST API.
+        """Updates a existing Submodel.
 
         :param identifier: Identifier of the submodel to update
         :param submodel: Submodel data to update
@@ -140,12 +146,12 @@ class SdkWrapper():
         sm_data = _to_dict(submodel)
         return self._client.put_submodels_by_id(identifier, sm_data)
 
-    def get_submodels(self) -> list[model.Submodel] | None:
-        """Get all submodels from the REST API.
+    def get_all_submodels(self) -> list[model.Submodel] | None:
+        """Returns all Submodels.
 
         :return: Submodel objects or None if an error occurred
         """
-        content: list = self._client.get_submodels()
+        content: list = self._client.get_all_submodels()
 
         if not content:
             return []
@@ -169,13 +175,13 @@ class SdkWrapper():
 
         return submodels
 
-    def get_submodels_by_id(self, submodel_id: str) -> model.Submodel | None:
-        """Get a submodel by its ID from the REST API.
+    def get_submodel_by_id(self, submodel_id: str) -> model.Submodel | None:
+        """Returns a specific Submodel.
 
         :param submodel_id: ID of the submodel to retrieve
         :return: Submodel object or None if an error occurred
         """
-        content = self._client.get_submodels_by_id(submodel_id)
+        content = self._client.get_submodel_by_id(submodel_id)
 
         if not content:
             logger.warning(f"No submodel found with ID '{submodel_id}' on server.")
@@ -184,25 +190,30 @@ class SdkWrapper():
         return _to_object(content)
 
     def patch_submodel_by_id(self, submodel_id: str, submodel: model.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)
 
-    def delete_submodels_by_id(self, submodel_id: str) -> bool:
-        """Delete a submodel by its ID from the REST API.
+    def delete_submodel_by_id(self, submodel_id: str) -> bool:
+        """Deletes a Submodel.
 
         :param submodel_id: ID of the submodel to delete
         :return: True if the deletion was successful, False otherwise
         """
-        return self._client.delete_submodels_by_id(submodel_id)
+        return self._client.delete_submodel_by_id(submodel_id)
 
-    def get_submodels_submodel_elements(self, submodel_id: str, ) -> list[model.SubmodelElement] | None:
-        """Returns all Submodel elements including their hierarchy.
+    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_submodels_submodel_elements(submodel_id)
+        content = self._client.get_all_submodel_elements_submodel_repository(submodel_id)
         
         if not content:
             return []
@@ -226,8 +237,8 @@ class SdkWrapper():
 
         return submodel_elements
 
-    def post_submodels_submodel_elements(self, submodel_id: str, submodel_element: model.SubmodelElement) -> model.SubmodelElement | None:
-        """Create a new submodel element.
+    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
         
         :param submodel_id: Encoded ID of the submodel to create elements for
@@ -235,7 +246,7 @@ class SdkWrapper():
         :return: List of submodel element objects or None if an error occurred
         """
         sme_data = _to_dict(submodel_element)
-        content: dict = self._client.post_submodels_submodel_elements(submodel_id, sme_data)
+        content: dict = self._client.post_submodel_element_submodel_repo(submodel_id, sme_data)
         return _to_object(content)
 
 
@@ -300,7 +311,8 @@ def create_wrapper_by_url(
     if not client:
         return None
     
-    wrapper._client = client          
+    wrapper._client = client
+    wrapper.base_url = client.base_url      
     return wrapper
     
 def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrapper | None:
@@ -324,7 +336,8 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrappe
     if not client:
         return None
     
-    wrapper._client = client       
+    wrapper._client = client  
+    wrapper.base_url = client.base_url             
     return wrapper
 
 # endregion

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.4
+Version: 0.2.5
 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
@@ -153,6 +153,8 @@ Wrappers are currently available for the following frameworks:
 
 🤖 [Releases](http://github.com/fluid40/aas-http-client/releases)
 
+📝 [Changelog](CHANGELOG.md)
+
 📦 [Pypi Packages](https://pypi.org/project/aas-http-client/)
 
 📜 [em AG Software License](LICENSE)

{aas_http_client-0.2.4 → aas_http_client-0.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-http-client"
-version = "0.2.4"
+version = "0.2.5"
 description = "Generic python HTTP client for communication with various types of AAS servers"
 readme = "README.md"
 license = { file = "LICENSE" }