AAS HTTP Client

PyPI version License: MIT CI

AAS HTTP Client is a flexible Python library for interacting with Asset Administration Shell (AAS) and submodel repository servers over HTTP. It uses standard Python dictionaries for function inputs and outputs, making it easy to integrate with a variety of workflows. The client implements the most widely used endpoints defined in the AAS server specification, ensuring compatibility with multiple AAS repository server implementations. This allows you to connect to different AAS servers without changing your client code.

Notes:

  • Each client instance communicates with exactly one AAS server (1-to-1 mapping). For multiple servers, create multiple instances.
  • From version 1.0.0 the client includes implementations for all endpoints from BaSxy Java SDK 'aas-registry', 'submodel-registry' and 'aas-environment'.

Table of Contents:

🚀 Features

  • ✅ Easy REST communication with AAS-compliant servers
  • ✅ Support for Registry, AAS, and Submodel Repository endpoints
  • ✅ Optional wrapper for the Eclipse BaSyx Python SDK
  • ✅ Built-in authentication (Bearer, OAuth, Basic)
  • ✅ Pagination support
  • ✅ Utility modules (encoding, model builder, SDK tools)
  • ✅ Tested with multiple AAS server implementations

🏗️ Supported Servers

The client has been tested with:

Actual behavior depends on each server's implementation of the AAS Specification

🧰 Wrappers

Wrappers provide a higher-level interface on top of the raw HTTP client. Use them when you want to work with SDK objects instead of plain Python dictionaries returned by the REST API.

Currently available wrappers:

What the BaSyx Wrapper Adds:

  • Accepts and returns basyx.aas.model objects for common AAS and submodel operations
  • Reuses the same connection and authentication settings as the base HTTP client
  • Supports wrapper creation from a URL, a Python dictionary, or a configuration file
  • Keeps low-level client access available through wrapper.get_client() when needed

🔧 Provided Utilities

The AAS HTTP Client package also include some utility functions for for recurring tasks (provided by import aas_http_client.utilities ):

  • encoder: base64 encoding and decoding
  • sdk_tools: e.g. Framework object serialization and deserialization, basic submodel operations
  • model_builder: creation of some basic AAS model elements

See Utilities API Reference

📚 Resources

📘 Documentation

📝 Changelog

🤖 GitHub Releases

📦 Pypi Packages

📜 MIT License

⚡ Quickstart

For a detailed introduction, please read Getting Started.

pip install aas-http-client

Client

from aas_http_client.classes.client import aas_client

client = aas_client.create_by_url(base_url="http://localhost:8081")

shells_paginated = client.shells.get_all_asset_administration_shells()
print(shells_paginated.get("results", []))

Wrapper

from aas_http_client.classes.wrapper import sdk_wrapper

wrapper = sdk_wrapper.create_by_url(base_url="http://localhost:8081")

shells = wrapper.get_all_asset_administration_shells()
print(shells)

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.2.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for dk-emag from gravatar.com dk-emag

Credits

Author: Daniel Klein

License

MIT License

Requires

Python >=3.10

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aas_http_client-1.2.2.tar.gz (46.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aas_http_client-1.2.2-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

Details for the file aas_http_client-1.2.2.tar.gz.

File metadata

  • Download URL: aas_http_client-1.2.2.tar.gz
  • Upload date:
  • Size: 46.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.15

File hashes

Hashes for aas_http_client-1.2.2.tar.gz
Algorithm Hash digest
SHA256 76fbe960eb49fbbdb750adab6c3e9eb08351380818ff01de5528e6af8e7f67c0
MD5 1874e4073a7a5d1a5cdff19b3c172d8c
BLAKE2b-256 50b126574dd26e5ac68297dfffff8e2d79e309e4b02c3acf829bbb7219881434

See more details on using hashes here.

File details

Details for the file aas_http_client-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for aas_http_client-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 527ba83a2e51c141b3b6b8ae9428ca396351adbe42f45f5ddca7b448d69d1fff
MD5 e97428e1350e949ead5f74bc2c690187
BLAKE2b-256 3014df113c8267a047987b3a9427c3e9aa9a01f4fcfab2945b0c5c4d5cc07fe7

See more details on using hashes here.

Release history Release notifications | RSS feed

1.2.3

2 files

This release

1.2.2 This release

2 files

1.2.1

2 files

1.2.0

2 files

1.1.10

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

0.9.7

2 files

0.9.6

2 files

0.9.5

2 files

0.9.4

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.5

2 files

0.8.2

2 files

0.8.0

2 files

0.7.5

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.9

2 files

0.3.8

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.61

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.92

2 files

0.1.91

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page