Skip to content

Commit 7c74866

Browse files
dk-emagCopilot
andcommitted
Update changelog formatting and add getting started guide
Co-authored-by: Copilot <copilot@github.com> Signed-off-by: Daniel Klein <daniel.klein@em.ag>
1 parent 4114302 commit 7c74866

3 files changed

Lines changed: 44 additions & 31 deletions

File tree

docs/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Changelog
1+
# 📝 Changelog
22

33
## [0.9.0] - 2026-04-17
44

docs/assets/fluid_logo.svg

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/getting_started.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# 🚀 Getting Started
2+
3+
This guide will walk you through installing and using `aas-standard-parser` .
4+
5+
- [🚀 Getting Started](#-getting-started)
6+
- [Overview](#overview)
7+
- [Installation](#installation)
8+
9+
---
10+
11+
## Overview
12+
13+
**aas-standard-parser** is a Python library for parsing and handling Asset Administration Shell (AAS) standard submodels. It provides a comprehensive set of parsers and utility helpers to extract, interpret, and work with AAS structures.
14+
15+
### Available Parsers
16+
17+
* **AAS Parser**: Extract submodel IDs and references from Asset Administration Shell structures
18+
* **Submodel Parser**: Navigate and retrieve submodel elements using intuitive dot-separated paths with support for nested collections and indexed access
19+
* **AID Parser**: Parse Asset Interface Description (AID) submodels to extract interface metadata, properties, protocol bindings, and authentication details
20+
* **AIMC Parser**: Extract and process Asset Interface Mapping Configuration (AIMC) submodels, including mapping configurations and source-sink relations
21+
22+
### Available Helpers
23+
24+
* **Collection Helpers**: Work with submodel element collections, filter by semantic ID, and extract keys from collections
25+
* **Reference Helpers**: Handle AAS references, semantic IDs, and validate reference structures
26+
* **JSON Helpers**: Load and validate submodels from JSON files with structured error handling
27+
* **Utility Functions**: General-purpose utilities for logging, validation, and data transformation
28+
29+
The library leverages the [python aas sdk framework](https://github.com/aas-core-works/aas-core3.0-python) to ensure compatibility with official AAS data models and structures.
30+
31+
## Installation
32+
33+
Prerequisites:
34+
35+
* Python 3.10 or newer
36+
37+
Install via pip:
38+
39+
```bash
40+
pip install aas-standard-parser
41+
```
42+
43+
---

0 commit comments

Comments
 (0)