Merge pull request #21 from bci-oss/publish-loader-on-PyPi

Publish loader on PyPi

Author: atextor

core/esmf-aspect-meta-model-python/README.md

@@ -1,12 +1,15 @@
-# Aspect Meta Model
+The aspect model loader as part of the Python SDK provided by the [*Eclipse Semantic Modeling Framework*](
+https://projects.eclipse.org/projects/dt.esmf])
 
-The `esmf-aspect-meta-model-python` package provides the Python implementation for the SAMM Aspect Meta Model, or SAMM.
+# An Aspect of the Meta Model
+
+The `esmf-aspect-model-loader` package provides the Python implementation for the SAMM Aspect Meta Model, or SAMM.
 Each Meta Model element and each Characteristic class is represented by an interface with a corresponding
 implementation.
 
 ## Usage
 
-An Aspect of the Meta Model can be instantiated as follows using the provided `AspectInstantiator`.
+An Aspect of the Meta Model can be created as follows using the provided `AspectInstantiator`.
 
 ```
 aspect_loader = AspectLoader()
@@ -22,15 +25,13 @@ aspect = aspect_loader.load_aspect_model_from_multiple_files(["list/of/paths/to/
 
 ## Automatic Deployment
 
-A [release GitHub action](https://github.com/eclipse-esmf/esmf-sdk-py-aspect-model-loader/actions/workflows/tagged_release.yml)
-has been setup for the
-`esmf-aspect-meta-model` component where the module will be build and checked to ensure code quality by running test
-files and the [static type checker MyPy](https://github.com/python/mypy) and
+A [GitHub action called 'Release'](https://github.com/eclipse-esmf/esmf-sdk-py-aspect-model-loader/actions/workflows/tagged_release.yml)
+has been set up for the `esmf-aspect-model-loader`. This action checks the code quality by running tests, the [static type checker MyPy](https://github.com/python/mypy) and
 the [code formatter 'Black'](https://github.com/psf/black).
 
-## Set Up SAMM Aspect Meta Model für development
+## Set Up SAMM Aspect Meta Model for development
 
-In order to download the SAMM sources, it is required to run `poetry install` once in the `esmf-aspect-meta-model-python`
+In order to download the SAMM sources, it is required to run `poetry install` once in the `esmf-aspect-model-loader`
 module. There are two possibilities to download the SAMM files and extract the Turtle sources for the Meta Model.
 
 ### Possibility 1 (downloading a release)

core/esmf-aspect-meta-model-python/pyproject.toml

@@ -1,16 +1,26 @@
 [tool.poetry]
-name = "esmf-aspect-meta-model-python"
+name = "esmf-aspect-model-loader"
 version = "0.0.1"
-description = ""
+description = "Load Aspect Models based on the Semantic Aspect Meta Model"
 authors = [
-    "Aghyad Farrouh <[email protected]>",
-    "Georg Schmidt-Dumont <[email protected]>",
-    "Nico Makowe <[email protected]>",
+    "Eclipse Semantic Modeling Framework",
+    "Hanna Shalamitskaya <[email protected]>",
+    "Andreas Textor <[email protected]> ",
+    "Georg Schmidt-Dumont <[email protected]>",
+    "Nico Makowe",
+    "Aghyad Farrouh",
 ]
+packages = [{include = "esmf_aspect_meta_model_python"}]
 include = ["esmf_aspect_meta_model_python/samm_aspect_meta_model/samm/**/*"]
+license = "MPL-2.0"
+readme = "README.md"
+keywords = ["samm", "esmf", "digital twin", "idta", "model loader", "semantic api", "semantics", "aspect"]
+homepage = "https://projects.eclipse.org/projects/dt.esmf"
+repository = "https://github.com/bci-oss/esmf-sdk-py-aspect-model-loader"
+documentation = "https://eclipse-esmf.github.io/python-sdk-guide/index.html"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = ">=3.10"
 rdflib = "^6.2.0"
 requests = "^2.28.1"
 tox = "^4.5.2"