Skip to main content

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)

Metadata

Release files for aas-http-client 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aas-http-client 1.3.1
File Size Uploaded Provenance Actions
aas_http_client-1.3.1.tar.gz 49.2 kB Without provenance Details for aas_http_client-1.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aas-http-client 1.3.1
File Interpreter ABI Platform Actions
aas_http_client-1.3.1-py3-none-any.whl Python 3 none any Details for aas_http_client-1.3.1-py3-none-any.whl

Total release size: 92.7 kB

Release files / aas_http_client-1.3.1.tar.gz

Download URL aas_http_client-1.3.1.tar.gz
Size 49.2 kB
Tags Source
SHA-256 checksum
How to use checksums
02b2599b80b92efb4b9b2f89b7a49143b43ae500b3cd97e80e40e9f308b06e5f
BLAKE2b-256 checksum
How to use checksums
8f288f3e728a937e32ac291c7f87068ed1d9d00bb9aee523afef4253c0c0e9fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.17

Release files / aas_http_client-1.3.1-py3-none-any.whl

Download URL aas_http_client-1.3.1-py3-none-any.whl
Size 43.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cff6491dc92481116283917527a324f1c59ebd77a656adcf629a723bc58350f0
BLAKE2b-256 checksum
How to use checksums
e1ae3515880cfcd245e305a2f35a015c9632ad8afdb814b2383062a73c168872
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.17

Security for aas-http-client 1.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page