From e25870608da295bea490227bafbf390e50358eda Mon Sep 17 00:00:00 2001 From: "Hanna Shalamitskaya (EPAM)" Date: Thu, 9 Nov 2023 17:44:18 +0500 Subject: [PATCH] Update the project meta data --- .github/workflows/tagged_release.yml | 2 +- CONTRIBUTING.md | 14 +++++++------- CONVENTIONS.md | 6 +++--- README.md | 4 ++-- core/esmf-aspect-meta-model-python/README.md | 8 ++++---- .../download_samm_release.py | 4 ++-- core/esmf-aspect-meta-model-python/pyproject.toml | 9 +++++++-- .../python-sdk-guide/modules/ROOT/pages/index.adoc | 4 ++-- 8 files changed, 28 insertions(+), 23 deletions(-) diff --git a/.github/workflows/tagged_release.yml b/.github/workflows/tagged_release.yml index 8fec554..d09d6f9 100644 --- a/.github/workflows/tagged_release.yml +++ b/.github/workflows/tagged_release.yml @@ -149,4 +149,4 @@ jobs: poetry run download-samm-release poetry build poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }} -# poetry publish + poetry publish diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d63c38..2281765 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contribution Guideline ESMF SDK PY Aspect Model loader -Thank you for your interest in contributing to the ESMF SDK PY Aspect Model loader. Use this repository to contribute to the SDK as easy and +# Contribution Guideline ESMF SDK PY Aspect Model Loader +Thank you for your interest in contributing to the ESMF SDK PY Aspect Model Loader. Use this repository to contribute to the SDK as easy and transparent as possible, whether it is: * Reporting a bug @@ -10,17 +10,17 @@ transparent as possible, whether it is: ## IDTA ESMF and Roles -The ESMF SDK PY Aspect Model loader is developed in the context of the Eclipse Semantic Modeling Framework (ESMF). +The ESMF SDK PY Aspect Model Loader is developed in the context of the Eclipse Semantic Modeling Framework (ESMF). More information about the ESMF is available under [https://projects.eclipse.org/projects/dt.esmf](https://projects.eclipse.org/projects/dt.esmf). The overall goal of the ESMF is to work on a Semantic Data Structuring Layer that addresses the needs to share, join, and reuse heterogeneous data of the manufacturing. -The ESMF SDK PY Aspect Model loader is based on the Semantic Aspect Meta Model and supports its use. +The ESMF SDK PY Aspect Model Loader is based on the Semantic Aspect Meta Model and supports its use. # Contributing Source Code (using GitHub) * We use this GitHub repository to track issues and feature requests, as well as discuss and manage all PR's related to this project. -* Opening `Issues` and `PRs` in GitHub is the preferred way to interact with the community around the ESMF SDK PY Aspect Model loader. +* Opening `Issues` and `PRs` in GitHub is the preferred way to interact with the community around the ESMF SDK PY Aspect Model Loader. ## Architecture Decision Records @@ -161,7 +161,7 @@ Please also check used third party material for license compatibility with the M E.g. software licensed under GPL, AGPL or, a similar strong copy-left license cannot be approved. # Code Conventions -The ESMF SDK PY Aspect Model loader is written in the Python Programming Language. Please have a look into our [Code Conventions](CONVENTIONS.md). +The ESMF SDK PY Aspect Model Loader is written in the Python Programming Language. Please have a look into our [Code Conventions](CONVENTIONS.md). # Release Process The working group may decide that it reached a stable state for the contents of the repository. @@ -176,7 +176,7 @@ notified. After that notification, a `maintainer` triggers the release feature f which the `v{version_number}-RC` branch is based. ## Versioning -We use Semantic Versioning to identify released versions of the ESMF SDK PY Aspect Model loader. Semantic Versioning is documented +We use Semantic Versioning to identify released versions of the ESMF SDK PY Aspect Model Loader. Semantic Versioning is documented [here](https://semver.org). It proposes to have a versioning number with the following elements: ```` diff --git a/CONVENTIONS.md b/CONVENTIONS.md index b54e395..676bb9c 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -1,10 +1,10 @@ -# ESMF SDK PY Aspect Model loader Code Conventions +# ESMF SDK PY Aspect Model Loader Code Conventions -The following document contains a compilation of conventions and guidelines to format, structure and write code for the ESMF SDK PY Aspect Model loader. +The following document contains a compilation of conventions and guidelines to format, structure and write code for the ESMF SDK PY Aspect Model Loader. ## General Conventions Our code conventions are based on the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) but -detailed and adjusted for the needs of the ESMF SDK py aspect model loader. +detailed and adjusted for the needs of the ESMF SDK py Aspect Model Loader. ## Copyright header See [CONTRIBUTING](CONTRIBUTING.md) diff --git a/README.md b/README.md index 2842110..3daeb89 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ESMF SDK Python Aspect Model loader +# ESMF SDK Python Aspect Model Loader ## Table of Contents @@ -21,7 +21,7 @@ ## Introduction -The ESMF SDK Python Aspect Model loader contains artifacts and resources for all parties that intent to use, extend or +The ESMF SDK Python Aspect Model Loader contains artifacts and resources for all parties that intent to use, extend or integrate with the Semantic Aspect Meta Model, e.g., Solution Developers, Domain Experts or OEMs. diff --git a/core/esmf-aspect-meta-model-python/README.md b/core/esmf-aspect-meta-model-python/README.md index 270f56a..c0c9856 100644 --- a/core/esmf-aspect-meta-model-python/README.md +++ b/core/esmf-aspect-meta-model-python/README.md @@ -1,5 +1,5 @@ -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 Aspect Model Loader as part of the Python SDK provided by the [*Eclipse Semantic Modeling Framework*]( +https://projects.eclipse.org/projects/dt.esmf]). # An Aspect of the Meta Model @@ -49,7 +49,7 @@ Link to all Releases: https://github.com/eclipse-esmf/esmf-semantic-aspect-meta- ### Possibility 2 (downloading from the repository) -It may happen that there is no .JAR file that is up to date with the changes of the SAMM. +It may happen that there is no .jar file that is up to date with the changes of the SAMM. This script is an alternative to the `download_samm_release.py` and extracts the files from the repository directly instead of using the newest release. @@ -62,4 +62,4 @@ This script can be executed with ``` poetry run download-samm-branch ``` - +to download and start working with the Aspect Model Loader. diff --git a/core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/download_samm_release.py b/core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/download_samm_release.py index df45b23..155a475 100644 --- a/core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/download_samm_release.py +++ b/core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/download_samm_release.py @@ -19,14 +19,14 @@ def main(): - """Downloads the release .JAR of the samm for the selected version and extracts the SAMM files""" + """Downloads the release .jar of the samm for the selected version and extracts the SAMM files""" download_jar(SAMM_VERSION_TO_DOWNLOAD) extract_jar(SAMM_VERSION_TO_DOWNLOAD) print("current path: ", pathlib.Path().resolve()) def download_jar(version): - """Downloads the release .JAR of the samm for the selected version""" + """Downloads the release .jar of the samm for the selected version""" print(f"Start downloading SAMM Version {version}") url = ( diff --git a/core/esmf-aspect-meta-model-python/pyproject.toml b/core/esmf-aspect-meta-model-python/pyproject.toml index 507397a..617f481 100644 --- a/core/esmf-aspect-meta-model-python/pyproject.toml +++ b/core/esmf-aspect-meta-model-python/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "esmf-aspect-model-loader" -version = "0.0.1" +version = "2.0.0" description = "Load Aspect Models based on the Semantic Aspect Meta Model" authors = [ "Eclipse Semantic Modeling Framework", @@ -13,6 +13,11 @@ authors = [ packages = [{include = "esmf_aspect_meta_model_python"}] include = ["esmf_aspect_meta_model_python/samm_aspect_meta_model/samm/**/*"] license = "MPL-2.0" +classifiers = [ + "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", +] readme = "README.md" keywords = ["samm", "esmf", "digital twin", "idta", "model loader", "semantic api", "semantics", "aspect"] homepage = "https://projects.eclipse.org/projects/dt.esmf" @@ -20,7 +25,7 @@ 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" diff --git a/documentation/python-sdk-guide/modules/ROOT/pages/index.adoc b/documentation/python-sdk-guide/modules/ROOT/pages/index.adoc index 8c5c04a..3fe5857 100644 --- a/documentation/python-sdk-guide/modules/ROOT/pages/index.adoc +++ b/documentation/python-sdk-guide/modules/ROOT/pages/index.adoc @@ -12,7 +12,7 @@ SPDX-License-Identifier: MPL-2.0 //// -= ESMF SDK Python Aspect Model loader += ESMF SDK Python Aspect Model Loader The Python SDK offers functionality which helps software developers to work with Aspect Models in their Python applications. @@ -101,7 +101,7 @@ Aspect model. ==== Loading an Aspect Model from one *.ttl file -Import the Aspect Model loader in your Python module +Import the Aspect Model Loader in your Python module [source,python] ----