OpenEnergyPlatform / oemetadata

Repository for the Open Energy Family metadata. Contains metadata templates, examples and schemas. For metadata conversion see https://github.com/OpenEnergyPlatform/omi
https://openenergyplatform.github.io/oemetadata/
MIT License
22 stars 2 forks source link

[GitHubActions or travis ci] Add test that validates oem as datapackage compatible #49

Open jh-RLI opened 3 years ago

jh-RLI commented 3 years ago

I think it would be good if a datapackage validation is added as CI rule to the repository. The OpenEnergyMetadata repo is practically the datapackage.json and therefore should be always compatible to datapackage. This guide explains how to get started with frictionless datapackage.

Also add datapackage dependency to requirements.

jh-RLI commented 3 years ago

FYI @henhuy

henhuy commented 3 years ago

I'm actually implementing this in modex repo as possbility to upload datapackages to the OEP. Still in progress. Will share link once it's working...

jh-RLI commented 3 years ago

the validation is already successfully used when uploading with the oedatamodel_api to the OEP. We could adopt the functionality to validate the oemeta data automatically in the first step. (By extending the CI pipeline travis/gthub actions).

From the findings with the oedatamodel_api, the schema must first be adapted so that all fields of the oemetadata strign can be successfully validated. Currently only the fields of the resources are tested. This also means that the oemetadata string is not conform with the frictionless datapackage format respectively with the required datapackage.json file.

jh-RLI commented 4 weeks ago

Can be done using omi version 1 (is about to be released today)