Metadata-Version: 2.4
Name: basyx-compliance-tool
Version: 2.1.0
Summary: AAS compliance checker based on the Eclipse BaSyx Python SDK
Author-email: The AAS Compliance Tool authors <admins@iat.rwth-aachen.de>
License: MIT License
        
        Copyright (c) 2024 IAT, RWTH Aachen University
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/eclipse-basyx/basyx-python-sdk
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: pyecma376-2>=0.2.4
Requires-Dist: jsonschema>=4.21.1
Requires-Dist: basyx-python-sdk>=1.0.0
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pycodestyle; extra == "dev"
Requires-Dist: codeblocks; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Dynamic: license-file

# AAS Compliance Tool
An AAS compliance checker based on the [Eclipse BaSyx Python SDK](https://github.com/eclipse-basyx/basyx-python-sdk) for testing XML and JSON files.
Following functionalities are supported:

* create an xml or json file compliant to the official schema containing example Asset Administration Shell elements
* create an aasx file with xml or json files compliant to the official schema containing example Asset Administration 
Shell elements
* check if a given xml or json file is compliant to the official schema
* check if a given xml, json or aasx file is readable even if it is not compliant to the official schema
* check if the data in a given xml, json or aasx file is the same as the example data
* check if two given xml, json or aasx files contain the same Asset Administration Shell elements in any order 

## Installation

### Default installation
Install the latest release from PyPI:

```bash
pip install basyx-compliance-tool
```

### Developer installation
When working from a checkout of this repository, install the sibling SDK from the source tree *first*, then the 
compliance tool:

```bash
pip install ./sdk
pip install ./compliance_tool
```

Installing the local SDK first is what lets the tool check against your in-development metamodel: `pip` keeps the 
already-installed local SDK instead of pulling a release from PyPI.

> [!IMPORTANT]
> The compliance checks are only as current as the installed `basyx-python-sdk` — the tool reports compliance against 
> whatever metamodel version that SDK implements, not against the version named in this README. Because the dependency 
> is currently declared loosely (`basyx-python-sdk>=1.0.0`), `pip` will **not** replace an SDK that is already installed 
> and satisfies that constraint, even if it is older than the one you intend to test against. This happens silently, with 
> no error. To be sure you are checking against the intended metamodel, install or upgrade the SDK explicitly, e.g. the 
> local source tree with `pip install ./sdk` or a specific release with `pip install --upgrade "basyx-python-sdk==2.1.0"`.
>
> This manual version matching is a temporary workaround; see #592.

## Usage
Invoking should work with either `python -m aas_compliance_tool.cli` or (when installed correctly and PATH is set 
correctly) with `aas-compliance-check` on the command line.

For further usage information consider the `aas_compliance_tool`-package or invoke with 
`python -m aas_compliance_tool.cli --help` respectively `aas-compliance-check --help`.
