Skip to content

Commit

Permalink
Extract compliance tool to be its own package
Browse files Browse the repository at this point in the history
We extract the compliance_tool into its own
package, since the functionality is not needed
in the general SDK anymore.

The new aas-compliance-tool can be found
[here](https://github.com/rwth-iat/aas-compliance-tool).
  • Loading branch information
s-heppner committed Mar 4, 2024
1 parent d7a2283 commit eb86c83
Show file tree
Hide file tree
Showing 58 changed files with 1 addition and 26,752 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ The BaSyx Python SDK project provides the `basax.aas` Python package with 6 subm
* `basyx.aas.model`: The AAS metamodel implemented in python
* `basyx.aas.adapter`: Adapters for various file formats
* `basyx.aas.backend`: Backend infrastructure for storing and retrieving AAS objects
* `basyx.aas.compliance_tool`: Compliance checker for AAS files
* `basyx.aas.util`: Provides utilities
* `basyx.aas.examples`: Example data and tutorials

Expand Down Expand Up @@ -152,22 +151,7 @@ A detailed, complete API documentation is available on Read the Docs: https://ba

### Compliance Tool

The Eclipse BaSyx Python SDK project contains a compliance tool for testing xml and json files is provided in the
`basyx.aas.compliance_tool`-package. 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 offical 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

Invoking should work with either `python -m basyx.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 `basyx.aas.compliance_tool`-package or invoke with
`python -m basyx.aas.compliance_tool.cli --help` respectively `aas-compliance-check --help`.
The compliance tool functionality moved to [github.com/rwth-iat/aas-compliance-tool](https://github.com/rwth-iat/aas-compliance-tool).

## Contributing

Expand Down
3 changes: 0 additions & 3 deletions basyx/aas/adapter/json/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
AAS objects within a JSON file and return them as BaSyx Python SDK
:class:`ObjectStore <basyx.aas.model.provider.AbstractObjectStore>`.
"""
import os.path

from .json_serialization import AASToJsonEncoder, StrippedAASToJsonEncoder, write_aas_json_file, object_store_to_json
from .json_deserialization import AASFromJsonDecoder, StrictAASFromJsonDecoder, StrippedAASFromJsonDecoder, \
StrictStrippedAASFromJsonDecoder, read_aas_json_file, read_aas_json_file_into

JSON_SCHEMA_FILE = os.path.join(os.path.dirname(__file__), 'aasJSONSchema.json')
Loading

0 comments on commit eb86c83

Please sign in to comment.