diff --git a/README.md b/README.md index 1eb29c8..ad9177e 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# basyx-python-framework \ No newline at end of file +# Eclipse BaSyx Python Framework + +> [!warning] +> This project is heavily Work in Progress! + +The Eclipse BaSyx Python Framework is the successor of the [Eclipse BaSyx SDK](https://github.com/eclipse-basyx/basyx-python-sdk) and is based on generated code from [aas-core-works](https://github.com/aas-core-works/). + +## Repository Structure +We follow a monolithic repository structure, with several Python projects inside this repository. +The idea behind this is that you can pick and choose, which Python packages you need for your specific use case and do not get one very bloated package with a whole AAS server, when all you want is to write AAS files. +Here's the available Python projects: + +- [SDK](./sdk/README.md): AAS object handling +- WIP Server: AAS API and server implementation +- WIP Client: AAS API Client +- WIP Compliance Tool: AAS Compliance Checker + diff --git a/sdk/README.md b/sdk/README.md new file mode 100644 index 0000000..586ce48 --- /dev/null +++ b/sdk/README.md @@ -0,0 +1,9 @@ +# Eclipse BaSyx Python Framework SDK + +> [!warning] +> This SDK is heavily Work in Progress! + +This project implements the SDK of the Eclipse BaSyx Python Framework. +Equivalent to the old [Eclipse BaSyx Python SDK](https://github.com/eclipse-basyx/basyx-python-sdk), this introduces functionality to easily handle Asset Administration Shell objects in Python. + +This SDK is based on the brilliant [aas-core-works](https://github.com/aas-core-works/) generated SDK [aas-core3.0-Python](https://github.com/aas-core-works/aas-core3.0-python) and therefore supports the specification of the Asset Administration Shell v3.X.