aas-http-client 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

aas_http_client/demo/demo_process.py

@@ -5,7 +5,7 @@ from aas_http_client.wrapper.sdk_wrapper import SdkWrapper, create_wrapper_by_co
 from pathlib import Path
 import json
 import basyx.aas.adapter.json
-from basyx.aas.model import AssetAdministrationShell
+import basyx.aas.model
 
 logger = logging.getLogger(__name__)
 
@@ -43,7 +43,7 @@ def start():
 
     logger.info(f"Client created successfully. {shells}")
 
-def _create_shell() -> AssetAdministrationShell:
+def _create_shell() -> basyx.aas.model.AssetAdministrationShell:
     # create an AAS
     aas_short_id: str = model_builder.create_unique_short_id("poc_aas")
     aas = model_builder.create_base_ass(aas_short_id)

aas_http_client/wrapper/sdk_wrapper.py

@@ -12,7 +12,7 @@ from aas_http_client.client import AasHttpClient, _create_client
 logger = logging.getLogger(__name__)
 
 class SdkWrapper():
-    """Represents a SdkWrapper to communicate with a REST API."""
+    """Represents a wrapper for the BaSyx Python SDK to communicate with a REST API."""
     _client: AasHttpClient = None
 
     def post_shells(self, aas: AssetAdministrationShell) -> dict | None:
@@ -215,7 +215,7 @@ def create_wrapper_by_url(
     connection_time_out: int = 60,
     ssl_verify: str = True,  # noqa: FBT002
 ) -> SdkWrapper | None:
-    """Create a BaSyx server interface client from the given parameters.
+    """Create a wrapper for the BaSyx Python SDK from the given parameters.
 
     :param base_url: base URL of the BaSyx server, e.g. "http://basyx_python_server:80/"_
     :param username: username for the BaSyx server interface client, defaults to ""_
@@ -225,9 +225,9 @@ def create_wrapper_by_url(
     :param time_out: timeout for the API calls, defaults to 200
     :param connection_time_out: timeout for the connection to the API, defaults to 60
     :param ssl_verify: whether to verify SSL certificates, defaults to True
-    :return: An instance of HttpClient initialized with the provided parameters.
+    :return: An instance of SdkWrapper initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx server interface client from URL '{base_url}'")
+    logger.info(f"Create BaSyx Python SDK wrapper from URL '{base_url}'")
     config_dict: dict[str, str] = {}
     config_dict["base_url"] = base_url
     config_dict["username"] = username
@@ -249,12 +249,12 @@ def create_wrapper_by_url(
     
 
 
-def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
-    """Create a BaSyx server interface client from the given parameters.
+def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrapper | None:
+    """Create a wrapper for the BaSyx Python SDK from the given parameters.
 
     :param config_file: Path to the configuration file containing the BaSyx server connection settings.
     :param password: password for the BaSyx server interface client, defaults to ""_
-    :return: An instance of HttpClient initialized with the provided parameters.
+    :return: An instance of SdkWrapper initialized with the provided parameters.
     """
     logger.info(f"Create BaSyx Python SDK wrapper from configuration file '{config_file}'")
     if not config_file.exists():

{aas_http_client-0.2.2.dist-info → aas_http_client-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.2
+Version: 0.2.3
 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
@@ -127,17 +127,27 @@ Dynamic: license-file
 [![CI](https://github.com/fluid40/aas-http-client/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-http-client/actions)
 [![PyPI version](https://img.shields.io/pypi/v/aas-http-client.svg)](https://pypi.org/project/aas-http-client/)
 
-This is a generic HTTP client that can communicate with various types of AAS and submodel repository servers. The client uses Python dictionaries for input and output parameters.
-Additionally, wrappers are provided that work with various AAS frameworks and use the HTTP client as middleware.  
+This is a generic HTTP client that can communicate with various types of AAS and submodel repository servers. It uses Python dictionaries for input and output parameters of functions. It supports the most common endpoints for the [specified AAS server endpoint](https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.1.1/specification/interfaces.html). The client is compatible with various types of AAS repository server.
+The client should be compatible with various types of AAS repository server. 
 
-Currently, wrappers are available for the following frameworks:
-- BaSyx Python SDK
+Tested servers include:
+- [Eclipse BaSyx .Net SDK server](https://github.com/eclipse-basyx/basyx-dotnet)
+- [Eclipse BaSyx .Net SDK server (Fluid4.0 Fork)](https://github.com/fluid40/basyx-dotnet)
+- [Eclipse BaSyx Java SDK server](https://github.com/eclipse-basyx/basyx-java-sdk)
+- [Eclipse BaSyx Python SDK server](https://github.com/eclipse-basyx/basyx-python-sdk)
+- [Eclipse AASX server](https://github.com/eclipse-aaspe)  
+
+The behavior may vary depending on the details of the implementation and compliance with the [AAS specification](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). It also depends on which endpoints are provided by the server.
+
+Additionally, wrappers are provided that work with various AAS frameworks and use the HTTP client as middleware. These wrappers use the SDK-specific data model classes for function input and output parameters.
+Wrappers are currently available for the following frameworks:
+- [Eclipse BaSyx Python SDK](https://github.com/eclipse-basyx/basyx-python-sdk)
 
 ## Links
 
 🚀 [Getting Started](docs/getting_started.md)
 
-💻 [Developer Quickstart](docs/dev_guide.md)
+💻 [Tutorials](docs/tutorials.md)
 
 👨‍⚕️ [Troubleshooting](docs/troubleshooting.md)
 
@@ -167,12 +177,12 @@ client = create_client_by_url(
 print(client.get_shells())
 ```
 
-### SDK Wrapper
+### BaSyx Python SDK Wrapper
 
 ```python
-from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_url
 
-wrapper = create_wrapper_by_config(
+wrapper = create_wrapper_by_url(
     base_url="http://myaasserver:5043/"
 )
 

{aas_http_client-0.2.2.dist-info → aas_http_client-0.2.3.dist-info}/RECORD

@@ -2,13 +2,13 @@ aas_http_client/__init__.py,sha256=cAr1mQzWp0G0LKtkAOYzc9t95OY3jM3Aj4bKnxx0Dso,9
 aas_http_client/client.py,sha256=6d3g9VNhex1JrZwIXtBTopSTw3bsf5NZBSWG5mHYuQg,20705
 aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
 aas_http_client/core/version_check.py,sha256=721Zs3xSRrJTYZtAxkaUWg9LLKtpU7oFM62DzQHZdE4,705
-aas_http_client/demo/demo_process.py,sha256=ESR0ETJdEWXHZRswcuNh9qArStFyHFWCNYxhJjLB0tA,2616
+aas_http_client/demo/demo_process.py,sha256=QfneAU2KXHUt90jEsOEx1VA4xgXW7PHsLsVVXI5BOgg,2602
 aas_http_client/demo/logging_handler.py,sha256=VJtZ4u3x_LhYZQtfNck7FuXhGFZm7gid0uDhvf9GjJ8,5596
 aas_http_client/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 aas_http_client/utilities/model_builder.py,sha256=bL4hy3uHh1Y_uL6KmLIfo9ORiUqWNlyToJrAt8G1rpw,3877
-aas_http_client/wrapper/sdk_wrapper.py,sha256=MClsjWDuKDMN_R5b9vEkbxn_sFQ-UhGN3DBzWkLiVQU,10314
-aas_http_client-0.2.2.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
-aas_http_client-0.2.2.dist-info/METADATA,sha256=7NJUrDZSukbER5QnPI6CEL_oIsVeaarzy_CLQX8PFvg,9144
-aas_http_client-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_http_client-0.2.2.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
-aas_http_client-0.2.2.dist-info/RECORD,,
+aas_http_client/wrapper/sdk_wrapper.py,sha256=-0bKx5oP5jYosVAnuRlajMgJA1PJbOLLWm1j0fh1y_k,10334
+aas_http_client-0.2.3.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
+aas_http_client-0.2.3.dist-info/METADATA,sha256=9sTQ4BxzU1ZOFMG2UVjAIb_sGWD1grxZPKt4-VSPzlk,10301
+aas_http_client-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_http_client-0.2.3.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
+aas_http_client-0.2.3.dist-info/RECORD,,