Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/tox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions#understanding-the-workflow-file
# https://docs.github.com/pt/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
# https://github.com/actions/virtual-environments#available-environments
# ubuntu-latest, ubuntu-18.04, or ubuntu-16.04
# ubuntu-latest
# windows-latest or windows-2019
# macos-latest or macos-10.15

Expand All @@ -21,10 +21,10 @@ on:

jobs:
test:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
env:
TOXENV: py3
name: metadata-test
name: oemetadata-test
strategy:
matrix:
python-version:
Expand All @@ -40,5 +40,5 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Test metadata
- name: Test oemetadata
run: tox -v
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [2.0.3] - Patch Release - Patchy Install and Repo - 2025-02-06
## [2.0.3] - Patch Release - Patch Install and Repo - 2025-02-17

### Added
- Add missing init files [(#254)](https://github.com/OpenEnergyPlatform/oemetadata/pull/254)
Expand All @@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Update procedures and documentation [(#256)](https://github.com/OpenEnergyPlatform/oemetadata/pull/256)
- Rename tests folder to test [(#256)](https://github.com/OpenEnergyPlatform/oemetadata/pull/256)
- Update workflows [(#256)](https://github.com/OpenEnergyPlatform/oemetadata/pull/256)
- Rename metadata folder to oemetadata [(#261)](https://github.com/OpenEnergyPlatform/oemetadata/pull/261)

### Removed
- Delete setup.py [(#256)](https://github.com/OpenEnergyPlatform/oemetadata/pull/256)
Expand Down
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Introduction

You can find the latest version right here:

- `template.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json>`_ contains an empty metadata string
- `example.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json>`_ contains a basic metadata example
- `metadata_key_description.md <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md>`_ contains a description of each metadata key
- `template.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/template.json>`_ contains an empty metadata string
- `example.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/example.json>`_ contains a basic metadata example
- `metadata_key_description.md <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/metadata_key_description.md>`_ contains a description of each metadata key

Documentation
=============
Expand Down Expand Up @@ -107,7 +107,7 @@ License and Citation
:alt: PyPI Version

.. |badge_python| image:: https://img.shields.io/pypi/pyversions/oemetadata
:target: https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/pyproject.toml
:target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/pyproject.toml
:alt: PyPI Python Version

.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata
Expand Down
22 changes: 11 additions & 11 deletions REUSE.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ SPDX-FileCopyrightText = "2023 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut"
SPDX-License-Identifier = "CC0-1.0"

[[annotations]]
path = "metadata/v1/v130/*.json"
path = "oemetadata/v1/v130/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2019 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2019 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -41,7 +41,7 @@ SPDX-FileCopyrightText = ["2019 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v140/*.json"
path = "oemetadata/v1/v140/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2021 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -50,7 +50,7 @@ SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v141/*.json"
path = "oemetadata/v1/v141/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2021 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -59,7 +59,7 @@ SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v150/*.json"
path = "oemetadata/v1/v150/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2021 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -68,7 +68,7 @@ SPDX-FileCopyrightText = ["2021 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v151/*.json"
path = "oemetadata/v1/v151/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2022 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2022 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -77,7 +77,7 @@ SPDX-FileCopyrightText = ["2022 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v152/*.json"
path = "oemetadata/v1/v152/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2022 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2022 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -86,7 +86,7 @@ SPDX-FileCopyrightText = ["2022 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v1/v160/*.json"
path = "oemetadata/v1/v160/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2023 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2023 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand All @@ -95,31 +95,31 @@ SPDX-FileCopyrightText = ["2023 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v2/v20/*.json"
path = "oemetadata/v2/v20/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
"oemetadata <https://github.com/OpenEnergyPlatform/oemetadata/>"]
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/v2/v20/build_source/schemas/*.json"
path = "oemetadata/v2/v20/build_source/schemas/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
"oemetadata <https://github.com/OpenEnergyPlatform/oemetadata/>"]
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/latest/*.json"
path = "oemetadata/latest/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
"oemetadata <https://github.com/OpenEnergyPlatform/oemetadata/>"]
SPDX-License-Identifier = "MIT"

[[annotations]]
path = "metadata/latest/build_source/schemas/*.json"
path = "oemetadata/latest/build_source/schemas/*.json"
precedence = "override"
SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut",
"2024 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut",
Expand Down
2 changes: 1 addition & 1 deletion docs/development/collaboration/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ It can be used for the release procedure, research projects, and complex develop

GitHub Labels are used to organize Issues and PR. <br>
Colours and emoticons improve presentation, see: <br>
📝 [github-labels.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/docs/development/git/github-labels.json)
📝 [github-labels.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/docs/development/git/github-labels.json)

## GitHub Workflows (Actions)

Expand Down
8 changes: 4 additions & 4 deletions docs/metadata/index.md → docs/oemetadata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The metadata schema is defined in [JSON schema](https://json-schema.org/) versio
The metadata contains keys in a nested JSON structure.<br>
The metadata standard includes the following files:

- [schema.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the complete metadata schema.
- [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md) contains a full description of each metadata key.
- [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json) contains an empty metadata string with all fields.
- [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json) contains a basic metadata example.
- [schema.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the complete metadata schema.
- [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/metadata_key_description.md) contains a full description of each metadata key.
- [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/template.json) contains an empty metadata string with all fields.
- [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/example.json) contains a basic metadata example.
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ SPDX-License-Identifier: MIT
# OEMetadata - Key Description

This pages describes the key of **OEMetadata version 2.0 .** <br>
You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json) of the metadata string.<br>
The [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the complete metadata schema.
You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/example.json) of the metadata string.<br>
The [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the complete metadata schema.

## Introduction

Expand Down Expand Up @@ -60,7 +60,7 @@ If a value is not yet available, use: `ToDo`.
### Collection Keys
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------|
| 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json) | | Platinum | [0..1] |
| 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | | Platinum | [0..1] |
| 2 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] |
| 3 | title | A human readable dataset name. | OEP OEMetadata | [dct:title](http://purl.org/dc/terms/title) | Bronze | [0..1] |
| 4 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] |
Expand Down Expand Up @@ -235,7 +235,7 @@ If a value is not yet available, use: `ToDo`.
|--------------------|-------------------------------------------------------------------------------------------------------------------------|
| **Key** | @context |
| **Description** | Explanation of metadata keys in ontology terms. |
| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json) |
| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) |
| **Ontology Class** | |
| **Badge** | Platinum |
| **Card.** | [0..1] |
Expand Down
6 changes: 3 additions & 3 deletions docs/user_documentation/functions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ See the [mkdocstrings documentation](https://mkdocstrings.github.io/).
- Run in Python:

```python
from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE
from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA
from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE
from oemetadata.latest.example import OEMETADATA_LATEST_EXAMPLE
from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA
from oemetadata.latest.template import OEMETADATA_LATEST_TEMPLATE

print(OEMETADATA_LATEST_EXAMPLE)
print(OEMETADATA_LATEST_SCHEMA)
Expand Down
4 changes: 2 additions & 2 deletions docs/user_documentation/test/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Solutions:

!!! note "About the example"
Below you see the rendered version of the example test
`test/metadata/latest`
`test/oemetadata/latest`

::: test.metadata.latest
::: test.oemetadata.latest
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@ nav:
- Release:
- development/release/index.md
- Metadata Documentation:
- metadata/index.md
- Metadata Key Description: metadata/metadata_key_description.md
- Crosswalks and Mappings: metadata/metadata_mappings.md
- oemetadata/index.md
- Metadata Key Description: oemetadata/metadata_key_description.md
- Crosswalks and Mappings: oemetadata/metadata_mappings.md
- User Documentation:
- Install:
- user_documentation/install/index.md
- Functions:
- user_documentation/functions/index.md
- user_documentation/functions/index.md
- Tests:
- user_documentation/test/index.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions metadata/v2/v20/README.md → oemetadata/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ This release is fully integrated into the OEP.

The OEMetadata contains the following files:

* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json) contains an empty metadata string with all fields.
* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json) contains a basic metadata example.
* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md) contains a full description of each metadata key and an example.
* [context.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/context.json) contains the references of metadata keys in ontology terms.
* [schema.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the json schema for the metadata.
* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/template.json) contains an empty metadata string with all fields.
* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/example.json) contains a basic metadata example.
* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/metadata_key_description.md) contains a full description of each metadata key and an example.
* [context.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/context.json) contains the references of metadata keys in ontology terms.
* [schema.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the json schema for the metadata.

For further information see the [Changelog](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CHANGELOG.md).
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/schema.json",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/schema.json",
"description": "Open Energy Metadata (OEMetadata) - metadata schema",
"type": "object",
"required": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/build_source/schemas/context.json",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/context.json",
"type": "object",
"properties": {
"context": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/build_source/schemas/collection.json",
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/build_source/schemas/collection.json",
"type": "object",
"properties": {
"@context": {
"description": "Explanation of metadata keys in ontology terms.",
"examples": [
"https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json"
"https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json"
],
"type": [
"string",
Expand Down
Loading
Loading