| Name | aas-http-client JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | None |
| Summary | Generic python HTTP client for communication with various types of AAS servers |
| upload_time | 2025-08-29 12:11:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | # :em engineering methods AG Software License
SPDX-Identifier: LicenseRef-em
Date: 2025
Version: v0.1
This license agreement (“Agreement”) is made between **:em engineering methods AG (“:em AG”)**, a company
incorporated under the laws of Germany, and the **customer (“Customer”)** who has purchased or obtained
software, scripts, source code or software components (“Software”) from :em AG.
By installing, copying, or otherwise using the Software, the Customer agrees to be bound by the terms of this
Agreement. If the Customer does not agree to the terms of this Agreement, the Customer must not use the
Software and must delete or return any copies of the Software to :em AG.
## 1. Grant of License
Subject to the terms and conditions of this Agreement, :em AG grants the Customer a non-exclusive,
non-transferable, revocable license to use the Software solely for the Customer’s own internal business
purposes on systems owned or controlled by the Customer (“Customer Systems”). The Customer may also allow
its service providers to use the Software on Customer Systems, provided that such service providers agree
to comply with the terms of this Agreement and the Customer remains responsible for their actions.
The Customer may not:
* sublicense, sell, rent, lease, lend, distribute, or otherwise transfer the Software or any rights under
this Agreement to any third party without the prior written consent of :em AG;
* modify, adapt, translate, reverse engineer, decompile, disassemble, or create derivative works based
on the Software or any part thereof;
* remove, alter, or obscure any copyright notices or other proprietary notices on the Software;
use the Software for any illegal, unethical, or unauthorized purpose;
* use the Software in a manner that infringes or violates the rights of :em AG or any third party.
## 2. Reservation of Rights
:em AG retains all right, title, and interest in and to the Software and any copies thereof.
The Software is protected by copyright and other intellectual property laws and treaties.
The Software is licensed, not sold. Nothing in this Agreement shall be construed as transferring any
ownership rights in the Software to the Customer.
:em AG reserves the right to use the Software for any purpose, including but not limited to providing it to
other customers of :em AG, changing its license terms for future versions, or discontinuing its development
or support.
## 3. Disclaimer of Warranty
The Software is provided “as is” without any warranty of any kind, either express or implied, including but
not limited to the implied warranties of merchantability, fitness for a particular purpose, or
non-infringement.
:em AG does not warrant that the Software will meet the Customer’s requirements, that it will operate
uninterrupted or error-free, that it will be compatible with any other software or hardware, or that it will
be free from defects or viruses.
The Customer acknowledges that it has relied on its own skill and judgment in selecting and using the Software
and that it is solely responsible for the results obtained from the Software.
## 4. Limitation of Liability
To the maximum extent permitted by applicable law, in no event shall :em AG be liable for any direct,
indirect, incidental, special, consequential, or exemplary damages arising out of or in connection with this
Agreement or the use or inability to use the Software, even if :em AG has been advised of the possibility of
such damages. In any case, :em AG’s total liability under this Agreement shall not exceed the amount paid by
the Customer for the Software.
## 5. Termination
This Agreement shall remain in effect until terminated by either party. The Customer may terminate this
Agreement at any time by ceasing to use the Software and deleting or returning all copies of the Software
to :em AG. :em AG may terminate this Agreement at any time if the Customer breaches any term of this
Agreement.
Upon termination of this Agreement for any reason, all rights and licenses granted to the Customer under
this Agreement shall cease and the Customer shall destroy or return all copies of the Software to :em AG.
## 6. General
This Agreement constitutes the entire agreement between the parties with respect to the subject matter hereof
and supersedes all prior or contemporaneous agreements or understandings, whether written or oral. This
Agreement may not be modified or amended except by a written instrument signed by both parties.
This Agreement shall be governed by and construed in accordance with the laws of Germany without regard to its
conflict of laws principles. Any dispute arising out of or relating to this Agreement shall be submitted to
the exclusive jurisdiction of the competent courts of Munich, Germany.
If any provision of this Agreement is held to be invalid, illegal, or unenforceable, the remaining provisions
shall remain in full force and effect.
The failure of either party to enforce any right or provision of this Agreement shall not constitute a waiver
of such right or provision.
The Customer may not assign or transfer this Agreement or any rights or obligations under this Agreement
without the prior written consent of :em AG. :em AG may assign or transfer this Agreement or any rights
or obligations under this Agreement without the consent of the Customer.
The Customer agrees to comply with all applicable laws and regulations in connection with its use of the
Software, including but not limited to export control laws and data protection laws.
The Customer acknowledges that it has read and understood this Agreement and agrees to be bound by its terms
and conditions. The Customer also agrees that this Agreement is the complete and exclusive statement of the
agreement between the parties and supersedes any proposal or prior agreement, oral or written, and any other
communications between the parties relating to the subject matter of this Agreement.
|
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
typing
pydantic
requests
pytest
pytest-cov
build
python-json-logger
pre_commit
commitizen
basyx-python-sdk
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- TODO: Go through the readme and enter the information here -->
# AAS HTTP Client
<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_http_client" width=500 />
</div>
---
[](LICENSE)
[](https://github.com/fluid40/aas-http-client/actions)
[](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. 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.
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)
💻 [Tutorials](docs/tutorials.md)
👨⚕️ [Troubleshooting](docs/troubleshooting.md)
🤖 [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)
## ⚡ Quickstart
For a detailed introduction, please read [Getting Started](docs/getting_started.md).
```bash
pip install aas-http-client
````
### Client
```python
from aas_http_client import create_client_by_url
client = create_client_by_url(
base_url="http://myaasserver:5043/"
)
print(client.get_shells())
```
### BaSyx Python SDK Wrapper
```python
from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_url
wrapper = create_wrapper_by_url(
base_url="http://myaasserver:5043/"
)
print(wrapper.get_shells())
```
Raw data
{
"_id": null,
"home_page": null,
"name": "aas-http-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Daniel Klein <daniel.klein@em.ag>",
"download_url": "https://files.pythonhosted.org/packages/71/83/e0be3c2cc337b39e93d684fe0192adff531341385fe7db8336700dc6580f/aas_http_client-0.3.2.tar.gz",
"platform": null,
"description": "<!-- TODO: Go through the readme and enter the information here -->\n\n# AAS HTTP Client\n\n<div align=\"center\">\n<!-- change this to your projects logo if you have on.\n If you don't have one it might be worth trying chatgpt dall-e to create one for you...\n -->\n<img src=\"docs/assets/fluid_logo.svg\" alt=\"aas_http_client\" width=500 />\n</div>\n\n---\n\n[](LICENSE)\n[](https://github.com/fluid40/aas-http-client/actions)\n[](https://pypi.org/project/aas-http-client/)\n\nThis 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.\nThe client should be compatible with various types of AAS repository server. \n\nTested servers include:\n- [Eclipse BaSyx .Net SDK server](https://github.com/eclipse-basyx/basyx-dotnet)\n- [Eclipse BaSyx .Net SDK server (Fluid4.0 Fork)](https://github.com/fluid40/basyx-dotnet)\n- [Eclipse BaSyx Java SDK server](https://github.com/eclipse-basyx/basyx-java-sdk)\n- [Eclipse BaSyx Python SDK server](https://github.com/eclipse-basyx/basyx-python-sdk)\n- [Eclipse AASX server](https://github.com/eclipse-aaspe) \n\nThe 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.\n\nAdditionally, 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.\nWrappers are currently available for the following frameworks:\n- [Eclipse BaSyx Python SDK](https://github.com/eclipse-basyx/basyx-python-sdk)\n\n## Links\n\n\ud83d\ude80 [Getting Started](docs/getting_started.md)\n\n\ud83d\udcbb [Tutorials](docs/tutorials.md)\n\n\ud83d\udc68\u200d\u2695\ufe0f [Troubleshooting](docs/troubleshooting.md)\n\n\ud83e\udd16 [Releases](http://github.com/fluid40/aas-http-client/releases)\n\n\ud83d\udcdd [Changelog](CHANGELOG.md)\n\n\ud83d\udce6 [Pypi Packages](https://pypi.org/project/aas-http-client/)\n\n\ud83d\udcdc [em AG Software License](LICENSE)\n\n## \u26a1 Quickstart\n\nFor a detailed introduction, please read [Getting Started](docs/getting_started.md).\n\n```bash\npip install aas-http-client\n````\n\n### Client\n\n```python\nfrom aas_http_client import create_client_by_url\n\nclient = create_client_by_url(\n base_url=\"http://myaasserver:5043/\"\n)\n\nprint(client.get_shells())\n```\n\n### BaSyx Python SDK Wrapper\n\n```python\nfrom aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_url\n\nwrapper = create_wrapper_by_url(\n base_url=\"http://myaasserver:5043/\"\n)\n\nprint(wrapper.get_shells())\n```\n",
"bugtrack_url": null,
"license": "# :em engineering methods AG Software License\n \n SPDX-Identifier: LicenseRef-em\n Date: 2025\n Version: v0.1\n \n This license agreement (\u201cAgreement\u201d) is made between **:em engineering methods AG (\u201c:em AG\u201d)**, a company\n incorporated under the laws of Germany, and the **customer (\u201cCustomer\u201d)** who has purchased or obtained\n software, scripts, source code or software components (\u201cSoftware\u201d) from :em AG.\n \n By installing, copying, or otherwise using the Software, the Customer agrees to be bound by the terms of this\n Agreement. If the Customer does not agree to the terms of this Agreement, the Customer must not use the\n Software and must delete or return any copies of the Software to :em AG.\n \n ## 1. Grant of License\n \n Subject to the terms and conditions of this Agreement, :em AG grants the Customer a non-exclusive,\n non-transferable, revocable license to use the Software solely for the Customer\u2019s own internal business\n purposes on systems owned or controlled by the Customer (\u201cCustomer Systems\u201d). The Customer may also allow\n its service providers to use the Software on Customer Systems, provided that such service providers agree\n to comply with the terms of this Agreement and the Customer remains responsible for their actions.\n \n The Customer may not:\n \n * sublicense, sell, rent, lease, lend, distribute, or otherwise transfer the Software or any rights under\n this Agreement to any third party without the prior written consent of :em AG;\n * modify, adapt, translate, reverse engineer, decompile, disassemble, or create derivative works based\n on the Software or any part thereof;\n * remove, alter, or obscure any copyright notices or other proprietary notices on the Software;\n use the Software for any illegal, unethical, or unauthorized purpose;\n * use the Software in a manner that infringes or violates the rights of :em AG or any third party.\n \n ## 2. Reservation of Rights\n \n :em AG retains all right, title, and interest in and to the Software and any copies thereof.\n The Software is protected by copyright and other intellectual property laws and treaties.\n The Software is licensed, not sold. Nothing in this Agreement shall be construed as transferring any\n ownership rights in the Software to the Customer.\n \n :em AG reserves the right to use the Software for any purpose, including but not limited to providing it to\n other customers of :em AG, changing its license terms for future versions, or discontinuing its development\n or support.\n \n ## 3. Disclaimer of Warranty\n \n The Software is provided \u201cas is\u201d without any warranty of any kind, either express or implied, including but\n not limited to the implied warranties of merchantability, fitness for a particular purpose, or\n non-infringement.\n \n :em AG does not warrant that the Software will meet the Customer\u2019s requirements, that it will operate\n uninterrupted or error-free, that it will be compatible with any other software or hardware, or that it will\n be free from defects or viruses.\n \n The Customer acknowledges that it has relied on its own skill and judgment in selecting and using the Software\n and that it is solely responsible for the results obtained from the Software.\n \n ## 4. Limitation of Liability\n \n To the maximum extent permitted by applicable law, in no event shall :em AG be liable for any direct,\n indirect, incidental, special, consequential, or exemplary damages arising out of or in connection with this\n Agreement or the use or inability to use the Software, even if :em AG has been advised of the possibility of\n such damages. In any case, :em AG\u2019s total liability under this Agreement shall not exceed the amount paid by\n the Customer for the Software.\n \n ## 5. Termination\n \n This Agreement shall remain in effect until terminated by either party. The Customer may terminate this\n Agreement at any time by ceasing to use the Software and deleting or returning all copies of the Software\n to :em AG. :em AG may terminate this Agreement at any time if the Customer breaches any term of this\n Agreement.\n \n Upon termination of this Agreement for any reason, all rights and licenses granted to the Customer under\n this Agreement shall cease and the Customer shall destroy or return all copies of the Software to :em AG.\n \n ## 6. General\n \n This Agreement constitutes the entire agreement between the parties with respect to the subject matter hereof\n and supersedes all prior or contemporaneous agreements or understandings, whether written or oral. This\n Agreement may not be modified or amended except by a written instrument signed by both parties.\n \n This Agreement shall be governed by and construed in accordance with the laws of Germany without regard to its\n conflict of laws principles. Any dispute arising out of or relating to this Agreement shall be submitted to\n the exclusive jurisdiction of the competent courts of Munich, Germany.\n \n If any provision of this Agreement is held to be invalid, illegal, or unenforceable, the remaining provisions\n shall remain in full force and effect.\n \n The failure of either party to enforce any right or provision of this Agreement shall not constitute a waiver\n of such right or provision.\n \n The Customer may not assign or transfer this Agreement or any rights or obligations under this Agreement\n without the prior written consent of :em AG. :em AG may assign or transfer this Agreement or any rights\n or obligations under this Agreement without the consent of the Customer.\n \n The Customer agrees to comply with all applicable laws and regulations in connection with its use of the\n Software, including but not limited to export control laws and data protection laws.\n \n The Customer acknowledges that it has read and understood this Agreement and agrees to be bound by its terms\n and conditions. The Customer also agrees that this Agreement is the complete and exclusive statement of the\n agreement between the parties and supersedes any proposal or prior agreement, oral or written, and any other\n communications between the parties relating to the subject matter of this Agreement.\n ",
"summary": "Generic python HTTP client for communication with various types of AAS servers",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/fluid40/aas-http-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "27a4a08561649c7bbaa8b3128a91f40f07c2db43743b7a06d908ac44e725a5a9",
"md5": "9e1df93a84230c59a35ad1500000f211",
"sha256": "cbebcb4eb3d5df87666722e323a576f0ffb77d405eac84af7cbcb4093a502538"
},
"downloads": -1,
"filename": "aas_http_client-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e1df93a84230c59a35ad1500000f211",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20198,
"upload_time": "2025-08-29T12:11:51",
"upload_time_iso_8601": "2025-08-29T12:11:51.695404Z",
"url": "https://files.pythonhosted.org/packages/27/a4/a08561649c7bbaa8b3128a91f40f07c2db43743b7a06d908ac44e725a5a9/aas_http_client-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7183e0be3c2cc337b39e93d684fe0192adff531341385fe7db8336700dc6580f",
"md5": "2aff69c30ded6e7a512ebabc838c35a8",
"sha256": "d1e21bae99bc7a5f68b79c1d7b7c51f0ea139397c5d6096e289e50c2163039ae"
},
"downloads": -1,
"filename": "aas_http_client-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "2aff69c30ded6e7a512ebabc838c35a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22816,
"upload_time": "2025-08-29T12:11:52",
"upload_time_iso_8601": "2025-08-29T12:11:52.905837Z",
"url": "https://files.pythonhosted.org/packages/71/83/e0be3c2cc337b39e93d684fe0192adff531341385fe7db8336700dc6580f/aas_http_client-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 12:11:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fluid40",
"github_project": "aas-http-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "typing",
"specs": [
[
">=",
"3.7.4.3"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2.11.5"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.32.3"
]
]
},
{
"name": "pytest",
"specs": [
[
">=",
"8.3.5"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
">=",
"6.1.1"
]
]
},
{
"name": "build",
"specs": [
[
">=",
"1.2.2"
]
]
},
{
"name": "python-json-logger",
"specs": [
[
">=",
"3.3.0"
]
]
},
{
"name": "pre_commit",
"specs": [
[
">=",
"4.3.0"
]
]
},
{
"name": "commitizen",
"specs": [
[
">=",
"4.8.3"
]
]
},
{
"name": "basyx-python-sdk",
"specs": [
[
">=",
"1.2.1"
]
]
}
],
"lcname": "aas-http-client"
}
