Skip to content

Commit 933e0e1

Browse files
authored
Merge pull request #23 from bci-oss/update-project-meta-data
Update the project meta data
2 parents 587dcc6 + e258706 commit 933e0e1

File tree

8 files changed

+28
-23
lines changed

8 files changed

+28
-23
lines changed

.github/workflows/tagged_release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,4 +149,4 @@ jobs:
149149
poetry run download-samm-release
150150
poetry build
151151
poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
152-
# poetry publish
152+
poetry publish

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
# Contribution Guideline ESMF SDK PY Aspect Model loader
3-
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
2+
# Contribution Guideline ESMF SDK PY Aspect Model Loader
3+
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
44
transparent as possible, whether it is:
55

66
* Reporting a bug
@@ -10,17 +10,17 @@ transparent as possible, whether it is:
1010

1111

1212
## IDTA ESMF and Roles
13-
The ESMF SDK PY Aspect Model loader is developed in the context of the Eclipse Semantic Modeling Framework (ESMF).
13+
The ESMF SDK PY Aspect Model Loader is developed in the context of the Eclipse Semantic Modeling Framework (ESMF).
1414
More information about the ESMF is available under
1515
[https://projects.eclipse.org/projects/dt.esmf](https://projects.eclipse.org/projects/dt.esmf).
1616
The overall goal of the ESMF is to work on a Semantic Data Structuring Layer that addresses the needs
1717
to share, join, and reuse heterogeneous data of the manufacturing.
18-
The ESMF SDK PY Aspect Model loader is based on the Semantic Aspect Meta Model and supports its use.
18+
The ESMF SDK PY Aspect Model Loader is based on the Semantic Aspect Meta Model and supports its use.
1919

2020
# Contributing Source Code (using GitHub)
2121
* We use this GitHub repository to track issues and feature requests, as well as discuss and manage all PR's related to
2222
this project.
23-
* Opening `Issues` and `PRs` in GitHub is the preferred way to interact with the community around the ESMF SDK PY Aspect Model loader.
23+
* Opening `Issues` and `PRs` in GitHub is the preferred way to interact with the community around the ESMF SDK PY Aspect Model Loader.
2424

2525
## Architecture Decision Records
2626

@@ -161,7 +161,7 @@ Please also check used third party material for license compatibility with the M
161161
E.g. software licensed under GPL, AGPL or, a similar strong copy-left license cannot be approved.
162162

163163
# Code Conventions
164-
The ESMF SDK PY Aspect Model loader is written in the Python Programming Language. Please have a look into our [Code Conventions](CONVENTIONS.md).
164+
The ESMF SDK PY Aspect Model Loader is written in the Python Programming Language. Please have a look into our [Code Conventions](CONVENTIONS.md).
165165

166166
# Release Process
167167
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
176176
which the `v{version_number}-RC` branch is based.
177177

178178
## Versioning
179-
We use Semantic Versioning to identify released versions of the ESMF SDK PY Aspect Model loader. Semantic Versioning is documented
179+
We use Semantic Versioning to identify released versions of the ESMF SDK PY Aspect Model Loader. Semantic Versioning is documented
180180
[here](https://semver.org). It proposes to have a versioning number with the following elements:
181181

182182
````

CONVENTIONS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# ESMF SDK PY Aspect Model loader Code Conventions
1+
# ESMF SDK PY Aspect Model Loader Code Conventions
22

3-
The following document contains a compilation of conventions and guidelines to format, structure and write code for the ESMF SDK PY Aspect Model loader.
3+
The following document contains a compilation of conventions and guidelines to format, structure and write code for the ESMF SDK PY Aspect Model Loader.
44

55
## General Conventions
66
Our code conventions are based on the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) but
7-
detailed and adjusted for the needs of the ESMF SDK py aspect model loader.
7+
detailed and adjusted for the needs of the ESMF SDK py Aspect Model Loader.
88

99
## Copyright header
1010
See [CONTRIBUTING](CONTRIBUTING.md)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ESMF SDK Python Aspect Model loader
1+
# ESMF SDK Python Aspect Model Loader
22

33
## Table of Contents
44

@@ -21,7 +21,7 @@
2121

2222
## Introduction
2323

24-
The ESMF SDK Python Aspect Model loader contains artifacts and resources for all parties that intent to use, extend or
24+
The ESMF SDK Python Aspect Model Loader contains artifacts and resources for all parties that intent to use, extend or
2525
integrate with the Semantic Aspect Meta Model, e.g., Solution Developers,
2626
Domain Experts or OEMs.
2727

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
The aspect model loader as part of the Python SDK provided by the [*Eclipse Semantic Modeling Framework*](
2-
https://projects.eclipse.org/projects/dt.esmf])
1+
The Aspect Model Loader as part of the Python SDK provided by the [*Eclipse Semantic Modeling Framework*](
2+
https://projects.eclipse.org/projects/dt.esmf]).
33

44
# An Aspect of the Meta Model
55

@@ -49,7 +49,7 @@ Link to all Releases: https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-
4949

5050
### Possibility 2 (downloading from the repository)
5151

52-
It may happen that there is no .JAR file that is up to date with the changes of the SAMM.
52+
It may happen that there is no .jar file that is up to date with the changes of the SAMM.
5353
This script is an alternative to the `download_samm_release.py` and extracts the files from the repository
5454
directly instead of using the newest release.
5555

@@ -62,4 +62,4 @@ This script can be executed with
6262
```
6363
poetry run download-samm-branch
6464
```
65-
65+
to download and start working with the Aspect Model Loader.

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/download_samm_release.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919

2020

2121
def main():
22-
"""Downloads the release .JAR of the samm for the selected version and extracts the SAMM files"""
22+
"""Downloads the release .jar of the samm for the selected version and extracts the SAMM files"""
2323
download_jar(SAMM_VERSION_TO_DOWNLOAD)
2424
extract_jar(SAMM_VERSION_TO_DOWNLOAD)
2525
print("current path: ", pathlib.Path().resolve())
2626

2727

2828
def download_jar(version):
29-
"""Downloads the release .JAR of the samm for the selected version"""
29+
"""Downloads the release .jar of the samm for the selected version"""
3030

3131
print(f"Start downloading SAMM Version {version}")
3232
url = (

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "esmf-aspect-model-loader"
3-
version = "0.0.1"
3+
version = "2.0.0"
44
description = "Load Aspect Models based on the Semantic Aspect Meta Model"
55
authors = [
66
"Eclipse Semantic Modeling Framework",
@@ -13,14 +13,19 @@ authors = [
1313
packages = [{include = "esmf_aspect_meta_model_python"}]
1414
include = ["esmf_aspect_meta_model_python/samm_aspect_meta_model/samm/**/*"]
1515
license = "MPL-2.0"
16+
classifiers = [
17+
"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
18+
"Programming Language :: Python :: 3",
19+
"Programming Language :: Python :: 3.10",
20+
]
1621
readme = "README.md"
1722
keywords = ["samm", "esmf", "digital twin", "idta", "model loader", "semantic api", "semantics", "aspect"]
1823
homepage = "https://projects.eclipse.org/projects/dt.esmf"
1924
repository = "https://github.com/bci-oss/esmf-sdk-py-aspect-model-loader"
2025
documentation = "https://eclipse-esmf.github.io/python-sdk-guide/index.html"
2126

2227
[tool.poetry.dependencies]
23-
python = ">=3.10"
28+
python = "^3.10"
2429
rdflib = "^6.2.0"
2530
requests = "^2.28.1"
2631
tox = "^4.5.2"

documentation/python-sdk-guide/modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SPDX-License-Identifier: MPL-2.0
1212
////
1313

1414

15-
= ESMF SDK Python Aspect Model loader
15+
= ESMF SDK Python Aspect Model Loader
1616

1717
The Python SDK offers functionality which helps software developers to work with Aspect Models in their Python applications.
1818

@@ -101,7 +101,7 @@ Aspect model.
101101

102102
==== Loading an Aspect Model from one *.ttl file
103103

104-
Import the Aspect Model loader in your Python module
104+
Import the Aspect Model Loader in your Python module
105105
[source,python]
106106

107107
----

0 commit comments

Comments
 (0)