From 60118efbce15b45a9960d42f00b027e603ff7d21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Mon, 17 Feb 2025 12:25:02 +0100 Subject: [PATCH 1/5] Update folder and file paths #251 --- .github/workflows/tox.yml | 8 +-- README.rst | 8 +-- REUSE.toml | 22 +++--- docs/development/collaboration/git.md | 2 +- docs/{metadata => oemetadata}/index.md | 8 +-- .../metadata_key_description.md | 8 +-- .../metadata_mappings.md | 0 docs/user_documentation/functions/index.md | 6 +- docs/user_documentation/test/index.md | 4 +- mkdocs.yml | 8 +-- {metadata => oemetadata}/__init__.py | 0 .../json_schema/README.md | 0 .../json_schema/__init__.py | 0 .../json_schema/draft07/__init__.py | 0 .../json_schema/draft07/schema.json | 0 .../json_schema/draft07/schema.json.license | 0 .../json_schema/draft07/schema.py | 0 .../json_schema/draft2020_12/__init__.py | 0 .../json_schema/draft2020_12/schema.json | 0 .../draft2020_12/schema.json.license | 0 .../json_schema/draft2020_12/schema.py | 0 .../v2/v20 => oemetadata/latest}/README.md | 10 +-- {metadata => oemetadata}/latest/__init__.py | 0 .../latest/build_source/README.md | 0 .../build_source/schema_structure.json | 2 +- .../schema_structure.json.license | 0 .../latest/build_source/schemas/context.json | 2 +- .../latest/build_source/schemas/dataset.json | 4 +- .../latest/build_source/schemas/fields.json | 2 +- .../latest}/build_source/schemas/general.json | 2 +- .../build_source/schemas/licenses.json | 4 +- .../latest/build_source/schemas/meta.json | 2 +- .../build_source/schemas/provenance.json | 2 +- .../latest/build_source/schemas/review.json | 2 +- .../latest}/build_source/schemas/sources.json | 2 +- .../latest/build_source/schemas/spatial.json | 2 +- .../latest/build_source/schemas/temporal.json | 2 +- .../latest/build_source/scripts/__init__.py | 0 .../build_source/scripts/create_example.py | 23 ++++--- .../build_source/scripts/create_schema.py | 0 .../build_source/scripts/create_template.py | 8 +-- .../scripts/example/contributors.json | 0 .../scripts/example/contributors.json.license | 0 .../build_source/scripts/example/fields.json | 0 .../scripts/example/fields.json.license | 0 .../latest/build_source/scripts/settings.py | 2 +- {metadata => oemetadata}/latest/context.json | 0 .../v2/v20 => oemetadata/latest}/example.json | 4 +- {metadata => oemetadata}/latest/example.py | 0 .../latest}/metadata_key_description.md | 36 +++++----- {metadata => oemetadata}/latest/schema.json | 6 +- {metadata => oemetadata}/latest/schema.py | 0 {metadata => oemetadata}/latest/template.json | 0 {metadata => oemetadata}/latest/template.py | 0 {metadata => oemetadata}/v1/__init__.py | 0 {metadata => oemetadata}/v1/v130/__init__.py | 0 {metadata => oemetadata}/v1/v130/example.json | 0 {metadata => oemetadata}/v1/v130/example.py | 0 {metadata => oemetadata}/v1/v130/schema.json | 4 +- {metadata => oemetadata}/v1/v130/schema.py | 0 .../v1/v130/template.json | 2 +- {metadata => oemetadata}/v1/v130/template.py | 0 {metadata => oemetadata}/v1/v140/__init__.py | 0 {metadata => oemetadata}/v1/v140/example.json | 2 +- {metadata => oemetadata}/v1/v140/example.py | 0 .../v1/v140/metadata_key_description.md | 2 +- {metadata => oemetadata}/v1/v140/schema.json | 6 +- {metadata => oemetadata}/v1/v140/schema.py | 0 .../v1/v140/template.json | 0 {metadata => oemetadata}/v1/v140/template.py | 0 {metadata => oemetadata}/v1/v141/__init__.py | 0 {metadata => oemetadata}/v1/v141/example.json | 2 +- {metadata => oemetadata}/v1/v141/example.py | 0 .../v1/v141/metadata_key_description.md | 2 +- {metadata => oemetadata}/v1/v141/schema.json | 4 +- {metadata => oemetadata}/v1/v141/schema.py | 0 .../v1/v141/template.json | 0 {metadata => oemetadata}/v1/v141/template.py | 0 {metadata => oemetadata}/v1/v150/README.md | 8 +-- {metadata => oemetadata}/v1/v150/__init__.py | 0 {metadata => oemetadata}/v1/v150/context.json | 0 {metadata => oemetadata}/v1/v150/example.json | 2 +- {metadata => oemetadata}/v1/v150/example.py | 0 .../v1/v150/metadata_key_description.md | 2 +- {metadata => oemetadata}/v1/v150/schema.json | 4 +- {metadata => oemetadata}/v1/v150/schema.py | 0 .../v1/v150/template.json | 0 {metadata => oemetadata}/v1/v150/template.py | 0 {metadata => oemetadata}/v1/v151/README.md | 8 +-- {metadata => oemetadata}/v1/v151/__init__.py | 0 {metadata => oemetadata}/v1/v151/context.json | 0 {metadata => oemetadata}/v1/v151/example.json | 2 +- {metadata => oemetadata}/v1/v151/example.py | 0 .../v1/v151}/metadata_key_description.md | 68 +++++++++---------- {metadata => oemetadata}/v1/v151/schema.json | 4 +- {metadata => oemetadata}/v1/v151/schema.py | 0 .../v1/v151/template.json | 2 +- {metadata => oemetadata}/v1/v151/template.py | 0 {metadata => oemetadata}/v1/v152/README.md | 8 +-- {metadata => oemetadata}/v1/v152/__init__.py | 0 {metadata => oemetadata}/v1/v152/context.json | 0 {metadata => oemetadata}/v1/v152/example.json | 2 +- {metadata => oemetadata}/v1/v152/example.py | 0 .../v1/v152}/metadata_key_description.md | 22 +++--- {metadata => oemetadata}/v1/v152/schema.json | 4 +- {metadata => oemetadata}/v1/v152/schema.py | 0 .../v1/v152/template.json | 2 +- {metadata => oemetadata}/v1/v152/template.py | 0 {metadata => oemetadata}/v1/v160/README.md | 8 +-- {metadata => oemetadata}/v1/v160/__init__.py | 0 {metadata => oemetadata}/v1/v160/context.json | 0 {metadata => oemetadata}/v1/v160/example.json | 2 +- {metadata => oemetadata}/v1/v160/example.py | 0 .../v1/v160/metadata_key_description.md | 62 ++++++++--------- {metadata => oemetadata}/v1/v160/schema.json | 2 +- {metadata => oemetadata}/v1/v160/schema.py | 0 .../v1/v160/template.json | 2 +- {metadata => oemetadata}/v1/v160/template.py | 0 {metadata => oemetadata}/v2/__init__.py | 0 .../latest => oemetadata/v2/v20}/README.md | 12 ++-- {metadata => oemetadata}/v2/v20/__init__.py | 0 .../v2/v20/build_source/README.md | 0 .../v20}/build_source/schema_structure.json | 2 +- .../schema_structure.json.license | 0 .../v2/v20/build_source/schemas/context.json | 2 +- .../v2/v20/build_source/schemas/dataset.json | 4 +- .../v2/v20/build_source/schemas/fields.json | 2 +- .../v2/v20}/build_source/schemas/general.json | 2 +- .../v20}/build_source/schemas/licenses.json | 4 +- .../v2/v20/build_source/schemas/meta.json | 2 +- .../v20/build_source/schemas/provenance.json | 2 +- .../v2/v20/build_source/schemas/review.json | 2 +- .../v2/v20}/build_source/schemas/sources.json | 2 +- .../v2/v20/build_source/schemas/spatial.json | 2 +- .../v2/v20/build_source/schemas/temporal.json | 2 +- .../v2/v20/build_source/scripts/__init__.py | 0 .../build_source/scripts/create_example.py | 19 ++++-- .../v20/build_source/scripts/create_schema.py | 0 .../build_source/scripts/create_template.py | 4 +- .../scripts/example/contributors.json | 0 .../scripts/example/contributors.json.license | 0 .../build_source/scripts/example/fields.json | 0 .../scripts/example/fields.json.license | 0 .../v2/v20/build_source/scripts/settings.py | 2 +- {metadata => oemetadata}/v2/v20/context.json | 0 .../latest => oemetadata/v2/v20}/example.json | 4 +- {metadata => oemetadata}/v2/v20/example.py | 0 .../v2/v20}/metadata_key_description.md | 38 +++++------ {metadata => oemetadata}/v2/v20/schema.json | 6 +- {metadata => oemetadata}/v2/v20/schema.py | 0 {metadata => oemetadata}/v2/v20/template.json | 0 {metadata => oemetadata}/v2/v20/template.py | 0 test/{metadata => oemetadata}/__init__.py | 0 .../json_schema/__init__.py | 0 .../json_schema/draft07/__init__.py | 0 .../json_schema/draft07/test_jsonschema.py | 4 +- .../json_schema/draft2020_12/__init__.py | 0 .../draft2020_12/test_jsonschema.py | 4 +- .../latest/__init__.py | 0 .../latest/test_context.py | 2 +- .../latest/test_example.py | 4 +- .../latest/test_schema.py | 8 +-- .../latest/test_template.py | 4 +- test/{metadata => oemetadata}/v1/__init__.py | 0 .../v1/v130/__init__.py | 0 .../v1/v130/test_example.py | 4 +- .../v1/v130/test_schema.py | 10 +-- .../v1/v130/test_template.py | 4 +- .../v1/v140/__init__.py | 0 .../v1/v140/test_example.py | 4 +- .../v1/v140/test_schema.py | 10 +-- .../v1/v140/test_template.py | 4 +- .../v1/v141/__init__.py | 0 .../v1/v141/test_example.py | 4 +- .../v1/v141/test_schema.py | 10 +-- .../v1/v141/test_template.py | 4 +- .../v1/v150/__init__.py | 0 .../v1/v150/test_example.py | 4 +- .../v1/v150/test_schema.py | 10 +-- .../v1/v150/test_template.py | 4 +- .../v1/v151/__init__.py | 0 .../v1/v151/test_example.py | 4 +- .../v1/v151/test_schema.py | 10 +-- .../v1/v151/test_template.py | 4 +- .../v1/v152/__init__.py | 0 .../v1/v152/test_example.py | 4 +- .../v1/v152/test_schema.py | 10 +-- .../v1/v152/test_template.py | 4 +- .../v1/v160/__init__.py | 0 .../v1/v160/test_example.py | 4 +- .../v1/v160/test_schema.py | 10 +-- .../v1/v160/test_template.py | 4 +- test/{metadata => oemetadata}/v2/__init__.py | 0 .../v2/v20/__init__.py | 0 .../v2/v20/test_context.py | 2 +- .../v2/v20/test_example.py | 4 +- .../v2/v20/test_schema.py | 8 +-- .../v2/v20/test_template.py | 4 +- 198 files changed, 371 insertions(+), 341 deletions(-) rename docs/{metadata => oemetadata}/index.md (71%) rename docs/{metadata => oemetadata}/metadata_key_description.md (99%) rename docs/{metadata => oemetadata}/metadata_mappings.md (100%) rename {metadata => oemetadata}/__init__.py (100%) rename {metadata => oemetadata}/json_schema/README.md (100%) rename {metadata => oemetadata}/json_schema/__init__.py (100%) rename {metadata => oemetadata}/json_schema/draft07/__init__.py (100%) rename {metadata => oemetadata}/json_schema/draft07/schema.json (100%) rename {metadata => oemetadata}/json_schema/draft07/schema.json.license (100%) rename {metadata => oemetadata}/json_schema/draft07/schema.py (100%) rename {metadata => oemetadata}/json_schema/draft2020_12/__init__.py (100%) rename {metadata => oemetadata}/json_schema/draft2020_12/schema.json (100%) rename {metadata => oemetadata}/json_schema/draft2020_12/schema.json.license (100%) rename {metadata => oemetadata}/json_schema/draft2020_12/schema.py (100%) rename {metadata/v2/v20 => oemetadata/latest}/README.md (71%) rename {metadata => oemetadata}/latest/__init__.py (100%) rename {metadata => oemetadata}/latest/build_source/README.md (100%) rename {metadata/v2/v20 => oemetadata/latest}/build_source/schema_structure.json (96%) rename {metadata => oemetadata}/latest/build_source/schema_structure.json.license (100%) rename {metadata => oemetadata}/latest/build_source/schemas/context.json (98%) rename {metadata => oemetadata}/latest/build_source/schemas/dataset.json (92%) rename {metadata => oemetadata}/latest/build_source/schemas/fields.json (99%) rename {metadata/v2/v20 => oemetadata/latest}/build_source/schemas/general.json (98%) rename {metadata/v2/v20 => oemetadata/latest}/build_source/schemas/licenses.json (96%) rename {metadata => oemetadata}/latest/build_source/schemas/meta.json (96%) rename {metadata => oemetadata}/latest/build_source/schemas/provenance.json (97%) rename {metadata => oemetadata}/latest/build_source/schemas/review.json (94%) rename {metadata/v2/v20 => oemetadata/latest}/build_source/schemas/sources.json (98%) rename {metadata => oemetadata}/latest/build_source/schemas/spatial.json (98%) rename {metadata => oemetadata}/latest/build_source/schemas/temporal.json (98%) rename {metadata => oemetadata}/latest/build_source/scripts/__init__.py (100%) rename {metadata => oemetadata}/latest/build_source/scripts/create_example.py (94%) rename {metadata => oemetadata}/latest/build_source/scripts/create_schema.py (100%) rename {metadata => oemetadata}/latest/build_source/scripts/create_template.py (95%) rename {metadata => oemetadata}/latest/build_source/scripts/example/contributors.json (100%) rename {metadata => oemetadata}/latest/build_source/scripts/example/contributors.json.license (100%) rename {metadata => oemetadata}/latest/build_source/scripts/example/fields.json (100%) rename {metadata => oemetadata}/latest/build_source/scripts/example/fields.json.license (100%) rename {metadata => oemetadata}/latest/build_source/scripts/settings.py (96%) rename {metadata => oemetadata}/latest/context.json (100%) rename {metadata/v2/v20 => oemetadata/latest}/example.json (99%) rename {metadata => oemetadata}/latest/example.py (100%) rename {metadata/v2/v20 => oemetadata/latest}/metadata_key_description.md (98%) rename {metadata => oemetadata}/latest/schema.json (99%) rename {metadata => oemetadata}/latest/schema.py (100%) rename {metadata => oemetadata}/latest/template.json (100%) rename {metadata => oemetadata}/latest/template.py (100%) rename {metadata => oemetadata}/v1/__init__.py (100%) rename {metadata => oemetadata}/v1/v130/__init__.py (100%) rename {metadata => oemetadata}/v1/v130/example.json (100%) rename {metadata => oemetadata}/v1/v130/example.py (100%) rename {metadata => oemetadata}/v1/v130/schema.json (98%) rename {metadata => oemetadata}/v1/v130/schema.py (100%) rename {metadata => oemetadata}/v1/v130/template.json (98%) rename {metadata => oemetadata}/v1/v130/template.py (100%) rename {metadata => oemetadata}/v1/v140/__init__.py (100%) rename {metadata => oemetadata}/v1/v140/example.json (99%) rename {metadata => oemetadata}/v1/v140/example.py (100%) rename {metadata => oemetadata}/v1/v140/metadata_key_description.md (99%) rename {metadata => oemetadata}/v1/v140/schema.json (99%) rename {metadata => oemetadata}/v1/v140/schema.py (100%) rename {metadata => oemetadata}/v1/v140/template.json (100%) rename {metadata => oemetadata}/v1/v140/template.py (100%) rename {metadata => oemetadata}/v1/v141/__init__.py (100%) rename {metadata => oemetadata}/v1/v141/example.json (99%) rename {metadata => oemetadata}/v1/v141/example.py (100%) rename {metadata => oemetadata}/v1/v141/metadata_key_description.md (99%) rename {metadata => oemetadata}/v1/v141/schema.json (99%) rename {metadata => oemetadata}/v1/v141/schema.py (100%) rename {metadata => oemetadata}/v1/v141/template.json (100%) rename {metadata => oemetadata}/v1/v141/template.py (100%) rename {metadata => oemetadata}/v1/v150/README.md (79%) rename {metadata => oemetadata}/v1/v150/__init__.py (100%) rename {metadata => oemetadata}/v1/v150/context.json (100%) rename {metadata => oemetadata}/v1/v150/example.json (99%) rename {metadata => oemetadata}/v1/v150/example.py (100%) rename {metadata => oemetadata}/v1/v150/metadata_key_description.md (99%) rename {metadata => oemetadata}/v1/v150/schema.json (99%) rename {metadata => oemetadata}/v1/v150/schema.py (100%) rename {metadata => oemetadata}/v1/v150/template.json (100%) rename {metadata => oemetadata}/v1/v150/template.py (100%) rename {metadata => oemetadata}/v1/v151/README.md (79%) rename {metadata => oemetadata}/v1/v151/__init__.py (100%) rename {metadata => oemetadata}/v1/v151/context.json (100%) rename {metadata => oemetadata}/v1/v151/example.json (99%) rename {metadata => oemetadata}/v1/v151/example.py (100%) rename {metadata/v1/v152 => oemetadata/v1/v151}/metadata_key_description.md (94%) rename {metadata => oemetadata}/v1/v151/schema.json (99%) rename {metadata => oemetadata}/v1/v151/schema.py (100%) rename {metadata => oemetadata}/v1/v151/template.json (98%) rename {metadata => oemetadata}/v1/v151/template.py (100%) rename {metadata => oemetadata}/v1/v152/README.md (79%) rename {metadata => oemetadata}/v1/v152/__init__.py (100%) rename {metadata => oemetadata}/v1/v152/context.json (100%) rename {metadata => oemetadata}/v1/v152/example.json (99%) rename {metadata => oemetadata}/v1/v152/example.py (100%) rename {metadata/v1/v151 => oemetadata/v1/v152}/metadata_key_description.md (98%) rename {metadata => oemetadata}/v1/v152/schema.json (99%) rename {metadata => oemetadata}/v1/v152/schema.py (100%) rename {metadata => oemetadata}/v1/v152/template.json (98%) rename {metadata => oemetadata}/v1/v152/template.py (100%) rename {metadata => oemetadata}/v1/v160/README.md (79%) rename {metadata => oemetadata}/v1/v160/__init__.py (100%) rename {metadata => oemetadata}/v1/v160/context.json (100%) rename {metadata => oemetadata}/v1/v160/example.json (99%) rename {metadata => oemetadata}/v1/v160/example.py (100%) rename {metadata => oemetadata}/v1/v160/metadata_key_description.md (97%) rename {metadata => oemetadata}/v1/v160/schema.json (99%) rename {metadata => oemetadata}/v1/v160/schema.py (100%) rename {metadata => oemetadata}/v1/v160/template.json (98%) rename {metadata => oemetadata}/v1/v160/template.py (100%) rename {metadata => oemetadata}/v2/__init__.py (100%) rename {metadata/latest => oemetadata/v2/v20}/README.md (68%) rename {metadata => oemetadata}/v2/v20/__init__.py (100%) rename {metadata => oemetadata}/v2/v20/build_source/README.md (100%) rename {metadata/latest => oemetadata/v2/v20}/build_source/schema_structure.json (96%) rename {metadata => oemetadata}/v2/v20/build_source/schema_structure.json.license (100%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/context.json (98%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/dataset.json (92%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/fields.json (99%) rename {metadata/latest => oemetadata/v2/v20}/build_source/schemas/general.json (98%) rename {metadata/latest => oemetadata/v2/v20}/build_source/schemas/licenses.json (96%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/meta.json (96%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/provenance.json (97%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/review.json (94%) rename {metadata/latest => oemetadata/v2/v20}/build_source/schemas/sources.json (98%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/spatial.json (98%) rename {metadata => oemetadata}/v2/v20/build_source/schemas/temporal.json (98%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/__init__.py (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/create_example.py (95%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/create_schema.py (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/create_template.py (97%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/example/contributors.json (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/example/contributors.json.license (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/example/fields.json (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/example/fields.json.license (100%) rename {metadata => oemetadata}/v2/v20/build_source/scripts/settings.py (96%) rename {metadata => oemetadata}/v2/v20/context.json (100%) rename {metadata/latest => oemetadata/v2/v20}/example.json (99%) rename {metadata => oemetadata}/v2/v20/example.py (100%) rename {metadata/latest => oemetadata/v2/v20}/metadata_key_description.md (98%) rename {metadata => oemetadata}/v2/v20/schema.json (99%) rename {metadata => oemetadata}/v2/v20/schema.py (100%) rename {metadata => oemetadata}/v2/v20/template.json (100%) rename {metadata => oemetadata}/v2/v20/template.py (100%) rename test/{metadata => oemetadata}/__init__.py (100%) rename test/{metadata => oemetadata}/json_schema/__init__.py (100%) rename test/{metadata => oemetadata}/json_schema/draft07/__init__.py (100%) rename test/{metadata => oemetadata}/json_schema/draft07/test_jsonschema.py (88%) rename test/{metadata => oemetadata}/json_schema/draft2020_12/__init__.py (100%) rename test/{metadata => oemetadata}/json_schema/draft2020_12/test_jsonschema.py (92%) rename test/{metadata => oemetadata}/latest/__init__.py (100%) rename test/{metadata => oemetadata}/latest/test_context.py (98%) rename test/{metadata => oemetadata}/latest/test_example.py (85%) rename test/{metadata => oemetadata}/latest/test_schema.py (85%) rename test/{metadata => oemetadata}/latest/test_template.py (85%) rename test/{metadata => oemetadata}/v1/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v130/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v130/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v130/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v130/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v140/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v140/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v140/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v140/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v141/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v141/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v141/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v141/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v150/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v150/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v150/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v150/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v151/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v151/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v151/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v151/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v152/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v152/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v152/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v152/test_template.py (85%) rename test/{metadata => oemetadata}/v1/v160/__init__.py (100%) rename test/{metadata => oemetadata}/v1/v160/test_example.py (86%) rename test/{metadata => oemetadata}/v1/v160/test_schema.py (82%) rename test/{metadata => oemetadata}/v1/v160/test_template.py (85%) rename test/{metadata => oemetadata}/v2/__init__.py (100%) rename test/{metadata => oemetadata}/v2/v20/__init__.py (100%) rename test/{metadata => oemetadata}/v2/v20/test_context.py (98%) rename test/{metadata => oemetadata}/v2/v20/test_example.py (86%) rename test/{metadata => oemetadata}/v2/v20/test_schema.py (85%) rename test/{metadata => oemetadata}/v2/v20/test_template.py (86%) diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml index 5087d6cd..12596b65 100644 --- a/.github/workflows/tox.yml +++ b/.github/workflows/tox.yml @@ -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 @@ -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: @@ -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 diff --git a/README.rst b/README.rst index 94d43577..8ca5a55e 100644 --- a/README.rst +++ b/README.rst @@ -43,9 +43,9 @@ Introduction You can find the latest version right here: -- `template.json `_ contains an empty metadata string -- `example.json `_ contains a basic metadata example -- `metadata_key_description.md `_ contains a description of each metadata key +- `template.json `_ contains an empty metadata string +- `example.json `_ contains a basic metadata example +- `metadata_key_description.md `_ contains a description of each metadata key Documentation ============= @@ -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 diff --git a/REUSE.toml b/REUSE.toml index c2445fb6..c89ef3da 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -95,7 +95,7 @@ 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", @@ -103,7 +103,7 @@ SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut 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", @@ -111,7 +111,7 @@ SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut 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", @@ -119,7 +119,7 @@ SPDX-FileCopyrightText = ["2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut 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", diff --git a/docs/development/collaboration/git.md b/docs/development/collaboration/git.md index ff8f1563..30bb5e6c 100644 --- a/docs/development/collaboration/git.md +++ b/docs/development/collaboration/git.md @@ -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.
Colours and emoticons improve presentation, see:
- 📝 [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) diff --git a/docs/metadata/index.md b/docs/oemetadata/index.md similarity index 71% rename from docs/metadata/index.md rename to docs/oemetadata/index.md index e3dfb7cc..b2e285b8 100644 --- a/docs/metadata/index.md +++ b/docs/oemetadata/index.md @@ -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.
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. diff --git a/docs/metadata/metadata_key_description.md b/docs/oemetadata/metadata_key_description.md similarity index 99% rename from docs/metadata/metadata_key_description.md rename to docs/oemetadata/metadata_key_description.md index 9f32c3d4..58cec074 100644 --- a/docs/metadata/metadata_key_description.md +++ b/docs/oemetadata/metadata_key_description.md @@ -8,8 +8,8 @@ SPDX-License-Identifier: MIT # OEMetadata - Key Description This pages describes the key of **OEMetadata version 2.0 .**
-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.
-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.
+The [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the complete metadata schema. ## Introduction @@ -60,7 +60,7 @@ If a value is not yet available, use: `ToDo`. ### Collection Keys |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| -| 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] | @@ -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] | diff --git a/docs/metadata/metadata_mappings.md b/docs/oemetadata/metadata_mappings.md similarity index 100% rename from docs/metadata/metadata_mappings.md rename to docs/oemetadata/metadata_mappings.md diff --git a/docs/user_documentation/functions/index.md b/docs/user_documentation/functions/index.md index 9e501758..2318da76 100644 --- a/docs/user_documentation/functions/index.md +++ b/docs/user_documentation/functions/index.md @@ -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) diff --git a/docs/user_documentation/test/index.md b/docs/user_documentation/test/index.md index 7d79de43..7a38912b 100644 --- a/docs/user_documentation/test/index.md +++ b/docs/user_documentation/test/index.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 7b18c9b5..40c75339 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/metadata/__init__.py b/oemetadata/__init__.py similarity index 100% rename from metadata/__init__.py rename to oemetadata/__init__.py diff --git a/metadata/json_schema/README.md b/oemetadata/json_schema/README.md similarity index 100% rename from metadata/json_schema/README.md rename to oemetadata/json_schema/README.md diff --git a/metadata/json_schema/__init__.py b/oemetadata/json_schema/__init__.py similarity index 100% rename from metadata/json_schema/__init__.py rename to oemetadata/json_schema/__init__.py diff --git a/metadata/json_schema/draft07/__init__.py b/oemetadata/json_schema/draft07/__init__.py similarity index 100% rename from metadata/json_schema/draft07/__init__.py rename to oemetadata/json_schema/draft07/__init__.py diff --git a/metadata/json_schema/draft07/schema.json b/oemetadata/json_schema/draft07/schema.json similarity index 100% rename from metadata/json_schema/draft07/schema.json rename to oemetadata/json_schema/draft07/schema.json diff --git a/metadata/json_schema/draft07/schema.json.license b/oemetadata/json_schema/draft07/schema.json.license similarity index 100% rename from metadata/json_schema/draft07/schema.json.license rename to oemetadata/json_schema/draft07/schema.json.license diff --git a/metadata/json_schema/draft07/schema.py b/oemetadata/json_schema/draft07/schema.py similarity index 100% rename from metadata/json_schema/draft07/schema.py rename to oemetadata/json_schema/draft07/schema.py diff --git a/metadata/json_schema/draft2020_12/__init__.py b/oemetadata/json_schema/draft2020_12/__init__.py similarity index 100% rename from metadata/json_schema/draft2020_12/__init__.py rename to oemetadata/json_schema/draft2020_12/__init__.py diff --git a/metadata/json_schema/draft2020_12/schema.json b/oemetadata/json_schema/draft2020_12/schema.json similarity index 100% rename from metadata/json_schema/draft2020_12/schema.json rename to oemetadata/json_schema/draft2020_12/schema.json diff --git a/metadata/json_schema/draft2020_12/schema.json.license b/oemetadata/json_schema/draft2020_12/schema.json.license similarity index 100% rename from metadata/json_schema/draft2020_12/schema.json.license rename to oemetadata/json_schema/draft2020_12/schema.json.license diff --git a/metadata/json_schema/draft2020_12/schema.py b/oemetadata/json_schema/draft2020_12/schema.py similarity index 100% rename from metadata/json_schema/draft2020_12/schema.py rename to oemetadata/json_schema/draft2020_12/schema.py diff --git a/metadata/v2/v20/README.md b/oemetadata/latest/README.md similarity index 71% rename from metadata/v2/v20/README.md rename to oemetadata/latest/README.md index 481ddd0b..8ac9c2bd 100644 --- a/metadata/v2/v20/README.md +++ b/oemetadata/latest/README.md @@ -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). diff --git a/metadata/latest/__init__.py b/oemetadata/latest/__init__.py similarity index 100% rename from metadata/latest/__init__.py rename to oemetadata/latest/__init__.py diff --git a/metadata/latest/build_source/README.md b/oemetadata/latest/build_source/README.md similarity index 100% rename from metadata/latest/build_source/README.md rename to oemetadata/latest/build_source/README.md diff --git a/metadata/v2/v20/build_source/schema_structure.json b/oemetadata/latest/build_source/schema_structure.json similarity index 96% rename from metadata/v2/v20/build_source/schema_structure.json rename to oemetadata/latest/build_source/schema_structure.json index 08e559c5..cac35ff1 100644 --- a/metadata/v2/v20/build_source/schema_structure.json +++ b/oemetadata/latest/build_source/schema_structure.json @@ -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": [ diff --git a/metadata/latest/build_source/schema_structure.json.license b/oemetadata/latest/build_source/schema_structure.json.license similarity index 100% rename from metadata/latest/build_source/schema_structure.json.license rename to oemetadata/latest/build_source/schema_structure.json.license diff --git a/metadata/latest/build_source/schemas/context.json b/oemetadata/latest/build_source/schemas/context.json similarity index 98% rename from metadata/latest/build_source/schemas/context.json rename to oemetadata/latest/build_source/schemas/context.json index d8d6fd34..ac5c3f8a 100644 --- a/metadata/latest/build_source/schemas/context.json +++ b/oemetadata/latest/build_source/schemas/context.json @@ -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": { diff --git a/metadata/latest/build_source/schemas/dataset.json b/oemetadata/latest/build_source/schemas/dataset.json similarity index 92% rename from metadata/latest/build_source/schemas/dataset.json rename to oemetadata/latest/build_source/schemas/dataset.json index 26a89855..e7684b7f 100644 --- a/metadata/latest/build_source/schemas/dataset.json +++ b/oemetadata/latest/build_source/schemas/dataset.json @@ -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", diff --git a/metadata/latest/build_source/schemas/fields.json b/oemetadata/latest/build_source/schemas/fields.json similarity index 99% rename from metadata/latest/build_source/schemas/fields.json rename to oemetadata/latest/build_source/schemas/fields.json index f3764492..d6947987 100644 --- a/metadata/latest/build_source/schemas/fields.json +++ b/oemetadata/latest/build_source/schemas/fields.json @@ -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/fields.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/build_source/schemas/fields.json", "type": "object", "properties": { "type": { diff --git a/metadata/v2/v20/build_source/schemas/general.json b/oemetadata/latest/build_source/schemas/general.json similarity index 98% rename from metadata/v2/v20/build_source/schemas/general.json rename to oemetadata/latest/build_source/schemas/general.json index cc0bdc32..7e363760 100644 --- a/metadata/v2/v20/build_source/schemas/general.json +++ b/oemetadata/latest/build_source/schemas/general.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/general.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/build_source/schemas/general.json", "type": "object", "properties": { "@id": { diff --git a/metadata/v2/v20/build_source/schemas/licenses.json b/oemetadata/latest/build_source/schemas/licenses.json similarity index 96% rename from metadata/v2/v20/build_source/schemas/licenses.json rename to oemetadata/latest/build_source/schemas/licenses.json index f7c43e41..b366cf97 100644 --- a/metadata/v2/v20/build_source/schemas/licenses.json +++ b/oemetadata/latest/build_source/schemas/licenses.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/licenses.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/licenses.json", "type": "object", "properties": { "licenses": { @@ -77,7 +77,7 @@ "null" ], "examples": [ - "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" ], "badge": "Bronze", "title": "Copyright Statement" diff --git a/metadata/latest/build_source/schemas/meta.json b/oemetadata/latest/build_source/schemas/meta.json similarity index 96% rename from metadata/latest/build_source/schemas/meta.json rename to oemetadata/latest/build_source/schemas/meta.json index 645421e6..94cd5870 100644 --- a/metadata/latest/build_source/schemas/meta.json +++ b/oemetadata/latest/build_source/schemas/meta.json @@ -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/meta.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/meta.json", "type": "object", "properties": { "metaMetadata": { diff --git a/metadata/latest/build_source/schemas/provenance.json b/oemetadata/latest/build_source/schemas/provenance.json similarity index 97% rename from metadata/latest/build_source/schemas/provenance.json rename to oemetadata/latest/build_source/schemas/provenance.json index 0a0c5b50..587e881d 100644 --- a/metadata/latest/build_source/schemas/provenance.json +++ b/oemetadata/latest/build_source/schemas/provenance.json @@ -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/provenance.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/build_source/schemas/provenance.json", "type": "object", "properties": { "contributors": { diff --git a/metadata/latest/build_source/schemas/review.json b/oemetadata/latest/build_source/schemas/review.json similarity index 94% rename from metadata/latest/build_source/schemas/review.json rename to oemetadata/latest/build_source/schemas/review.json index 0306bec7..474902fa 100644 --- a/metadata/latest/build_source/schemas/review.json +++ b/oemetadata/latest/build_source/schemas/review.json @@ -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/review.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/review.json", "type": "object", "properties": { "review": { diff --git a/metadata/v2/v20/build_source/schemas/sources.json b/oemetadata/latest/build_source/schemas/sources.json similarity index 98% rename from metadata/v2/v20/build_source/schemas/sources.json rename to oemetadata/latest/build_source/schemas/sources.json index 35d4b905..7374d52c 100644 --- a/metadata/v2/v20/build_source/schemas/sources.json +++ b/oemetadata/latest/build_source/schemas/sources.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/sources.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/sources.json", "type": "object", "properties": { "sources": { diff --git a/metadata/latest/build_source/schemas/spatial.json b/oemetadata/latest/build_source/schemas/spatial.json similarity index 98% rename from metadata/latest/build_source/schemas/spatial.json rename to oemetadata/latest/build_source/schemas/spatial.json index 96084ae0..bccce1d4 100644 --- a/metadata/latest/build_source/schemas/spatial.json +++ b/oemetadata/latest/build_source/schemas/spatial.json @@ -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/spatial.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/spatial.json", "type": "object", "properties": { "spatial": { diff --git a/metadata/latest/build_source/schemas/temporal.json b/oemetadata/latest/build_source/schemas/temporal.json similarity index 98% rename from metadata/latest/build_source/schemas/temporal.json rename to oemetadata/latest/build_source/schemas/temporal.json index 4d4ed5ee..840f4efc 100644 --- a/metadata/latest/build_source/schemas/temporal.json +++ b/oemetadata/latest/build_source/schemas/temporal.json @@ -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/temporal.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/temporal.json", "type": "object", "properties": { "temporal": { diff --git a/metadata/latest/build_source/scripts/__init__.py b/oemetadata/latest/build_source/scripts/__init__.py similarity index 100% rename from metadata/latest/build_source/scripts/__init__.py rename to oemetadata/latest/build_source/scripts/__init__.py diff --git a/metadata/latest/build_source/scripts/create_example.py b/oemetadata/latest/build_source/scripts/create_example.py similarity index 94% rename from metadata/latest/build_source/scripts/create_example.py rename to oemetadata/latest/build_source/scripts/create_example.py index 63b30cf7..571d1e7f 100644 --- a/metadata/latest/build_source/scripts/create_example.py +++ b/oemetadata/latest/build_source/scripts/create_example.py @@ -181,13 +181,15 @@ def extract_examples_from_schema( elif schema_type == "string": return "" # Example string elif schema_type == "number": - return 0 # Example number + return "0" # Example number elif schema_type == "boolean": - return True # Example boolean + return "true" # Example boolean elif schema_type == "null": return None # Example null - return None # Default fallback + # Unsupported schema + else: + raise ValueError(f"Unsupported schema_type: {schema_type}") def create_json_from_schema(schema_file: str) -> Dict[str, Any]: @@ -201,8 +203,13 @@ def create_json_from_schema(schema_file: str) -> Dict[str, Any]: """ schema = read_metadata_schema(schema_file) print(f"Create JSON from schema: {schema_file}") - return extract_examples_from_schema(schema) - print(f"Create JSON object: {result}") + result = extract_examples_from_schema(schema) + + # Ensure the result is a dictionary + if isinstance(result, dict): + return result + else: + return {} # Return an empty dictionary as a fallback def save_json(data: Dict[str, Any], filename: Path) -> None: @@ -221,13 +228,13 @@ def save_json(data: Dict[str, Any], filename: Path) -> None: def test_oemetadata_schema_should_validate_oemetadata_example(example): from jsonschema import ValidationError, validate - from metadata.v2.v20.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA try: validate(example, OEMETADATA_LATEST_SCHEMA) - logger.info("OEMetadata Example is valid OEMetadata Schema (v2.0).") + logger.info("OEMetadata Example is valid OEMetadata Schema (latest).") except ValidationError as e: - logger.info("Cannot validate OEMetadata Example with Schema (v2.0)!", e) + logger.info("Cannot validate OEMetadata Example with Schema (latest)!", e) def find_and_replace_key(data, target_key, new_value): diff --git a/metadata/latest/build_source/scripts/create_schema.py b/oemetadata/latest/build_source/scripts/create_schema.py similarity index 100% rename from metadata/latest/build_source/scripts/create_schema.py rename to oemetadata/latest/build_source/scripts/create_schema.py diff --git a/metadata/latest/build_source/scripts/create_template.py b/oemetadata/latest/build_source/scripts/create_template.py similarity index 95% rename from metadata/latest/build_source/scripts/create_template.py rename to oemetadata/latest/build_source/scripts/create_template.py index 29794658..2e3a5ff7 100644 --- a/metadata/latest/build_source/scripts/create_template.py +++ b/oemetadata/latest/build_source/scripts/create_template.py @@ -98,14 +98,14 @@ def main(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v2.v20.schema import OEMETADATA_LATEST_SCHEMA - from metadata.v2.v20.template import OEMETADATA_LATEST_TEMPLATE + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.template import OEMETADATA_LATEST_TEMPLATE try: validate(OEMETADATA_LATEST_TEMPLATE, OEMETADATA_LATEST_SCHEMA) - print("OEMetadata Template is valid OEMetadata Schema (v2.0).") + print("OEMetadata Template is valid OEMetadata Schema (latest).") except ValidationError as e: - print("Cannot validate OEMetadata Template with Schema (v2.0)!", e) + print("Cannot validate OEMetadata Template with Schema (latest)!", e) def find_and_replace_key(data, target_key, new_value): diff --git a/metadata/latest/build_source/scripts/example/contributors.json b/oemetadata/latest/build_source/scripts/example/contributors.json similarity index 100% rename from metadata/latest/build_source/scripts/example/contributors.json rename to oemetadata/latest/build_source/scripts/example/contributors.json diff --git a/metadata/latest/build_source/scripts/example/contributors.json.license b/oemetadata/latest/build_source/scripts/example/contributors.json.license similarity index 100% rename from metadata/latest/build_source/scripts/example/contributors.json.license rename to oemetadata/latest/build_source/scripts/example/contributors.json.license diff --git a/metadata/latest/build_source/scripts/example/fields.json b/oemetadata/latest/build_source/scripts/example/fields.json similarity index 100% rename from metadata/latest/build_source/scripts/example/fields.json rename to oemetadata/latest/build_source/scripts/example/fields.json diff --git a/metadata/latest/build_source/scripts/example/fields.json.license b/oemetadata/latest/build_source/scripts/example/fields.json.license similarity index 100% rename from metadata/latest/build_source/scripts/example/fields.json.license rename to oemetadata/latest/build_source/scripts/example/fields.json.license diff --git a/metadata/latest/build_source/scripts/settings.py b/oemetadata/latest/build_source/scripts/settings.py similarity index 96% rename from metadata/latest/build_source/scripts/settings.py rename to oemetadata/latest/build_source/scripts/settings.py index 2c5a6d1d..2da1cad4 100644 --- a/metadata/latest/build_source/scripts/settings.py +++ b/oemetadata/latest/build_source/scripts/settings.py @@ -8,7 +8,7 @@ LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s" -BASE_PATH = Path("metadata/v2/") +BASE_PATH = Path("oemetadata/v2/") VERSION = "v20" VERSION_PATH = BASE_PATH / VERSION SCHEMA_BUILD_PATH = VERSION_PATH / "build_source" diff --git a/metadata/latest/context.json b/oemetadata/latest/context.json similarity index 100% rename from metadata/latest/context.json rename to oemetadata/latest/context.json diff --git a/metadata/v2/v20/example.json b/oemetadata/latest/example.json similarity index 99% rename from metadata/v2/v20/example.json rename to oemetadata/latest/example.json index 40e18eab..1042d0be 100644 --- a/metadata/v2/v20/example.json +++ b/oemetadata/latest/example.json @@ -1,5 +1,5 @@ { - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json", "name": "oep_oemetadata", "title": "OEP OEMetadata", "description": "A dataset for the OEMetadata examples.", @@ -111,7 +111,7 @@ "path": "https://opendatacommons.org/licenses/odbl/1-0/index.html", "instruction": "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information.", "attribution": "© Reiner Lemoine Institut", - "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" } ], "contributors": [ diff --git a/metadata/latest/example.py b/oemetadata/latest/example.py similarity index 100% rename from metadata/latest/example.py rename to oemetadata/latest/example.py diff --git a/metadata/v2/v20/metadata_key_description.md b/oemetadata/latest/metadata_key_description.md similarity index 98% rename from metadata/v2/v20/metadata_key_description.md rename to oemetadata/latest/metadata_key_description.md index 9f32c3d4..0d4ea8a7 100644 --- a/metadata/v2/v20/metadata_key_description.md +++ b/oemetadata/latest/metadata_key_description.md @@ -8,8 +8,8 @@ SPDX-License-Identifier: MIT # OEMetadata - Key Description This pages describes the key of **OEMetadata version 2.0 .**
-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.
-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.
+The [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the complete metadata schema. ## Introduction @@ -58,14 +58,14 @@ If a value is not yet available, use: `ToDo`. ## Overview ### Collection Keys -|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| -|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| -| 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] | -| 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] | -| 5 | id | A unique identifier (UUID/DOI) for the dataset. | [databus.openenergyplatform.org/oeplatform](https://databus.openenergyplatform.org/oeplatform/reference/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Silver | [0..1] | -| 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| +| 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] | +| 5 | id | A unique identifier (UUID/DOI) for the dataset. | [databus.openenergyplatform.org/oeplatform](https://databus.openenergyplatform.org/oeplatform/reference/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Silver | [0..1] | +| 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | ### Resource - General Keys |
#
|
Key
|
Description
|
Example |
Ontology Class
|
Badge
|
Card.
| @@ -231,14 +231,14 @@ If a value is not yet available, use: `ToDo`. ## Metadata Keys ### Collection: @context -| | | -|--------------------|-------------------------------------------------------------------------------------------------------------------------| -| **Key** | @context | -| **Description** | Explanation of metadata keys in ontology terms. | -| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json) | -| **Ontology Class** | | -| **Badge** | Platinum | -| **Card.** | [0..1] | +| | | +|--------------------|---------------------------------------------------------------------------------------------------------------------------| +| **Key** | @context | +| **Description** | Explanation of metadata keys in ontology terms. | +| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | +| **Ontology Class** | | +| **Badge** | Platinum | +| **Card.** | [0..1] | ### Collection: name diff --git a/metadata/latest/schema.json b/oemetadata/latest/schema.json similarity index 99% rename from metadata/latest/schema.json rename to oemetadata/latest/schema.json index 34b0bbb2..8e40b1d6 100644 --- a/metadata/latest/schema.json +++ b/oemetadata/latest/schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/schema.json", "description": "Open Energy Metadata (OEMetadata) - metadata schema", "type": "object", "required": [ @@ -10,7 +10,7 @@ "@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", @@ -924,7 +924,7 @@ "null" ], "examples": [ - "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" ], "badge": "Bronze", "title": "Copyright Statement" diff --git a/metadata/latest/schema.py b/oemetadata/latest/schema.py similarity index 100% rename from metadata/latest/schema.py rename to oemetadata/latest/schema.py diff --git a/metadata/latest/template.json b/oemetadata/latest/template.json similarity index 100% rename from metadata/latest/template.json rename to oemetadata/latest/template.json diff --git a/metadata/latest/template.py b/oemetadata/latest/template.py similarity index 100% rename from metadata/latest/template.py rename to oemetadata/latest/template.py diff --git a/metadata/v1/__init__.py b/oemetadata/v1/__init__.py similarity index 100% rename from metadata/v1/__init__.py rename to oemetadata/v1/__init__.py diff --git a/metadata/v1/v130/__init__.py b/oemetadata/v1/v130/__init__.py similarity index 100% rename from metadata/v1/v130/__init__.py rename to oemetadata/v1/v130/__init__.py diff --git a/metadata/v1/v130/example.json b/oemetadata/v1/v130/example.json similarity index 100% rename from metadata/v1/v130/example.json rename to oemetadata/v1/v130/example.json diff --git a/metadata/v1/v130/example.py b/oemetadata/v1/v130/example.py similarity index 100% rename from metadata/v1/v130/example.py rename to oemetadata/v1/v130/example.py diff --git a/metadata/v1/v130/schema.json b/oemetadata/v1/v130/schema.json similarity index 98% rename from metadata/v1/v130/schema.json rename to oemetadata/v1/v130/schema.json index 1537f615..4b9bbcfb 100644 --- a/metadata/v1/v130/schema.json +++ b/oemetadata/v1/v130/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v130/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v10/v130/schema.json", "description": "Contains general information", "type": "object", "properties": { @@ -197,7 +197,7 @@ "type": "object", "properties": { "_url": { - "description": "URL that refers to the description if this metadata standard. Example: https://github.com/OpenEnergyPlatform/metadata/blob/develop/metadata/v130/schema.json", + "description": "URL that refers to the description if this metadata standard. Example: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v130/schema.json", "type": "string" }, "_copyright": { diff --git a/metadata/v1/v130/schema.py b/oemetadata/v1/v130/schema.py similarity index 100% rename from metadata/v1/v130/schema.py rename to oemetadata/v1/v130/schema.py diff --git a/metadata/v1/v130/template.json b/oemetadata/v1/v130/template.json similarity index 98% rename from metadata/v1/v130/template.json rename to oemetadata/v1/v130/template.json index 066dc8a4..b28ba434 100644 --- a/metadata/v1/v130/template.json +++ b/oemetadata/v1/v130/template.json @@ -84,7 +84,7 @@ ], "metadata_version": "1.3", "_comment": { - "_url": "https://github.com/OpenEnergyPlatform/examples/tree/production/metadata", + "_url": "https://github.com/OpenEnergyPlatform/examples/tree/production/oemetadata", "_copyright": "© Reiner Lemoine Institut", "_metadata_license": "Creative Commons Zero v1.0 Universal (CC0-1.0)", "_metadata_license_url": "https://creativecommons.org/publicdomain/zero/1.0/", diff --git a/metadata/v1/v130/template.py b/oemetadata/v1/v130/template.py similarity index 100% rename from metadata/v1/v130/template.py rename to oemetadata/v1/v130/template.py diff --git a/metadata/v1/v140/__init__.py b/oemetadata/v1/v140/__init__.py similarity index 100% rename from metadata/v1/v140/__init__.py rename to oemetadata/v1/v140/__init__.py diff --git a/metadata/v1/v140/example.json b/oemetadata/v1/v140/example.json similarity index 99% rename from metadata/v1/v140/example.json rename to oemetadata/v1/v140/example.json index 0a123ecb..c1f56443 100644 --- a/metadata/v1/v140/example.json +++ b/oemetadata/v1/v140/example.json @@ -17,7 +17,7 @@ "publicationDate": "2018-06-12", "context": { "homepage": "https://reiner-lemoine-institut.de/szenariendb/", - "documentation": "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v140/metadata_key_description.md", + "documentation": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v140/metadata_key_description.md", "sourceCode": "https://github.com/OpenEnergyPlatform/oemetadata", "contact": "https://github.com/Ludee", "grantNo": "03ET4057", diff --git a/metadata/v1/v140/example.py b/oemetadata/v1/v140/example.py similarity index 100% rename from metadata/v1/v140/example.py rename to oemetadata/v1/v140/example.py diff --git a/metadata/v1/v140/metadata_key_description.md b/oemetadata/v1/v140/metadata_key_description.md similarity index 99% rename from metadata/v1/v140/metadata_key_description.md rename to oemetadata/v1/v140/metadata_key_description.md index 0e7315d0..03a2cb42 100644 --- a/metadata/v1/v140/metadata_key_description.md +++ b/oemetadata/v1/v140/metadata_key_description.md @@ -10,7 +10,7 @@ SPDX-License-Identifier: CC0-1.0 ## Open Energy Metadata Description -This pages describes the OEP Metadata version 1.4.0 You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v140/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v140/example.json) of a metadata string. +This pages describes the OEP Metadata version 1.4.0 You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v140/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v140/example.json) of a metadata string. ### Table with all Metadata keys and a short description diff --git a/metadata/v1/v140/schema.json b/oemetadata/v1/v140/schema.json similarity index 99% rename from metadata/v1/v140/schema.json rename to oemetadata/v1/v140/schema.json index 0a93c3b3..0e9266d9 100644 --- a/metadata/v1/v140/schema.json +++ b/oemetadata/v1/v140/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v140/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v140/schema.json", "description": "Open Energy Platform (OEP) metadata schema v1.4.0", "type": "object", "properties": { @@ -71,7 +71,7 @@ ] }, "documentation": { - "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/metadata/wiki/Metadata-Description", + "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/oemetadata/wiki/Metadata-Description", "type": [ "string", "null" @@ -611,7 +611,7 @@ "type": "object", "properties": { "metadata": { - "description": "Reference to the metadata documentation in use. Example: Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/latest/metadata_key_description.md)", + "description": "Reference to the metadata documentation in use. Example: Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/metadata_key_description.md)", "type": [ "string", "null" diff --git a/metadata/v1/v140/schema.py b/oemetadata/v1/v140/schema.py similarity index 100% rename from metadata/v1/v140/schema.py rename to oemetadata/v1/v140/schema.py diff --git a/metadata/v1/v140/template.json b/oemetadata/v1/v140/template.json similarity index 100% rename from metadata/v1/v140/template.json rename to oemetadata/v1/v140/template.json diff --git a/metadata/v1/v140/template.py b/oemetadata/v1/v140/template.py similarity index 100% rename from metadata/v1/v140/template.py rename to oemetadata/v1/v140/template.py diff --git a/metadata/v1/v141/__init__.py b/oemetadata/v1/v141/__init__.py similarity index 100% rename from metadata/v1/v141/__init__.py rename to oemetadata/v1/v141/__init__.py diff --git a/metadata/v1/v141/example.json b/oemetadata/v1/v141/example.json similarity index 99% rename from metadata/v1/v141/example.json rename to oemetadata/v1/v141/example.json index 8703aeb3..35cb72c6 100644 --- a/metadata/v1/v141/example.json +++ b/oemetadata/v1/v141/example.json @@ -17,7 +17,7 @@ "publicationDate": "2018-06-12", "context": { "homepage": "https://reiner-lemoine-institut.de/szenariendb/", - "documentation": "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/metadata/v141/metadata_key_description.md", + "documentation": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v141/metadata_key_description.md", "sourceCode": "https://github.com/OpenEnergyPlatform/oemetadata", "contact": "https://github.com/Ludee", "grantNo": "03ET4057", diff --git a/metadata/v1/v141/example.py b/oemetadata/v1/v141/example.py similarity index 100% rename from metadata/v1/v141/example.py rename to oemetadata/v1/v141/example.py diff --git a/metadata/v1/v141/metadata_key_description.md b/oemetadata/v1/v141/metadata_key_description.md similarity index 99% rename from metadata/v1/v141/metadata_key_description.md rename to oemetadata/v1/v141/metadata_key_description.md index 909a98de..e0133f64 100644 --- a/metadata/v1/v141/metadata_key_description.md +++ b/oemetadata/v1/v141/metadata_key_description.md @@ -10,7 +10,7 @@ SPDX-License-Identifier: CC0-1.0 ## Open Energy Metadata Description -This pages describes the OEP Metadata version 1.4.1 You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v140/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v140/example.json) of a metadata string. +This pages describes the OEP Metadata version 1.4.1 You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v140/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v140/example.json) of a metadata string. ### Table with all Metadata keys and a short description diff --git a/metadata/v1/v141/schema.json b/oemetadata/v1/v141/schema.json similarity index 99% rename from metadata/v1/v141/schema.json rename to oemetadata/v1/v141/schema.json index 9da6341a..2c50982a 100644 --- a/metadata/v1/v141/schema.json +++ b/oemetadata/v1/v141/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v141/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v141/schema.json", "description": "Open Energy Platform (OEP) metadata schema v1.4.1", "type": "object", "properties": { @@ -71,7 +71,7 @@ ] }, "documentation": { - "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/metadata/wiki/Metadata-Description", + "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/oemetadata/wiki/Metadata-Description", "type": [ "string", "null" diff --git a/metadata/v1/v141/schema.py b/oemetadata/v1/v141/schema.py similarity index 100% rename from metadata/v1/v141/schema.py rename to oemetadata/v1/v141/schema.py diff --git a/metadata/v1/v141/template.json b/oemetadata/v1/v141/template.json similarity index 100% rename from metadata/v1/v141/template.json rename to oemetadata/v1/v141/template.json diff --git a/metadata/v1/v141/template.py b/oemetadata/v1/v141/template.py similarity index 100% rename from metadata/v1/v141/template.py rename to oemetadata/v1/v141/template.py diff --git a/metadata/v1/v150/README.md b/oemetadata/v1/v150/README.md similarity index 79% rename from metadata/v1/v150/README.md rename to oemetadata/v1/v150/README.md index 818e63b3..d7dea743 100644 --- a/metadata/v1/v150/README.md +++ b/oemetadata/v1/v150/README.md @@ -13,12 +13,12 @@ SPDX-License-Identifier: MIT # Open Energy Metadata (OEMetadata)
- Version 1.5.0 (deprecated) This is OEMetadata version 1.5.0 . This release has been integrated in the OEP.
-The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/metadata/latest). +The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/oemetadata/latest). The OEMetadata contains the following files: -* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v150/template.json) contains an empty metadata string with all fields. -* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v150/metadata_key_description.md) contains a full description of each metadata key and an example. -* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v150/example.json) contains a basic metadata example. +* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v150/template.json) contains an empty metadata string with all fields. +* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v150/metadata_key_description.md) contains a full description of each metadata key and an example. +* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v150/example.json) contains a basic metadata example. For further information see the [Changelog](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CHANGELOG.md). diff --git a/metadata/v1/v150/__init__.py b/oemetadata/v1/v150/__init__.py similarity index 100% rename from metadata/v1/v150/__init__.py rename to oemetadata/v1/v150/__init__.py diff --git a/metadata/v1/v150/context.json b/oemetadata/v1/v150/context.json similarity index 100% rename from metadata/v1/v150/context.json rename to oemetadata/v1/v150/context.json diff --git a/metadata/v1/v150/example.json b/oemetadata/v1/v150/example.json similarity index 99% rename from metadata/v1/v150/example.json rename to oemetadata/v1/v150/example.json index b5645cde..1fbba8b9 100644 --- a/metadata/v1/v150/example.json +++ b/oemetadata/v1/v150/example.json @@ -277,7 +277,7 @@ } ], "@id": "https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00", - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v150/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v150/context.json", "review": { "path": "https://github.com/OpenEnergyPlatform/data-preprocessing/issues", "badge": "platinum" diff --git a/metadata/v1/v150/example.py b/oemetadata/v1/v150/example.py similarity index 100% rename from metadata/v1/v150/example.py rename to oemetadata/v1/v150/example.py diff --git a/metadata/v1/v150/metadata_key_description.md b/oemetadata/v1/v150/metadata_key_description.md similarity index 99% rename from metadata/v1/v150/metadata_key_description.md rename to oemetadata/v1/v150/metadata_key_description.md index 26db87aa..dcc95fba 100644 --- a/metadata/v1/v150/metadata_key_description.md +++ b/oemetadata/v1/v150/metadata_key_description.md @@ -10,7 +10,7 @@ SPDX-License-Identifier: CC0-1.0 ## Open Energy Metadata Description -This pages describes the OEP Metadata version 1.5.0. You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v150/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v150/example.json) of the metadata string. +This pages describes the OEP Metadata version 1.5.0. You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v150/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v150/example.json) of the metadata string. ### Table with all Metadata keys and a short description diff --git a/metadata/v1/v150/schema.json b/oemetadata/v1/v150/schema.json similarity index 99% rename from metadata/v1/v150/schema.json rename to oemetadata/v1/v150/schema.json index 867c51f2..a79ffcc6 100644 --- a/metadata/v1/v150/schema.json +++ b/oemetadata/v1/v150/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v150/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v150/schema.json", "description": "Open Energy Platform (OEP) metadata schema v1.5.0", "type": "object", "properties": { @@ -109,7 +109,7 @@ "format": "uri" }, "documentation": { - "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/metadata/wiki/Metadata-Description", + "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/oemetadata/wiki/Metadata-Description", "type": [ "string", "null" diff --git a/metadata/v1/v150/schema.py b/oemetadata/v1/v150/schema.py similarity index 100% rename from metadata/v1/v150/schema.py rename to oemetadata/v1/v150/schema.py diff --git a/metadata/v1/v150/template.json b/oemetadata/v1/v150/template.json similarity index 100% rename from metadata/v1/v150/template.json rename to oemetadata/v1/v150/template.json diff --git a/metadata/v1/v150/template.py b/oemetadata/v1/v150/template.py similarity index 100% rename from metadata/v1/v150/template.py rename to oemetadata/v1/v150/template.py diff --git a/metadata/v1/v151/README.md b/oemetadata/v1/v151/README.md similarity index 79% rename from metadata/v1/v151/README.md rename to oemetadata/v1/v151/README.md index 770f059d..8f953d6d 100644 --- a/metadata/v1/v151/README.md +++ b/oemetadata/v1/v151/README.md @@ -13,12 +13,12 @@ SPDX-License-Identifier: CC0-1.0 # Open Energy Metadata (OEMetadata)
- Version 1.5.1 (deprecated) This is OEMetadata version 1.5.1 . This release has been integrated in the OEP. -The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/metadata/latest). +The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/oemetadata/latest). The OEMetadata contains the following files: -* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v151/template.json) contains an empty metadata string with all fields. -* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v151/metadata_key_description.md) contains a full description of each metadata key and an example. -* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v151/example.json) contains a basic metadata example. +* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v151/template.json) contains an empty metadata string with all fields. +* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v151/metadata_key_description.md) contains a full description of each metadata key and an example. +* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v151/example.json) contains a basic metadata example. For further information see the [Changelog](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CHANGELOG.md). diff --git a/metadata/v1/v151/__init__.py b/oemetadata/v1/v151/__init__.py similarity index 100% rename from metadata/v1/v151/__init__.py rename to oemetadata/v1/v151/__init__.py diff --git a/metadata/v1/v151/context.json b/oemetadata/v1/v151/context.json similarity index 100% rename from metadata/v1/v151/context.json rename to oemetadata/v1/v151/context.json diff --git a/metadata/v1/v151/example.json b/oemetadata/v1/v151/example.json similarity index 99% rename from metadata/v1/v151/example.json rename to oemetadata/v1/v151/example.json index f1b81fa8..05c2b43b 100644 --- a/metadata/v1/v151/example.json +++ b/oemetadata/v1/v151/example.json @@ -373,7 +373,7 @@ } ], "@id": "https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00", - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v151/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v151/context.json", "review": { "path": "https://github.com/OpenEnergyPlatform/data-preprocessing/issues", "badge": "Platinum" diff --git a/metadata/v1/v151/example.py b/oemetadata/v1/v151/example.py similarity index 100% rename from metadata/v1/v151/example.py rename to oemetadata/v1/v151/example.py diff --git a/metadata/v1/v152/metadata_key_description.md b/oemetadata/v1/v151/metadata_key_description.md similarity index 94% rename from metadata/v1/v152/metadata_key_description.md rename to oemetadata/v1/v151/metadata_key_description.md index 273655fd..66da7317 100644 --- a/metadata/v1/v152/metadata_key_description.md +++ b/oemetadata/v1/v151/metadata_key_description.md @@ -2,14 +2,14 @@ SPDX-FileCopyrightText: 2022 Ludwig Hülk © Reiner Lemoine Institut SPDX-FileCopyrightText: 2022 Jonas Huber © Reiner Lemoine Institut SPDX-FileCopyrightText: 2022 Christian Hofmann © Reiner Lemoine Institut - +SPDX-FileCopyrightText: oemetadata SPDX-License-Identifier: CC0-1.0 --> # OEMetadata - Key Description -This pages describes the key of **OEMetadata version 1.5.2 .**
-You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v152/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v152/example.json) of the metadata string. +This pages describes the key of **OEMetadata version 1.5.1.**
+You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v151/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v151/example.json) of the metadata string. ## JSON Format @@ -50,7 +50,7 @@ The JSON format offers different formats: | 5 | language | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE, fr-FR | | 6 | **subject** | An array of objects with topics of the data in OEO terms. | | 6.1 | name | The class label of the OEO terms. | energy | -| 6.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | +| 6.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | | 7 | keywords | An array of keywords to assist users searching for the package in catalogs. | example, template, test | | 8 | publicationDate | A date of publishing of the data or metadata. Date format is ISO 8601 (YYYY-MM-DD). | 2019-02-06 | @@ -58,8 +58,8 @@ The JSON format offers different formats: | # | Key | Description | Example | |-----|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | 9 | **context** | An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. | | -| 9.1 | homepage | A URL of the project. | https://openenergyplatform.org/ | -| 9.2 | documentation | A URL of the project documentation. | https://openenergyplatform.org/about/ | +| 9.1 | homepage | A URL of the project. | https://openenergyplatform.org/ | +| 9.2 | documentation | A URL of the project documentation. | https://openenergyplatform.org/about/ | | 9.3 | sourceCode | A URL of the projects source code. | https://github.com/OpenEnergyPlatform | | 9.4 | contact | A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. | contact@example.com | | 9.5 | grantNo | An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. | 01AB2345 | @@ -118,30 +118,30 @@ The JSON format offers different formats: | 14.5 | comment | A free text commentary on what has been done. | Fixed a typo in the title. | ### Resource Keys -| # | Key | Description | Example | -|------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | -| 15.1 | profile | The profile of this descriptor according to the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. Use "tabular-data-resource" for all tables. | tabular-data-resource | -| 15.2 | name | A name for the entire data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database, this will be the name of the table within the schema containing it. The name usually corresponds to the file name (minus the file-extension) of the data file describing the resource. | openstreetmap.osm_deu_line | +| # | Key | Description | Example | +|------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | +| 15.1 | profile | The profile of this descriptor according to the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. Use "tabular-data-resource" for all tables. | tabular-data-resource | +| 15.2 | name | A name for the entire data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database, this will be the name of the table within the schema containing it. The name usually corresponds to the file name (minus the file-extension) of the data file describing the resource. | openstreetmap.osm_deu_line | | 15.3 | path | A URL that should be a permanent http(s) address or other path directly linking to the resource. | https://openenergyplatform.org/dataedit/view/openstreetmap/osm_deu_line | -| 15.4 | format | The file extension. 'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a database. | PostgreSQL | -| 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | +| 15.4 | format | The file extension. 'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a database. | PostgreSQL | +| 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | #### Resource Keys - Schema -| # | Key | Description | Example | -|------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| -| 15.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | -| 15.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | -| 15.6.1.1 | name | The name of the field. | year | -| 15.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | -| 15.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | -| 15.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a separate field, reference this field. | MW | -| 15.6.1.5 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | -| 15.6.1.5.1 | name | The class label of the OEO terms. | wind energy converting unit | +| # | Key | Description | Example | +|------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| 15.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | +| 15.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | +| 15.6.1.1 | name | The name of the field. | year | +| 15.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | +| 15.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | +| 15.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a separate field, reference this field. | MW | +| 15.6.1.5 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | +| 15.6.1.5.1 | name | The class label of the OEO terms. | wind energy converting unit | | 15.6.1.5.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000044 | -| 15.6.1.6 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | | -| 15.6.1.6.1 | value | The name of the value in the column. | onshore | -| 15.6.1.6.2 | name | The class label of the OEO terms. | onshore wind farm | +| 15.6.1.6 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | | +| 15.6.1.6.1 | value | The name of the value in the column. | onshore | +| 15.6.1.6.2 | name | The class label of the OEO terms. | onshore wind farm | | 15.6.1.6.3 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000311 | #### Resource Keys - Properties @@ -158,19 +158,19 @@ The JSON format offers different formats: | 15.7.2 | decimalSeparator | A symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be "." or ",". | . | ### Review Keys -| # | Key | Description | Example | -|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| -| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | -| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/context.json | -| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/production/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | -| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | -| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | +| # | Key | Description | Example | +|------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | +| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/context.json | +| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | +| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | +| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | ### MetaMetadata Keys | # | Key | Description | Example | |--------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| | 19 | **metaMetadata** | An object that describes the metadata themselves, their format, version and license. These fields should already be provided when you are filling out your metadata. | | -| 19.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.2 | +| 19.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.1 | | 19.2 | **metadataLicense** | The license of the provided metadata. | | | 19.2.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | CC0-1.0 | | 19.2.2 | title | The official (human readable) title of the license. | Creative Commons Zero v1.0 Universal | diff --git a/metadata/v1/v151/schema.json b/oemetadata/v1/v151/schema.json similarity index 99% rename from metadata/v1/v151/schema.json rename to oemetadata/v1/v151/schema.json index 2db59767..83246152 100644 --- a/metadata/v1/v151/schema.json +++ b/oemetadata/v1/v151/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v151/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v151/schema.json", "description": "Open Energy Platform (OEP) metadata schema v1.5.1", "type": "object", "properties": { @@ -130,7 +130,7 @@ "format": "uri" }, "documentation": { - "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/metadata/wiki/Metadata-Description", + "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/oemetadata/wiki/Metadata-Description", "type": [ "string", "null" diff --git a/metadata/v1/v151/schema.py b/oemetadata/v1/v151/schema.py similarity index 100% rename from metadata/v1/v151/schema.py rename to oemetadata/v1/v151/schema.py diff --git a/metadata/v1/v151/template.json b/oemetadata/v1/v151/template.json similarity index 98% rename from metadata/v1/v151/template.json rename to oemetadata/v1/v151/template.json index 511e20c6..51c6c59e 100644 --- a/metadata/v1/v151/template.json +++ b/oemetadata/v1/v151/template.json @@ -170,7 +170,7 @@ } ], "@id": null, - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/develop/metadata/latest/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json", "review": { "path": null, "badge": null diff --git a/metadata/v1/v151/template.py b/oemetadata/v1/v151/template.py similarity index 100% rename from metadata/v1/v151/template.py rename to oemetadata/v1/v151/template.py diff --git a/metadata/v1/v152/README.md b/oemetadata/v1/v152/README.md similarity index 79% rename from metadata/v1/v152/README.md rename to oemetadata/v1/v152/README.md index fb93b1ca..160935de 100644 --- a/metadata/v1/v152/README.md +++ b/oemetadata/v1/v152/README.md @@ -13,12 +13,12 @@ SPDX-License-Identifier: MIT # Open Energy Metadata (OEMetadata)
- Version 1.5.2 (deprecated) This is OEMetadata version 1.5.2 . This release has been integrated in the OEP. -The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/metadata/latest). +The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/oemetadata/latest). The OEMetadata contains the following files: -* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v152/template.json) contains an empty metadata string with all fields. -* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v152/metadata_key_description.md) contains a full description of each metadata key and an example. -* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v152/example.json) contains a basic metadata example. +* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v152/template.json) contains an empty metadata string with all fields. +* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v152/metadata_key_description.md) contains a full description of each metadata key and an example. +* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v152/example.json) contains a basic metadata example. For further information see the [Changelog](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CHANGELOG.md). diff --git a/metadata/v1/v152/__init__.py b/oemetadata/v1/v152/__init__.py similarity index 100% rename from metadata/v1/v152/__init__.py rename to oemetadata/v1/v152/__init__.py diff --git a/metadata/v1/v152/context.json b/oemetadata/v1/v152/context.json similarity index 100% rename from metadata/v1/v152/context.json rename to oemetadata/v1/v152/context.json diff --git a/metadata/v1/v152/example.json b/oemetadata/v1/v152/example.json similarity index 99% rename from metadata/v1/v152/example.json rename to oemetadata/v1/v152/example.json index 4b6e0ae3..2ead95dc 100644 --- a/metadata/v1/v152/example.json +++ b/oemetadata/v1/v152/example.json @@ -380,7 +380,7 @@ } ], "@id": "https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00", - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v152/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v152/context.json", "review": { "path": "https://github.com/OpenEnergyPlatform/data-preprocessing/issues", "badge": "Platinum" diff --git a/metadata/v1/v152/example.py b/oemetadata/v1/v152/example.py similarity index 100% rename from metadata/v1/v152/example.py rename to oemetadata/v1/v152/example.py diff --git a/metadata/v1/v151/metadata_key_description.md b/oemetadata/v1/v152/metadata_key_description.md similarity index 98% rename from metadata/v1/v151/metadata_key_description.md rename to oemetadata/v1/v152/metadata_key_description.md index 3ee730a1..cc3bca14 100644 --- a/metadata/v1/v151/metadata_key_description.md +++ b/oemetadata/v1/v152/metadata_key_description.md @@ -2,14 +2,14 @@ SPDX-FileCopyrightText: 2022 Ludwig Hülk © Reiner Lemoine Institut SPDX-FileCopyrightText: 2022 Jonas Huber © Reiner Lemoine Institut SPDX-FileCopyrightText: 2022 Christian Hofmann © Reiner Lemoine Institut -SPDX-FileCopyrightText: oemetadata + SPDX-License-Identifier: CC0-1.0 --> # OEMetadata - Key Description -This pages describes the key of **OEMetadata version 1.5.1.**
-You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v151/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v151/example.json) of the metadata string. +This pages describes the key of **OEMetadata version 1.5.2 .**
+You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v152/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v152/example.json) of the metadata string. ## JSON Format @@ -158,19 +158,19 @@ The JSON format offers different formats: | 15.7.2 | decimalSeparator | A symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be "." or ",". | . | ### Review Keys -| # | Key | Description | Example | -|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| -| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | -| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/context.json | -| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/production/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | -| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | -| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | +| # | Key | Description | Example | +|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | +| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/context.json | +| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/production/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | +| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | +| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | ### MetaMetadata Keys | # | Key | Description | Example | |--------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| | 19 | **metaMetadata** | An object that describes the metadata themselves, their format, version and license. These fields should already be provided when you are filling out your metadata. | | -| 19.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.1 | +| 19.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.2 | | 19.2 | **metadataLicense** | The license of the provided metadata. | | | 19.2.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | CC0-1.0 | | 19.2.2 | title | The official (human readable) title of the license. | Creative Commons Zero v1.0 Universal | diff --git a/metadata/v1/v152/schema.json b/oemetadata/v1/v152/schema.json similarity index 99% rename from metadata/v1/v152/schema.json rename to oemetadata/v1/v152/schema.json index ae1b73b4..c05e8248 100644 --- a/metadata/v1/v152/schema.json +++ b/oemetadata/v1/v152/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v152/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v152/schema.json", "description": "Open Energy Platform (OEP) metadata schema v1.5.2", "type": "object", "properties": { @@ -130,7 +130,7 @@ "format": "uri" }, "documentation": { - "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/metadata/wiki/Metadata-Description", + "description": "URL of project documentation. Example: https://github.com/OpenEnergyPlatform/oemetadata/wiki/Metadata-Description", "type": [ "string", "null" diff --git a/metadata/v1/v152/schema.py b/oemetadata/v1/v152/schema.py similarity index 100% rename from metadata/v1/v152/schema.py rename to oemetadata/v1/v152/schema.py diff --git a/metadata/v1/v152/template.json b/oemetadata/v1/v152/template.json similarity index 98% rename from metadata/v1/v152/template.json rename to oemetadata/v1/v152/template.json index 9cba54e7..01927ca5 100644 --- a/metadata/v1/v152/template.json +++ b/oemetadata/v1/v152/template.json @@ -170,7 +170,7 @@ } ], "@id": null, - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/develop/metadata/latest/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json", "review": { "path": null, "badge": null diff --git a/metadata/v1/v152/template.py b/oemetadata/v1/v152/template.py similarity index 100% rename from metadata/v1/v152/template.py rename to oemetadata/v1/v152/template.py diff --git a/metadata/v1/v160/README.md b/oemetadata/v1/v160/README.md similarity index 79% rename from metadata/v1/v160/README.md rename to oemetadata/v1/v160/README.md index aa0513f7..1ed30d80 100644 --- a/metadata/v1/v160/README.md +++ b/oemetadata/v1/v160/README.md @@ -13,12 +13,12 @@ SPDX-License-Identifier: MIT # Open Energy Metadata (OEMetadata)
- Version 1.6.0 (deprecated) This is OEMetadata version 1.6.0 . This release has been integrated in the OEP. -The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/metadata/latest). +The version has been updated and is marked as deprecated. See the [latest version](https://github.com/OpenEnergyPlatform/oemetadata/tree/production/oemetadata/latest). The OEMetadata contains the following files: -* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v160/template.json) contains an empty metadata string with all fields. -* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v160/metadata_key_description.md) contains a full description of each metadata key and an example. -* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/v10/v160/example.json) contains a basic metadata example. +* [template.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v160/template.json) contains an empty metadata string with all fields. +* [metadata_key_description.md](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v160/metadata_key_description.md) contains a full description of each metadata key and an example. +* [example.json](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v160/example.json) contains a basic metadata example. For further information see the [Changelog](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CHANGELOG.md). diff --git a/metadata/v1/v160/__init__.py b/oemetadata/v1/v160/__init__.py similarity index 100% rename from metadata/v1/v160/__init__.py rename to oemetadata/v1/v160/__init__.py diff --git a/metadata/v1/v160/context.json b/oemetadata/v1/v160/context.json similarity index 100% rename from metadata/v1/v160/context.json rename to oemetadata/v1/v160/context.json diff --git a/metadata/v1/v160/example.json b/oemetadata/v1/v160/example.json similarity index 99% rename from metadata/v1/v160/example.json rename to oemetadata/v1/v160/example.json index ffb75945..defdafb8 100644 --- a/metadata/v1/v160/example.json +++ b/oemetadata/v1/v160/example.json @@ -387,7 +387,7 @@ } ], "@id": "https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00", - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v160/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v160/context.json", "review": { "path": "https://github.com/OpenEnergyPlatform/data-preprocessing/issues", "badge": "Platinum" diff --git a/metadata/v1/v160/example.py b/oemetadata/v1/v160/example.py similarity index 100% rename from metadata/v1/v160/example.py rename to oemetadata/v1/v160/example.py diff --git a/metadata/v1/v160/metadata_key_description.md b/oemetadata/v1/v160/metadata_key_description.md similarity index 97% rename from metadata/v1/v160/metadata_key_description.md rename to oemetadata/v1/v160/metadata_key_description.md index 83cc1b31..18b59f9a 100644 --- a/metadata/v1/v160/metadata_key_description.md +++ b/oemetadata/v1/v160/metadata_key_description.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: CC0-1.0 # OEMetadata - Key Description This pages describes the key of **OEMetadata version 1.6.0 .**
-You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v160/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/metadata/blob/production/metadata/v160/example.json) of the metadata string. +You can have a look at an empty [template](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v160/template.json) and a filled out [example](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/v1/v160/example.json) of the metadata string. ## JSON Format @@ -50,7 +50,7 @@ The JSON format offers different formats: | 5 | language | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE, fr-FR | | 6 | **subject** | An array of objects with topics of the data in OEO terms. | | 6.1 | name | The class label of the OEO terms. | energy | -| 6.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | +| 6.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000150 | | 7 | keywords | An array of keywords to assist users searching for the package in catalogs. | example, template, test | | 8 | publicationDate | A date of publishing of the data or metadata. Date format is ISO 8601 (YYYY-MM-DD). | 2019-02-06 | @@ -58,8 +58,8 @@ The JSON format offers different formats: | # | Key | Description | Example | |-----|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | 9 | **context** | An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. | | -| 9.1 | homepage | A URL of the project. | https://openenergyplatform.org/ | -| 9.2 | documentation | A URL of the project documentation. | https://openenergyplatform.org/about/ | +| 9.1 | homepage | A URL of the project. | https://openenergyplatform.org/ | +| 9.2 | documentation | A URL of the project documentation. | https://openenergyplatform.org/about/ | | 9.3 | sourceCode | A URL of the projects source code. | https://github.com/OpenEnergyPlatform | | 9.4 | contact | A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. | contact@example.com | | 9.5 | grantNo | An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. | 01AB2345 | @@ -118,30 +118,30 @@ The JSON format offers different formats: | 14.5 | comment | A free text commentary on what has been done. | Fixed a typo in the title. | ### Resource Keys -| # | Key | Description | Example | -|------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | -| 15.1 | profile | The profile of this descriptor according to the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. Use "tabular-data-resource" for all tables. | tabular-data-resource | -| 15.2 | name | A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the schema on the OEP, use "." to separate schema from table name. | openstreetmap.osm_deu_line | +| # | Key | Description | Example | +|------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | +| 15.1 | profile | The profile of this descriptor according to the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. Use "tabular-data-resource" for all tables. | tabular-data-resource | +| 15.2 | name | A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the schema on the OEP, use "." to separate schema from table name. | openstreetmap.osm_deu_line | | 15.3 | path | A URL that should be a permanent http(s) address or other path directly linking to the resource. | https://openenergyplatform.org/dataedit/view/openstreetmap/osm_deu_line | -| 15.4 | format | The file extension. 'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a database. | PostgreSQL | -| 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | +| 15.4 | format | The file extension. 'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a database. | PostgreSQL | +| 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | #### Resource Keys - Schema -| # | Key | Description | Example | -|------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| -| 15.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | -| 15.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | -| 15.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year | -| 15.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | -| 15.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | -| 15.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a separate field, reference this field. | MW | -| 15.6.1.5 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | -| 15.6.1.5.1 | name | The class label of the OEO terms. | wind energy converting unit | +| # | Key | Description | Example | +|------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| 15.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | +| 15.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | +| 15.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year | +| 15.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | +| 15.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | +| 15.6.1.4 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a separate field, reference this field. | MW | +| 15.6.1.5 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | +| 15.6.1.5.1 | name | The class label of the OEO terms. | wind energy converting unit | | 15.6.1.5.2 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000044 | -| 15.6.1.6 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | | -| 15.6.1.6.1 | value | The name of the value in the column. | onshore | -| 15.6.1.6.2 | name | The class label of the OEO terms. | onshore wind farm | +| 15.6.1.6 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergyplatform.org/ontology/oeo/) terms. | | +| 15.6.1.6.1 | value | The name of the value in the column. | onshore | +| 15.6.1.6.2 | name | The class label of the OEO terms. | onshore wind farm | | 15.6.1.6.3 | path | The URI of the class. | https://openenergyplatform.org/ontology/oeo/OEO_00000311 | #### Resource Keys - Properties @@ -158,13 +158,13 @@ The JSON format offers different formats: | 15.7.2 | decimalSeparator | A symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be "." or ",". | . | ### Review Keys -| # | Key | Description | Example | -|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| -| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | -| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/context.json | -| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/production/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | -| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | -| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | +| # | Key | Description | Example | +|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 16 | @id | A Uniform Resource Identifier (URI) that links the resource via the [DBedia Databus](https://www.dbpedia.org/resources/databus/). | https://databus.dbpedia.org/kurzum/mastr/bnetza-mastr/01.04.00 | +| 17 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/context.json | +| 18. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/production/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | +| 18.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | +| 18.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | ### MetaMetadata Keys | # | Key | Description | Example | diff --git a/metadata/v1/v160/schema.json b/oemetadata/v1/v160/schema.json similarity index 99% rename from metadata/v1/v160/schema.json rename to oemetadata/v1/v160/schema.json index 99614954..549be7f3 100644 --- a/metadata/v1/v160/schema.json +++ b/oemetadata/v1/v160/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v160/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v160/schema.json", "description": "Open Energy Platform (OEP) metadata schema latest", "type": "object", "properties": { diff --git a/metadata/v1/v160/schema.py b/oemetadata/v1/v160/schema.py similarity index 100% rename from metadata/v1/v160/schema.py rename to oemetadata/v1/v160/schema.py diff --git a/metadata/v1/v160/template.json b/oemetadata/v1/v160/template.json similarity index 98% rename from metadata/v1/v160/template.json rename to oemetadata/v1/v160/template.json index 7dfe6a64..36cbb6ff 100644 --- a/metadata/v1/v160/template.json +++ b/oemetadata/v1/v160/template.json @@ -170,7 +170,7 @@ } ], "@id": null, - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/develop/metadata/latest/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json", "review": { "path": null, "badge": null diff --git a/metadata/v1/v160/template.py b/oemetadata/v1/v160/template.py similarity index 100% rename from metadata/v1/v160/template.py rename to oemetadata/v1/v160/template.py diff --git a/metadata/v2/__init__.py b/oemetadata/v2/__init__.py similarity index 100% rename from metadata/v2/__init__.py rename to oemetadata/v2/__init__.py diff --git a/metadata/latest/README.md b/oemetadata/v2/v20/README.md similarity index 68% rename from metadata/latest/README.md rename to oemetadata/v2/v20/README.md index eff5b9f2..8ac9c2bd 100644 --- a/metadata/latest/README.md +++ b/oemetadata/v2/v20/README.md @@ -1,7 +1,7 @@ @@ -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). diff --git a/metadata/v2/v20/__init__.py b/oemetadata/v2/v20/__init__.py similarity index 100% rename from metadata/v2/v20/__init__.py rename to oemetadata/v2/v20/__init__.py diff --git a/metadata/v2/v20/build_source/README.md b/oemetadata/v2/v20/build_source/README.md similarity index 100% rename from metadata/v2/v20/build_source/README.md rename to oemetadata/v2/v20/build_source/README.md diff --git a/metadata/latest/build_source/schema_structure.json b/oemetadata/v2/v20/build_source/schema_structure.json similarity index 96% rename from metadata/latest/build_source/schema_structure.json rename to oemetadata/v2/v20/build_source/schema_structure.json index 1f33c076..2e726b59 100644 --- a/metadata/latest/build_source/schema_structure.json +++ b/oemetadata/v2/v20/build_source/schema_structure.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/schema.json", "description": "Open Energy Metadata (OEMetadata) - metadata schema", "type": "object", "required": [ diff --git a/metadata/v2/v20/build_source/schema_structure.json.license b/oemetadata/v2/v20/build_source/schema_structure.json.license similarity index 100% rename from metadata/v2/v20/build_source/schema_structure.json.license rename to oemetadata/v2/v20/build_source/schema_structure.json.license diff --git a/metadata/v2/v20/build_source/schemas/context.json b/oemetadata/v2/v20/build_source/schemas/context.json similarity index 98% rename from metadata/v2/v20/build_source/schemas/context.json rename to oemetadata/v2/v20/build_source/schemas/context.json index 5349a92d..ac5c3f8a 100644 --- a/metadata/v2/v20/build_source/schemas/context.json +++ b/oemetadata/v2/v20/build_source/schemas/context.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/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": { diff --git a/metadata/v2/v20/build_source/schemas/dataset.json b/oemetadata/v2/v20/build_source/schemas/dataset.json similarity index 92% rename from metadata/v2/v20/build_source/schemas/dataset.json rename to oemetadata/v2/v20/build_source/schemas/dataset.json index 7fb4c1c7..f6ac8faa 100644 --- a/metadata/v2/v20/build_source/schemas/dataset.json +++ b/oemetadata/v2/v20/build_source/schemas/dataset.json @@ -1,12 +1,12 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/collection.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/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", diff --git a/metadata/v2/v20/build_source/schemas/fields.json b/oemetadata/v2/v20/build_source/schemas/fields.json similarity index 99% rename from metadata/v2/v20/build_source/schemas/fields.json rename to oemetadata/v2/v20/build_source/schemas/fields.json index 7fcb6ea8..f98354fb 100644 --- a/metadata/v2/v20/build_source/schemas/fields.json +++ b/oemetadata/v2/v20/build_source/schemas/fields.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/fields.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/fields.json", "type": "object", "properties": { "type": { diff --git a/metadata/latest/build_source/schemas/general.json b/oemetadata/v2/v20/build_source/schemas/general.json similarity index 98% rename from metadata/latest/build_source/schemas/general.json rename to oemetadata/v2/v20/build_source/schemas/general.json index 7c22a68b..ef97ca6c 100644 --- a/metadata/latest/build_source/schemas/general.json +++ b/oemetadata/v2/v20/build_source/schemas/general.json @@ -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/general.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/general.json", "type": "object", "properties": { "@id": { diff --git a/metadata/latest/build_source/schemas/licenses.json b/oemetadata/v2/v20/build_source/schemas/licenses.json similarity index 96% rename from metadata/latest/build_source/schemas/licenses.json rename to oemetadata/v2/v20/build_source/schemas/licenses.json index e03d4757..b366cf97 100644 --- a/metadata/latest/build_source/schemas/licenses.json +++ b/oemetadata/v2/v20/build_source/schemas/licenses.json @@ -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/licenses.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/licenses.json", "type": "object", "properties": { "licenses": { @@ -77,7 +77,7 @@ "null" ], "examples": [ - "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" ], "badge": "Bronze", "title": "Copyright Statement" diff --git a/metadata/v2/v20/build_source/schemas/meta.json b/oemetadata/v2/v20/build_source/schemas/meta.json similarity index 96% rename from metadata/v2/v20/build_source/schemas/meta.json rename to oemetadata/v2/v20/build_source/schemas/meta.json index 6fb21050..94cd5870 100644 --- a/metadata/v2/v20/build_source/schemas/meta.json +++ b/oemetadata/v2/v20/build_source/schemas/meta.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/meta.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/meta.json", "type": "object", "properties": { "metaMetadata": { diff --git a/metadata/v2/v20/build_source/schemas/provenance.json b/oemetadata/v2/v20/build_source/schemas/provenance.json similarity index 97% rename from metadata/v2/v20/build_source/schemas/provenance.json rename to oemetadata/v2/v20/build_source/schemas/provenance.json index 3c309597..d821c722 100644 --- a/metadata/v2/v20/build_source/schemas/provenance.json +++ b/oemetadata/v2/v20/build_source/schemas/provenance.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/provenance.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/provenance.json", "type": "object", "properties": { "contributors": { diff --git a/metadata/v2/v20/build_source/schemas/review.json b/oemetadata/v2/v20/build_source/schemas/review.json similarity index 94% rename from metadata/v2/v20/build_source/schemas/review.json rename to oemetadata/v2/v20/build_source/schemas/review.json index 2745a33d..474902fa 100644 --- a/metadata/v2/v20/build_source/schemas/review.json +++ b/oemetadata/v2/v20/build_source/schemas/review.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/review.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/review.json", "type": "object", "properties": { "review": { diff --git a/metadata/latest/build_source/schemas/sources.json b/oemetadata/v2/v20/build_source/schemas/sources.json similarity index 98% rename from metadata/latest/build_source/schemas/sources.json rename to oemetadata/v2/v20/build_source/schemas/sources.json index 73524939..7374d52c 100644 --- a/metadata/latest/build_source/schemas/sources.json +++ b/oemetadata/v2/v20/build_source/schemas/sources.json @@ -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/sources.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/sources.json", "type": "object", "properties": { "sources": { diff --git a/metadata/v2/v20/build_source/schemas/spatial.json b/oemetadata/v2/v20/build_source/schemas/spatial.json similarity index 98% rename from metadata/v2/v20/build_source/schemas/spatial.json rename to oemetadata/v2/v20/build_source/schemas/spatial.json index bfd10e63..bccce1d4 100644 --- a/metadata/v2/v20/build_source/schemas/spatial.json +++ b/oemetadata/v2/v20/build_source/schemas/spatial.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/spatial.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/spatial.json", "type": "object", "properties": { "spatial": { diff --git a/metadata/v2/v20/build_source/schemas/temporal.json b/oemetadata/v2/v20/build_source/schemas/temporal.json similarity index 98% rename from metadata/v2/v20/build_source/schemas/temporal.json rename to oemetadata/v2/v20/build_source/schemas/temporal.json index 8966d0b1..840f4efc 100644 --- a/metadata/v2/v20/build_source/schemas/temporal.json +++ b/oemetadata/v2/v20/build_source/schemas/temporal.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/build_source/schemas/temporal.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/build_source/schemas/temporal.json", "type": "object", "properties": { "temporal": { diff --git a/metadata/v2/v20/build_source/scripts/__init__.py b/oemetadata/v2/v20/build_source/scripts/__init__.py similarity index 100% rename from metadata/v2/v20/build_source/scripts/__init__.py rename to oemetadata/v2/v20/build_source/scripts/__init__.py diff --git a/metadata/v2/v20/build_source/scripts/create_example.py b/oemetadata/v2/v20/build_source/scripts/create_example.py similarity index 95% rename from metadata/v2/v20/build_source/scripts/create_example.py rename to oemetadata/v2/v20/build_source/scripts/create_example.py index e8f9f98c..591911eb 100644 --- a/metadata/v2/v20/build_source/scripts/create_example.py +++ b/oemetadata/v2/v20/build_source/scripts/create_example.py @@ -181,13 +181,15 @@ def extract_examples_from_schema( elif schema_type == "string": return "" # Example string elif schema_type == "number": - return 0 # Example number + return "0" # Example number elif schema_type == "boolean": - return True # Example boolean + return "true" # Example boolean elif schema_type == "null": return None # Example null - return None # Default fallback + # Unsupported schema + else: + raise ValueError(f"Unsupported schema_type: {schema_type}") def create_json_from_schema(schema_file: str) -> Dict[str, Any]: @@ -201,8 +203,13 @@ def create_json_from_schema(schema_file: str) -> Dict[str, Any]: """ schema = read_metadata_schema(schema_file) print(f"Create JSON from schema: {schema_file}") - return extract_examples_from_schema(schema) - print(f"Create JSON object: {result}") + result = extract_examples_from_schema(schema) + + # Ensure the result is a dictionary + if isinstance(result, dict): + return result + else: + return {} # Return an empty dictionary as a fallback def save_json(data: Dict[str, Any], filename: Path) -> None: @@ -221,7 +228,7 @@ def save_json(data: Dict[str, Any], filename: Path) -> None: def test_oemetadata_schema_should_validate_oemetadata_example(example): from jsonschema import ValidationError, validate - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA try: validate(example, OEMETADATA_V20_SCHEMA) diff --git a/metadata/v2/v20/build_source/scripts/create_schema.py b/oemetadata/v2/v20/build_source/scripts/create_schema.py similarity index 100% rename from metadata/v2/v20/build_source/scripts/create_schema.py rename to oemetadata/v2/v20/build_source/scripts/create_schema.py diff --git a/metadata/v2/v20/build_source/scripts/create_template.py b/oemetadata/v2/v20/build_source/scripts/create_template.py similarity index 97% rename from metadata/v2/v20/build_source/scripts/create_template.py rename to oemetadata/v2/v20/build_source/scripts/create_template.py index 8a9ae7a3..89107fdb 100644 --- a/metadata/v2/v20/build_source/scripts/create_template.py +++ b/oemetadata/v2/v20/build_source/scripts/create_template.py @@ -98,8 +98,8 @@ def main(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA - from metadata.v2.v20.template import OEMETADATA_V20_TEMPLATE + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.template import OEMETADATA_V20_TEMPLATE try: validate(OEMETADATA_V20_TEMPLATE, OEMETADATA_V20_SCHEMA) diff --git a/metadata/v2/v20/build_source/scripts/example/contributors.json b/oemetadata/v2/v20/build_source/scripts/example/contributors.json similarity index 100% rename from metadata/v2/v20/build_source/scripts/example/contributors.json rename to oemetadata/v2/v20/build_source/scripts/example/contributors.json diff --git a/metadata/v2/v20/build_source/scripts/example/contributors.json.license b/oemetadata/v2/v20/build_source/scripts/example/contributors.json.license similarity index 100% rename from metadata/v2/v20/build_source/scripts/example/contributors.json.license rename to oemetadata/v2/v20/build_source/scripts/example/contributors.json.license diff --git a/metadata/v2/v20/build_source/scripts/example/fields.json b/oemetadata/v2/v20/build_source/scripts/example/fields.json similarity index 100% rename from metadata/v2/v20/build_source/scripts/example/fields.json rename to oemetadata/v2/v20/build_source/scripts/example/fields.json diff --git a/metadata/v2/v20/build_source/scripts/example/fields.json.license b/oemetadata/v2/v20/build_source/scripts/example/fields.json.license similarity index 100% rename from metadata/v2/v20/build_source/scripts/example/fields.json.license rename to oemetadata/v2/v20/build_source/scripts/example/fields.json.license diff --git a/metadata/v2/v20/build_source/scripts/settings.py b/oemetadata/v2/v20/build_source/scripts/settings.py similarity index 96% rename from metadata/v2/v20/build_source/scripts/settings.py rename to oemetadata/v2/v20/build_source/scripts/settings.py index 2c5a6d1d..2da1cad4 100644 --- a/metadata/v2/v20/build_source/scripts/settings.py +++ b/oemetadata/v2/v20/build_source/scripts/settings.py @@ -8,7 +8,7 @@ LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s" -BASE_PATH = Path("metadata/v2/") +BASE_PATH = Path("oemetadata/v2/") VERSION = "v20" VERSION_PATH = BASE_PATH / VERSION SCHEMA_BUILD_PATH = VERSION_PATH / "build_source" diff --git a/metadata/v2/v20/context.json b/oemetadata/v2/v20/context.json similarity index 100% rename from metadata/v2/v20/context.json rename to oemetadata/v2/v20/context.json diff --git a/metadata/latest/example.json b/oemetadata/v2/v20/example.json similarity index 99% rename from metadata/latest/example.json rename to oemetadata/v2/v20/example.json index 40e18eab..1042d0be 100644 --- a/metadata/latest/example.json +++ b/oemetadata/v2/v20/example.json @@ -1,5 +1,5 @@ { - "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json", + "@context": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json", "name": "oep_oemetadata", "title": "OEP OEMetadata", "description": "A dataset for the OEMetadata examples.", @@ -111,7 +111,7 @@ "path": "https://opendatacommons.org/licenses/odbl/1-0/index.html", "instruction": "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information.", "attribution": "© Reiner Lemoine Institut", - "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "copyrightStatement": "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" } ], "contributors": [ diff --git a/metadata/v2/v20/example.py b/oemetadata/v2/v20/example.py similarity index 100% rename from metadata/v2/v20/example.py rename to oemetadata/v2/v20/example.py diff --git a/metadata/latest/metadata_key_description.md b/oemetadata/v2/v20/metadata_key_description.md similarity index 98% rename from metadata/latest/metadata_key_description.md rename to oemetadata/v2/v20/metadata_key_description.md index c414684a..0d4ea8a7 100644 --- a/metadata/latest/metadata_key_description.md +++ b/oemetadata/v2/v20/metadata_key_description.md @@ -1,15 +1,15 @@ # OEMetadata - Key Description This pages describes the key of **OEMetadata version 2.0 .**
-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.
-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.
+The [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/oemetadata/latest/schema.json) contains the complete metadata schema. ## Introduction @@ -58,14 +58,14 @@ If a value is not yet available, use: `ToDo`. ## Overview ### Collection Keys -|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| -|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| -| 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] | -| 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] | -| 5 | id | A unique identifier (UUID/DOI) for the dataset. | [databus.openenergyplatform.org/oeplatform](https://databus.openenergyplatform.org/oeplatform/reference/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Silver | [0..1] | -| 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| +| 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] | +| 5 | id | A unique identifier (UUID/DOI) for the dataset. | [databus.openenergyplatform.org/oeplatform](https://databus.openenergyplatform.org/oeplatform/reference/) | [dct:identifier](http://purl.org/dc/terms/identifier) | Silver | [0..1] | +| 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | ### Resource - General Keys |
#
|
Key
|
Description
|
Example |
Ontology Class
|
Badge
|
Card.
| @@ -231,14 +231,14 @@ If a value is not yet available, use: `ToDo`. ## Metadata Keys ### Collection: @context -| | | -|--------------------|-------------------------------------------------------------------------------------------------------------------------| -| **Key** | @context | -| **Description** | Explanation of metadata keys in ontology terms. | -| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json) | -| **Ontology Class** | | -| **Badge** | Platinum | -| **Card.** | [0..1] | +| | | +|--------------------|---------------------------------------------------------------------------------------------------------------------------| +| **Key** | @context | +| **Description** | Explanation of metadata keys in ontology terms. | +| **Example** | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | +| **Ontology Class** | | +| **Badge** | Platinum | +| **Card.** | [0..1] | ### Collection: name diff --git a/metadata/v2/v20/schema.json b/oemetadata/v2/v20/schema.json similarity index 99% rename from metadata/v2/v20/schema.json rename to oemetadata/v2/v20/schema.json index 938197ed..8e40b1d6 100644 --- a/metadata/v2/v20/schema.json +++ b/oemetadata/v2/v20/schema.json @@ -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/v2/v20/schema.json", "description": "Open Energy Metadata (OEMetadata) - metadata schema", "type": "object", "required": [ @@ -10,7 +10,7 @@ "@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", @@ -924,7 +924,7 @@ "null" ], "examples": [ - "https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt" + "https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt" ], "badge": "Bronze", "title": "Copyright Statement" diff --git a/metadata/v2/v20/schema.py b/oemetadata/v2/v20/schema.py similarity index 100% rename from metadata/v2/v20/schema.py rename to oemetadata/v2/v20/schema.py diff --git a/metadata/v2/v20/template.json b/oemetadata/v2/v20/template.json similarity index 100% rename from metadata/v2/v20/template.json rename to oemetadata/v2/v20/template.json diff --git a/metadata/v2/v20/template.py b/oemetadata/v2/v20/template.py similarity index 100% rename from metadata/v2/v20/template.py rename to oemetadata/v2/v20/template.py diff --git a/test/metadata/__init__.py b/test/oemetadata/__init__.py similarity index 100% rename from test/metadata/__init__.py rename to test/oemetadata/__init__.py diff --git a/test/metadata/json_schema/__init__.py b/test/oemetadata/json_schema/__init__.py similarity index 100% rename from test/metadata/json_schema/__init__.py rename to test/oemetadata/json_schema/__init__.py diff --git a/test/metadata/json_schema/draft07/__init__.py b/test/oemetadata/json_schema/draft07/__init__.py similarity index 100% rename from test/metadata/json_schema/draft07/__init__.py rename to test/oemetadata/json_schema/draft07/__init__.py diff --git a/test/metadata/json_schema/draft07/test_jsonschema.py b/test/oemetadata/json_schema/draft07/test_jsonschema.py similarity index 88% rename from test/metadata/json_schema/draft07/test_jsonschema.py rename to test/oemetadata/json_schema/draft07/test_jsonschema.py index 68aa483a..1ab38da6 100644 --- a/test/metadata/json_schema/draft07/test_jsonschema.py +++ b/test/oemetadata/json_schema/draft07/test_jsonschema.py @@ -12,7 +12,9 @@ def test_jsonschema_should_load(): def test_jsonschema_should_have_correct_path(): - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) assert ( OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA["$schema"] diff --git a/test/metadata/json_schema/draft2020_12/__init__.py b/test/oemetadata/json_schema/draft2020_12/__init__.py similarity index 100% rename from test/metadata/json_schema/draft2020_12/__init__.py rename to test/oemetadata/json_schema/draft2020_12/__init__.py diff --git a/test/metadata/json_schema/draft2020_12/test_jsonschema.py b/test/oemetadata/json_schema/draft2020_12/test_jsonschema.py similarity index 92% rename from test/metadata/json_schema/draft2020_12/test_jsonschema.py rename to test/oemetadata/json_schema/draft2020_12/test_jsonschema.py index a65bce9a..9946144e 100644 --- a/test/metadata/json_schema/draft2020_12/test_jsonschema.py +++ b/test/oemetadata/json_schema/draft2020_12/test_jsonschema.py @@ -12,7 +12,7 @@ def test_jsonschema_should_load(): def test_jsonschema_should_have_correct_path(): - from metadata.json_schema.draft2020_12.schema import ( + from oemetadata.json_schema.draft2020_12.schema import ( OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA, ) @@ -30,7 +30,7 @@ def test_jsonschema_should_have_correct_path(): def test_jsonschema_should_have_correct_path_string(): import string - from metadata.json_schema.draft2020_12.schema import ( + from oemetadata.json_schema.draft2020_12.schema import ( OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA, ) diff --git a/test/metadata/latest/__init__.py b/test/oemetadata/latest/__init__.py similarity index 100% rename from test/metadata/latest/__init__.py rename to test/oemetadata/latest/__init__.py diff --git a/test/metadata/latest/test_context.py b/test/oemetadata/latest/test_context.py similarity index 98% rename from test/metadata/latest/test_context.py rename to test/oemetadata/latest/test_context.py index eb7a7e1c..71befc2d 100644 --- a/test/metadata/latest/test_context.py +++ b/test/oemetadata/latest/test_context.py @@ -12,7 +12,7 @@ @pytest.fixture def load_files(): """Load the example.json and context.json files.""" - base_path = "metadata/latest/" + base_path = "oemetadata/latest/" example_file = os.path.join(base_path, "example.json") context_file = os.path.join(base_path, "context.json") diff --git a/test/metadata/latest/test_example.py b/test/oemetadata/latest/test_example.py similarity index 85% rename from test/metadata/latest/test_example.py rename to test/oemetadata/latest/test_example.py index 59d51293..a7b035a9 100644 --- a/test/metadata/latest/test_example.py +++ b/test/oemetadata/latest/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE - from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.example import OEMETADATA_LATEST_EXAMPLE + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA try: validate(OEMETADATA_LATEST_EXAMPLE, OEMETADATA_LATEST_SCHEMA) diff --git a/test/metadata/latest/test_schema.py b/test/oemetadata/latest/test_schema.py similarity index 85% rename from test/metadata/latest/test_schema.py rename to test/oemetadata/latest/test_schema.py index 624eace3..d852c2ed 100644 --- a/test/metadata/latest/test_schema.py +++ b/test/oemetadata/latest/test_schema.py @@ -14,10 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft2020_12.schema import ( + from oemetadata.json_schema.draft2020_12.schema import ( OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA, ) - from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA try: validate(OEMETADATA_LATEST_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA) @@ -29,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -39,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (Latest)!" assert get_string(OEMETADATA_LATEST_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/schema.json" ), "Wrong id path in OEMetadata Schema (Latest)!" diff --git a/test/metadata/latest/test_template.py b/test/oemetadata/latest/test_template.py similarity index 85% rename from test/metadata/latest/test_template.py rename to test/oemetadata/latest/test_template.py index 36bdf9ec..fc8894c7 100644 --- a/test/metadata/latest/test_template.py +++ b/test/oemetadata/latest/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA - from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE + from oemetadata.latest.schema import OEMETADATA_LATEST_SCHEMA + from oemetadata.latest.template import OEMETADATA_LATEST_TEMPLATE try: validate(OEMETADATA_LATEST_TEMPLATE, OEMETADATA_LATEST_SCHEMA) diff --git a/test/metadata/v1/__init__.py b/test/oemetadata/v1/__init__.py similarity index 100% rename from test/metadata/v1/__init__.py rename to test/oemetadata/v1/__init__.py diff --git a/test/metadata/v1/v130/__init__.py b/test/oemetadata/v1/v130/__init__.py similarity index 100% rename from test/metadata/v1/v130/__init__.py rename to test/oemetadata/v1/v130/__init__.py diff --git a/test/metadata/v1/v130/test_example.py b/test/oemetadata/v1/v130/test_example.py similarity index 86% rename from test/metadata/v1/v130/test_example.py rename to test/oemetadata/v1/v130/test_example.py index afac956a..f02fb3da 100644 --- a/test/metadata/v1/v130/test_example.py +++ b/test/oemetadata/v1/v130/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v130.example import OEMETADATA_V130_EXAMPLE - from metadata.v1.v130.schema import OEMETADATA_V130_SCHEMA + from oemetadata.v1.v130.example import OEMETADATA_V130_EXAMPLE + from oemetadata.v1.v130.schema import OEMETADATA_V130_SCHEMA try: validate(OEMETADATA_V130_EXAMPLE, OEMETADATA_V130_SCHEMA) diff --git a/test/metadata/v1/v130/test_schema.py b/test/oemetadata/v1/v130/test_schema.py similarity index 82% rename from test/metadata/v1/v130/test_schema.py rename to test/oemetadata/v1/v130/test_schema.py index 90033718..f19d888b 100644 --- a/test/metadata/v1/v130/test_schema.py +++ b/test/oemetadata/v1/v130/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v130.schema import OEMETADATA_V130_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v130.schema import OEMETADATA_V130_SCHEMA try: validate(OEMETADATA_V130_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v130.schema import OEMETADATA_V130_SCHEMA + from oemetadata.v1.v130.schema import OEMETADATA_V130_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.3.0)!" assert get_string(OEMETADATA_V130_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v130/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v130/schema.json" ), "Wrong id path in OEMetadata Schema (v1.3.0)!" diff --git a/test/metadata/v1/v130/test_template.py b/test/oemetadata/v1/v130/test_template.py similarity index 85% rename from test/metadata/v1/v130/test_template.py rename to test/oemetadata/v1/v130/test_template.py index cb5cea5b..da05b866 100644 --- a/test/metadata/v1/v130/test_template.py +++ b/test/oemetadata/v1/v130/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v130.schema import OEMETADATA_V130_SCHEMA - from metadata.v1.v130.template import OEMETADATA_V130_TEMPLATE + from oemetadata.v1.v130.schema import OEMETADATA_V130_SCHEMA + from oemetadata.v1.v130.template import OEMETADATA_V130_TEMPLATE try: validate(OEMETADATA_V130_TEMPLATE, OEMETADATA_V130_SCHEMA) diff --git a/test/metadata/v1/v140/__init__.py b/test/oemetadata/v1/v140/__init__.py similarity index 100% rename from test/metadata/v1/v140/__init__.py rename to test/oemetadata/v1/v140/__init__.py diff --git a/test/metadata/v1/v140/test_example.py b/test/oemetadata/v1/v140/test_example.py similarity index 86% rename from test/metadata/v1/v140/test_example.py rename to test/oemetadata/v1/v140/test_example.py index cb52999d..0b827158 100644 --- a/test/metadata/v1/v140/test_example.py +++ b/test/oemetadata/v1/v140/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v140.example import OEMETADATA_V140_EXAMPLE - from metadata.v1.v140.schema import OEMETADATA_V140_SCHEMA + from oemetadata.v1.v140.example import OEMETADATA_V140_EXAMPLE + from oemetadata.v1.v140.schema import OEMETADATA_V140_SCHEMA try: validate(OEMETADATA_V140_EXAMPLE, OEMETADATA_V140_SCHEMA) diff --git a/test/metadata/v1/v140/test_schema.py b/test/oemetadata/v1/v140/test_schema.py similarity index 82% rename from test/metadata/v1/v140/test_schema.py rename to test/oemetadata/v1/v140/test_schema.py index 4c05b8d9..2aff746b 100644 --- a/test/metadata/v1/v140/test_schema.py +++ b/test/oemetadata/v1/v140/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v140.schema import OEMETADATA_V140_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v140.schema import OEMETADATA_V140_SCHEMA try: validate(OEMETADATA_V140_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v140.schema import OEMETADATA_V140_SCHEMA + from oemetadata.v1.v140.schema import OEMETADATA_V140_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.4.0)!" assert get_string(OEMETADATA_V140_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v140/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v140/schema.json" ), "Wrong id path in OEMetadata Schema (v1.4.0)!" diff --git a/test/metadata/v1/v140/test_template.py b/test/oemetadata/v1/v140/test_template.py similarity index 85% rename from test/metadata/v1/v140/test_template.py rename to test/oemetadata/v1/v140/test_template.py index d0b5ec4c..5adf962c 100644 --- a/test/metadata/v1/v140/test_template.py +++ b/test/oemetadata/v1/v140/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v140.schema import OEMETADATA_V140_SCHEMA - from metadata.v1.v140.template import OEMETADATA_V140_TEMPLATE + from oemetadata.v1.v140.schema import OEMETADATA_V140_SCHEMA + from oemetadata.v1.v140.template import OEMETADATA_V140_TEMPLATE try: validate(OEMETADATA_V140_TEMPLATE, OEMETADATA_V140_SCHEMA) diff --git a/test/metadata/v1/v141/__init__.py b/test/oemetadata/v1/v141/__init__.py similarity index 100% rename from test/metadata/v1/v141/__init__.py rename to test/oemetadata/v1/v141/__init__.py diff --git a/test/metadata/v1/v141/test_example.py b/test/oemetadata/v1/v141/test_example.py similarity index 86% rename from test/metadata/v1/v141/test_example.py rename to test/oemetadata/v1/v141/test_example.py index f1fb4d11..93a9cd11 100644 --- a/test/metadata/v1/v141/test_example.py +++ b/test/oemetadata/v1/v141/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v141.example import OEMETADATA_V141_EXAMPLE - from metadata.v1.v141.schema import OEMETADATA_V141_SCHEMA + from oemetadata.v1.v141.example import OEMETADATA_V141_EXAMPLE + from oemetadata.v1.v141.schema import OEMETADATA_V141_SCHEMA try: validate(OEMETADATA_V141_EXAMPLE, OEMETADATA_V141_SCHEMA) diff --git a/test/metadata/v1/v141/test_schema.py b/test/oemetadata/v1/v141/test_schema.py similarity index 82% rename from test/metadata/v1/v141/test_schema.py rename to test/oemetadata/v1/v141/test_schema.py index f65d0739..5209eb2f 100644 --- a/test/metadata/v1/v141/test_schema.py +++ b/test/oemetadata/v1/v141/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v141.schema import OEMETADATA_V141_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v141.schema import OEMETADATA_V141_SCHEMA try: validate(OEMETADATA_V141_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v141.schema import OEMETADATA_V141_SCHEMA + from oemetadata.v1.v141.schema import OEMETADATA_V141_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.4.1)!" assert get_string(OEMETADATA_V141_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v141/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v141/schema.json" ), "Wrong id path in OEMetadata Schema (v1.4.1)!" diff --git a/test/metadata/v1/v141/test_template.py b/test/oemetadata/v1/v141/test_template.py similarity index 85% rename from test/metadata/v1/v141/test_template.py rename to test/oemetadata/v1/v141/test_template.py index 6cb0ff9f..4a8a398c 100644 --- a/test/metadata/v1/v141/test_template.py +++ b/test/oemetadata/v1/v141/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v141.schema import OEMETADATA_V141_SCHEMA - from metadata.v1.v141.template import OEMETADATA_V141_TEMPLATE + from oemetadata.v1.v141.schema import OEMETADATA_V141_SCHEMA + from oemetadata.v1.v141.template import OEMETADATA_V141_TEMPLATE try: validate(OEMETADATA_V141_TEMPLATE, OEMETADATA_V141_SCHEMA) diff --git a/test/metadata/v1/v150/__init__.py b/test/oemetadata/v1/v150/__init__.py similarity index 100% rename from test/metadata/v1/v150/__init__.py rename to test/oemetadata/v1/v150/__init__.py diff --git a/test/metadata/v1/v150/test_example.py b/test/oemetadata/v1/v150/test_example.py similarity index 86% rename from test/metadata/v1/v150/test_example.py rename to test/oemetadata/v1/v150/test_example.py index 389dfc60..723e8598 100644 --- a/test/metadata/v1/v150/test_example.py +++ b/test/oemetadata/v1/v150/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v150.example import OEMETADATA_V150_EXAMPLE - from metadata.v1.v150.schema import OEMETADATA_V150_SCHEMA + from oemetadata.v1.v150.example import OEMETADATA_V150_EXAMPLE + from oemetadata.v1.v150.schema import OEMETADATA_V150_SCHEMA try: validate(OEMETADATA_V150_EXAMPLE, OEMETADATA_V150_SCHEMA) diff --git a/test/metadata/v1/v150/test_schema.py b/test/oemetadata/v1/v150/test_schema.py similarity index 82% rename from test/metadata/v1/v150/test_schema.py rename to test/oemetadata/v1/v150/test_schema.py index 1964e3fe..3fdc288b 100644 --- a/test/metadata/v1/v150/test_schema.py +++ b/test/oemetadata/v1/v150/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v150.schema import OEMETADATA_V150_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v150.schema import OEMETADATA_V150_SCHEMA try: validate(OEMETADATA_V150_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v150.schema import OEMETADATA_V150_SCHEMA + from oemetadata.v1.v150.schema import OEMETADATA_V150_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.5.0)!" assert get_string(OEMETADATA_V150_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v150/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v150/schema.json" ), "Wrong id path in OEMetadata Schema (v1.5.0)!" diff --git a/test/metadata/v1/v150/test_template.py b/test/oemetadata/v1/v150/test_template.py similarity index 85% rename from test/metadata/v1/v150/test_template.py rename to test/oemetadata/v1/v150/test_template.py index 25bb3a55..5eabbd15 100644 --- a/test/metadata/v1/v150/test_template.py +++ b/test/oemetadata/v1/v150/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v150.schema import OEMETADATA_V150_SCHEMA - from metadata.v1.v150.template import OEMETADATA_V150_TEMPLATE + from oemetadata.v1.v150.schema import OEMETADATA_V150_SCHEMA + from oemetadata.v1.v150.template import OEMETADATA_V150_TEMPLATE try: validate(OEMETADATA_V150_TEMPLATE, OEMETADATA_V150_SCHEMA) diff --git a/test/metadata/v1/v151/__init__.py b/test/oemetadata/v1/v151/__init__.py similarity index 100% rename from test/metadata/v1/v151/__init__.py rename to test/oemetadata/v1/v151/__init__.py diff --git a/test/metadata/v1/v151/test_example.py b/test/oemetadata/v1/v151/test_example.py similarity index 86% rename from test/metadata/v1/v151/test_example.py rename to test/oemetadata/v1/v151/test_example.py index 8f2574fa..84db0160 100644 --- a/test/metadata/v1/v151/test_example.py +++ b/test/oemetadata/v1/v151/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v151.example import OEMETADATA_V151_EXAMPLE - from metadata.v1.v151.schema import OEMETADATA_V151_SCHEMA + from oemetadata.v1.v151.example import OEMETADATA_V151_EXAMPLE + from oemetadata.v1.v151.schema import OEMETADATA_V151_SCHEMA try: validate(OEMETADATA_V151_EXAMPLE, OEMETADATA_V151_SCHEMA) diff --git a/test/metadata/v1/v151/test_schema.py b/test/oemetadata/v1/v151/test_schema.py similarity index 82% rename from test/metadata/v1/v151/test_schema.py rename to test/oemetadata/v1/v151/test_schema.py index 1936d20f..5af480f2 100644 --- a/test/metadata/v1/v151/test_schema.py +++ b/test/oemetadata/v1/v151/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v151.schema import OEMETADATA_V151_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v151.schema import OEMETADATA_V151_SCHEMA try: validate(OEMETADATA_V151_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v151.schema import OEMETADATA_V151_SCHEMA + from oemetadata.v1.v151.schema import OEMETADATA_V151_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.5.1)!" assert get_string(OEMETADATA_V151_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v151/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v151/schema.json" ), "Wrong id path in OEMetadata Schema (v1.5.1)!" diff --git a/test/metadata/v1/v151/test_template.py b/test/oemetadata/v1/v151/test_template.py similarity index 85% rename from test/metadata/v1/v151/test_template.py rename to test/oemetadata/v1/v151/test_template.py index cb05154a..ff11d741 100644 --- a/test/metadata/v1/v151/test_template.py +++ b/test/oemetadata/v1/v151/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v151.schema import OEMETADATA_V151_SCHEMA - from metadata.v1.v151.template import OEMETADATA_V151_TEMPLATE + from oemetadata.v1.v151.schema import OEMETADATA_V151_SCHEMA + from oemetadata.v1.v151.template import OEMETADATA_V151_TEMPLATE try: validate(OEMETADATA_V151_TEMPLATE, OEMETADATA_V151_SCHEMA) diff --git a/test/metadata/v1/v152/__init__.py b/test/oemetadata/v1/v152/__init__.py similarity index 100% rename from test/metadata/v1/v152/__init__.py rename to test/oemetadata/v1/v152/__init__.py diff --git a/test/metadata/v1/v152/test_example.py b/test/oemetadata/v1/v152/test_example.py similarity index 86% rename from test/metadata/v1/v152/test_example.py rename to test/oemetadata/v1/v152/test_example.py index 64d5f90a..6235257d 100644 --- a/test/metadata/v1/v152/test_example.py +++ b/test/oemetadata/v1/v152/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v152.example import OEMETADATA_V152_EXAMPLE - from metadata.v1.v152.schema import OEMETADATA_V152_SCHEMA + from oemetadata.v1.v152.example import OEMETADATA_V152_EXAMPLE + from oemetadata.v1.v152.schema import OEMETADATA_V152_SCHEMA try: validate(OEMETADATA_V152_EXAMPLE, OEMETADATA_V152_SCHEMA) diff --git a/test/metadata/v1/v152/test_schema.py b/test/oemetadata/v1/v152/test_schema.py similarity index 82% rename from test/metadata/v1/v152/test_schema.py rename to test/oemetadata/v1/v152/test_schema.py index 287915e9..cce654f1 100644 --- a/test/metadata/v1/v152/test_schema.py +++ b/test/oemetadata/v1/v152/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v152.schema import OEMETADATA_V152_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v152.schema import OEMETADATA_V152_SCHEMA try: validate(OEMETADATA_V152_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v152.schema import OEMETADATA_V152_SCHEMA + from oemetadata.v1.v152.schema import OEMETADATA_V152_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.5.2)!" assert get_string(OEMETADATA_V152_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v152/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v152/schema.json" ), "Wrong id path in OEMetadata Schema (v1.5.2)!" diff --git a/test/metadata/v1/v152/test_template.py b/test/oemetadata/v1/v152/test_template.py similarity index 85% rename from test/metadata/v1/v152/test_template.py rename to test/oemetadata/v1/v152/test_template.py index bf9011b8..32284ea1 100644 --- a/test/metadata/v1/v152/test_template.py +++ b/test/oemetadata/v1/v152/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v152.schema import OEMETADATA_V152_SCHEMA - from metadata.v1.v152.template import OEMETADATA_V152_TEMPLATE + from oemetadata.v1.v152.schema import OEMETADATA_V152_SCHEMA + from oemetadata.v1.v152.template import OEMETADATA_V152_TEMPLATE try: validate(OEMETADATA_V152_TEMPLATE, OEMETADATA_V152_SCHEMA) diff --git a/test/metadata/v1/v160/__init__.py b/test/oemetadata/v1/v160/__init__.py similarity index 100% rename from test/metadata/v1/v160/__init__.py rename to test/oemetadata/v1/v160/__init__.py diff --git a/test/metadata/v1/v160/test_example.py b/test/oemetadata/v1/v160/test_example.py similarity index 86% rename from test/metadata/v1/v160/test_example.py rename to test/oemetadata/v1/v160/test_example.py index f5eebc3e..ef6bdfba 100644 --- a/test/metadata/v1/v160/test_example.py +++ b/test/oemetadata/v1/v160/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v1.v160.example import OEMETADATA_V160_EXAMPLE - from metadata.v1.v160.schema import OEMETADATA_V160_SCHEMA + from oemetadata.v1.v160.example import OEMETADATA_V160_EXAMPLE + from oemetadata.v1.v160.schema import OEMETADATA_V160_SCHEMA try: validate(OEMETADATA_V160_EXAMPLE, OEMETADATA_V160_SCHEMA) diff --git a/test/metadata/v1/v160/test_schema.py b/test/oemetadata/v1/v160/test_schema.py similarity index 82% rename from test/metadata/v1/v160/test_schema.py rename to test/oemetadata/v1/v160/test_schema.py index e6d7c150..305b96fa 100644 --- a/test/metadata/v1/v160/test_schema.py +++ b/test/oemetadata/v1/v160/test_schema.py @@ -14,8 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft07.schema import OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA - from metadata.v1.v160.schema import OEMETADATA_V160_SCHEMA + from oemetadata.json_schema.draft07.schema import ( + OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA, + ) + from oemetadata.v1.v160.schema import OEMETADATA_V160_SCHEMA try: validate(OEMETADATA_V160_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT07_SCHEMA) @@ -27,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v1.v160.schema import OEMETADATA_V160_SCHEMA + from oemetadata.v1.v160.schema import OEMETADATA_V160_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -37,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v1.6.0)!" assert get_string(OEMETADATA_V160_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v10/v160/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v160/schema.json" ), "Wrong id path in OEMetadata Schema (v1.6.0)!" diff --git a/test/metadata/v1/v160/test_template.py b/test/oemetadata/v1/v160/test_template.py similarity index 85% rename from test/metadata/v1/v160/test_template.py rename to test/oemetadata/v1/v160/test_template.py index 81e11445..0e04101e 100644 --- a/test/metadata/v1/v160/test_template.py +++ b/test/oemetadata/v1/v160/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v1.v160.schema import OEMETADATA_V160_SCHEMA - from metadata.v1.v160.template import OEMETADATA_V160_TEMPLATE + from oemetadata.v1.v160.schema import OEMETADATA_V160_SCHEMA + from oemetadata.v1.v160.template import OEMETADATA_V160_TEMPLATE try: validate(OEMETADATA_V160_TEMPLATE, OEMETADATA_V160_SCHEMA) diff --git a/test/metadata/v2/__init__.py b/test/oemetadata/v2/__init__.py similarity index 100% rename from test/metadata/v2/__init__.py rename to test/oemetadata/v2/__init__.py diff --git a/test/metadata/v2/v20/__init__.py b/test/oemetadata/v2/v20/__init__.py similarity index 100% rename from test/metadata/v2/v20/__init__.py rename to test/oemetadata/v2/v20/__init__.py diff --git a/test/metadata/v2/v20/test_context.py b/test/oemetadata/v2/v20/test_context.py similarity index 98% rename from test/metadata/v2/v20/test_context.py rename to test/oemetadata/v2/v20/test_context.py index d08eb552..7fd64153 100644 --- a/test/metadata/v2/v20/test_context.py +++ b/test/oemetadata/v2/v20/test_context.py @@ -12,7 +12,7 @@ @pytest.fixture def load_files(): """Load the example.json and context.json files.""" - base_path = "metadata/v2/v20/" + base_path = "oemetadata/v2/v20/" example_file = os.path.join(base_path, "example.json") context_file = os.path.join(base_path, "context.json") diff --git a/test/metadata/v2/v20/test_example.py b/test/oemetadata/v2/v20/test_example.py similarity index 86% rename from test/metadata/v2/v20/test_example.py rename to test/oemetadata/v2/v20/test_example.py index 713e8179..419f508e 100644 --- a/test/metadata/v2/v20/test_example.py +++ b/test/oemetadata/v2/v20/test_example.py @@ -14,8 +14,8 @@ def test_oemetadata_example_should_load(): def test_oemetadata_schema_should_validate_oemetadata_example(): from jsonschema import ValidationError, validate - from metadata.v2.v20.example import OEMETADATA_V20_EXAMPLE - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.example import OEMETADATA_V20_EXAMPLE + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA try: validate(OEMETADATA_V20_EXAMPLE, OEMETADATA_V20_SCHEMA) diff --git a/test/metadata/v2/v20/test_schema.py b/test/oemetadata/v2/v20/test_schema.py similarity index 85% rename from test/metadata/v2/v20/test_schema.py rename to test/oemetadata/v2/v20/test_schema.py index 127b25b1..134a7816 100644 --- a/test/metadata/v2/v20/test_schema.py +++ b/test/oemetadata/v2/v20/test_schema.py @@ -14,10 +14,10 @@ def test_oemetadata_schema_should_load(): def test_jsonschema_should_validate_oemetadata_schema(): from jsonschema import ValidationError, validate - from metadata.json_schema.draft2020_12.schema import ( + from oemetadata.json_schema.draft2020_12.schema import ( OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA, ) - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA try: validate(OEMETADATA_V20_SCHEMA, OEMETADATA_JSONSCHEMA_DRAFT202012_SCHEMA) @@ -29,7 +29,7 @@ def test_jsonschema_should_validate_oemetadata_schema(): def test_oemetadata_schema_should_have_correct_path(): import string - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA def get_string(s): return string.printable + s + string.printable @@ -39,5 +39,5 @@ def get_string(s): ), "Wrong schema path in OEMetadata Schema (v2.0)!" assert get_string(OEMETADATA_V20_SCHEMA["$id"]) == get_string( - "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/v2/v20/schema.json" + "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v20/schema.json" ), "Wrong id path in OEMetadata Schema (v2.0)!" diff --git a/test/metadata/v2/v20/test_template.py b/test/oemetadata/v2/v20/test_template.py similarity index 86% rename from test/metadata/v2/v20/test_template.py rename to test/oemetadata/v2/v20/test_template.py index 8034d8e4..154f438c 100644 --- a/test/metadata/v2/v20/test_template.py +++ b/test/oemetadata/v2/v20/test_template.py @@ -14,8 +14,8 @@ def test_oemetadata_template_should_load(): def test_oemetadata_schema_should_validate_oemetadata_template(): from jsonschema import ValidationError, validate - from metadata.v2.v20.schema import OEMETADATA_V20_SCHEMA - from metadata.v2.v20.template import OEMETADATA_V20_TEMPLATE + from oemetadata.v2.v20.schema import OEMETADATA_V20_SCHEMA + from oemetadata.v2.v20.template import OEMETADATA_V20_TEMPLATE try: validate(OEMETADATA_V20_TEMPLATE, OEMETADATA_V20_SCHEMA) From 16955d40cb201dc86071a52e3d7e8c53cd374b9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Mon, 17 Feb 2025 12:30:10 +0100 Subject: [PATCH 2/5] Update changelog #251 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 80acba6b..17b7ba74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) From 5e533d440e0fc45c1bd9e02f82a652f55a043515 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Mon, 17 Feb 2025 13:25:20 +0100 Subject: [PATCH 3/5] Update schema path #151 --- oemetadata/v1/v130/schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/oemetadata/v1/v130/schema.json b/oemetadata/v1/v130/schema.json index 4b9bbcfb..f0ed9752 100644 --- a/oemetadata/v1/v130/schema.json +++ b/oemetadata/v1/v130/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v10/v130/schema.json", + "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v1/v130/schema.json", "description": "Contains general information", "type": "object", "properties": { From 09b29895b95e7e710f0e2c381bfe71869ea8a429 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Mon, 17 Feb 2025 14:22:15 +0100 Subject: [PATCH 4/5] Adapt latest folder and run scripts #151 --- oemetadata/latest/build_source/scripts/settings.py | 4 ++-- oemetadata/latest/schema.json | 10 +++++----- oemetadata/v2/v20/schema.json | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/oemetadata/latest/build_source/scripts/settings.py b/oemetadata/latest/build_source/scripts/settings.py index 2da1cad4..6ac91611 100644 --- a/oemetadata/latest/build_source/scripts/settings.py +++ b/oemetadata/latest/build_source/scripts/settings.py @@ -8,8 +8,8 @@ LOG_FORMAT = "%(asctime)s - %(name)s - %(levelname)s - %(message)s" -BASE_PATH = Path("oemetadata/v2/") -VERSION = "v20" +BASE_PATH = Path("oemetadata/") +VERSION = "latest" VERSION_PATH = BASE_PATH / VERSION SCHEMA_BUILD_PATH = VERSION_PATH / "build_source" MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json" diff --git a/oemetadata/latest/schema.json b/oemetadata/latest/schema.json index 8e40b1d6..fe7e6a14 100644 --- a/oemetadata/latest/schema.json +++ b/oemetadata/latest/schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/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": [ @@ -120,7 +120,7 @@ "title": "Topics" }, "title": { - "description": "A human readable table name.", + "description": "A human readable resource or table name.", "type": [ "string", "null" @@ -575,11 +575,11 @@ "title": "Spatial" }, "temporal": { - "description": "An object with the time period covered in the data. Temporal information should contain either a \"referenceDate\" or the keys that describe a time series, in rare cases both.", + "description": "An object with the time period covered in the data. Temporal information should contain a \"referenceDate\" or the keys that describe a time series, or both.", "type": "object", "properties": { "referenceDate": { - "description": "A base year, month or day. The time for which the data is should be accurate. Date Format is ISO 8601.", + "description": "A base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601.", "type": [ "string", "null" @@ -998,7 +998,7 @@ "title": "Roles" }, "date": { - "description": "The date of the final contribution. Date Format is ISO 8601.", + "description": "The date of the contribution. Date Format is ISO 8601.", "type": [ "string", "null" diff --git a/oemetadata/v2/v20/schema.json b/oemetadata/v2/v20/schema.json index 8e40b1d6..6dd37afb 100644 --- a/oemetadata/v2/v20/schema.json +++ b/oemetadata/v2/v20/schema.json @@ -120,7 +120,7 @@ "title": "Topics" }, "title": { - "description": "A human readable table name.", + "description": "A human readable resource or table name.", "type": [ "string", "null" @@ -575,11 +575,11 @@ "title": "Spatial" }, "temporal": { - "description": "An object with the time period covered in the data. Temporal information should contain either a \"referenceDate\" or the keys that describe a time series, in rare cases both.", + "description": "An object with the time period covered in the data. Temporal information should contain a \"referenceDate\" or the keys that describe a time series, or both.", "type": "object", "properties": { "referenceDate": { - "description": "A base year, month or day. The time for which the data is should be accurate. Date Format is ISO 8601.", + "description": "A base year, month or day. The time for which the data should be accurate. Date Format is ISO 8601.", "type": [ "string", "null" @@ -998,7 +998,7 @@ "title": "Roles" }, "date": { - "description": "The date of the final contribution. Date Format is ISO 8601.", + "description": "The date of the contribution. Date Format is ISO 8601.", "type": [ "string", "null" From 591bba1b60aef7258e2748ac6c3f93831c70a46d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Mon, 17 Feb 2025 15:04:11 +0100 Subject: [PATCH 5/5] Update changelog #151 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17b7ba74..f98519f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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)