Skip to content

Commit

Permalink
Update the project meta data
Browse files Browse the repository at this point in the history
  • Loading branch information
Hanna-Shalamitskaya-EPAM committed Nov 9, 2023
1 parent 587dcc6 commit e258706
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tagged_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,4 @@ jobs:
poetry run download-samm-release
poetry build
poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
# poetry publish
poetry publish
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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:

````
Expand Down
6 changes: 3 additions & 3 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ESMF SDK Python Aspect Model loader
# ESMF SDK Python Aspect Model Loader

## Table of Contents

Expand All @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions core/esmf-aspect-meta-model-python/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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 = (
Expand Down
9 changes: 7 additions & 2 deletions core/esmf-aspect-meta-model-python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -13,14 +13,19 @@ 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"
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"
Expand Down
4 changes: 2 additions & 2 deletions documentation/python-sdk-guide/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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]

----
Expand Down

0 comments on commit e258706

Please sign in to comment.