[](https://github.com/OpenEnergyPlatform/oemetadata/actions/workflows/metadata-test.yml)
<a href="https://github.com/OpenEnergyPlatform/oemetadata/"><img align="right" width="100" height="100" src="https://raw.githubusercontent.com/OpenEnergyPlatform/organisation/master/logo/OpenEnergyFamily_Logo_OEMetadata.png" alt="OpenEnergyMetadata"></a>
<a href="https://openenergy-platform.org/"><img align="right" width="100" height="100" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>
# Open Energy Family - Open Energy Metadata (OEMetadata)
Open Energy Metadata (OEMetadata) is an energy metadata standard including a template, examples and a metadata schema.
It is an extensive set of metadata based on the tabular data package specifications and the FAIR principles.
The metadata contains multiple fields (keys) in a nested JSON structure.
You can find the latest version right here:
* [template.json](./metadata/latest/template.json) contains an empty metadata string
* [metadata_key_description.md](./metadata/latest/metadata_key_description.md) contains a description of each metadata key
* [example.json](./metadata/latest/example.json) contains a basic metadata example
## License / Copyright
This repository is licensed under [MIT License (MIT)](https://spdx.org/licenses/MIT.html) <br>
The oemetadata is licensed under [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) <br>
The oemetadata example and oemetadata template are licensed under [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/)
## Installation
`pip install oemetadata`
## Usage Examples
```
from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE
print(OEMETADATA_LATEST_EXAMPLE)
```
```
from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA
print(OEMETADATA_LATEST_SCHEMA)
```
```
from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE
print(OEMETADATA_LATEST_TEMPLATE)
```
## Contributing
For further contributing infos and conventions see: [CONTRIBUTING.md](./CONTRIBUTING.md)
## Release a new version
See the complete instructions in the [RELEASE_PROCEDURE](./RELEASE_PROCEDURE.md).
### Make PyPI release:
First bump version in setup.py, then:
```
python3 setup.py sdist bdist_wheel
twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenEnergyPlatform/oemetadata",
"name": "oemetadata",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "JSON metadata schema open energy platform oep",
"author": "Alexis Michaltsis",
"author_email": "oep_dev@lists.riseup.net",
"download_url": "https://files.pythonhosted.org/packages/66/6e/54ae734bd51e8cf7f40099460dcd4baee88c597aa574c4457418c1491e81/oemetadata-1.6.0.tar.gz",
"platform": null,
"description": "[](https://github.com/OpenEnergyPlatform/oemetadata/actions/workflows/metadata-test.yml)\n\n<a href=\"https://github.com/OpenEnergyPlatform/oemetadata/\"><img align=\"right\" width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/OpenEnergyPlatform/organisation/master/logo/OpenEnergyFamily_Logo_OEMetadata.png\" alt=\"OpenEnergyMetadata\"></a>\n<a href=\"https://openenergy-platform.org/\"><img align=\"right\" width=\"100\" height=\"100\" src=\"https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4\" alt=\"OpenEnergyPlatform\"></a>\n\n# Open Energy Family - Open Energy Metadata (OEMetadata)\n\nOpen Energy Metadata (OEMetadata) is an energy metadata standard including a template, examples and a metadata schema.\nIt is an extensive set of metadata based on the tabular data package specifications and the FAIR principles.\nThe metadata contains multiple fields (keys) in a nested JSON structure.\n\nYou can find the latest version right here:\n* [template.json](./metadata/latest/template.json) contains an empty metadata string\n* [metadata_key_description.md](./metadata/latest/metadata_key_description.md) contains a description of each metadata key\n* [example.json](./metadata/latest/example.json) contains a basic metadata example\n\n\n## License / Copyright\n\nThis repository is licensed under [MIT License (MIT)](https://spdx.org/licenses/MIT.html) <br>\nThe oemetadata is licensed under [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) <br>\nThe oemetadata example and oemetadata template are licensed under [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/)\n\n## Installation\n\n`pip install oemetadata`\n\n## Usage Examples\n\n```\nfrom metadata.latest.example import OEMETADATA_LATEST_EXAMPLE\n\nprint(OEMETADATA_LATEST_EXAMPLE)\n```\n\n```\nfrom metadata.latest.schema import OEMETADATA_LATEST_SCHEMA\n\nprint(OEMETADATA_LATEST_SCHEMA)\n```\n\n```\nfrom metadata.latest.template import OEMETADATA_LATEST_TEMPLATE\n\nprint(OEMETADATA_LATEST_TEMPLATE)\n```\n\n## Contributing\n\nFor further contributing infos and conventions see: [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n## Release a new version\nSee the complete instructions in the [RELEASE_PROCEDURE](./RELEASE_PROCEDURE.md).\n\n### Make PyPI release:\n\nFirst bump version in setup.py, then:\n\n```\npython3 setup.py sdist bdist_wheel\ntwine upload dist/*\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Open Energy Platform (OEP) - metadata schemas, examples and templates package",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://github.com/OpenEnergyPlatform/oemetadata"
},
"split_keywords": [
"json",
"metadata",
"schema",
"open",
"energy",
"platform",
"oep"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8007c48ead76821529bf5ed8d4ec7f450cf10e7631dc58002441ee97fc2ab4b7",
"md5": "4df2d09179b9af115f34c6c16cf11328",
"sha256": "61103a7333ed2a3482a4228fd13d74b0f08f5240e7d48a70c26e8a1901061ece"
},
"downloads": -1,
"filename": "oemetadata-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4df2d09179b9af115f34c6c16cf11328",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 119767,
"upload_time": "2023-05-30T14:11:39",
"upload_time_iso_8601": "2023-05-30T14:11:39.677045Z",
"url": "https://files.pythonhosted.org/packages/80/07/c48ead76821529bf5ed8d4ec7f450cf10e7631dc58002441ee97fc2ab4b7/oemetadata-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "666e54ae734bd51e8cf7f40099460dcd4baee88c597aa574c4457418c1491e81",
"md5": "729d6f471d7e18b4c01d5cb823aa2fe4",
"sha256": "8f57f10cded2cdeb20c9316477176d68808ff4ca74659cdd8a93cca0695f89da"
},
"downloads": -1,
"filename": "oemetadata-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "729d6f471d7e18b4c01d5cb823aa2fe4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 84550,
"upload_time": "2023-05-30T14:11:41",
"upload_time_iso_8601": "2023-05-30T14:11:41.480626Z",
"url": "https://files.pythonhosted.org/packages/66/6e/54ae734bd51e8cf7f40099460dcd4baee88c597aa574c4457418c1491e81/oemetadata-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 14:11:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenEnergyPlatform",
"github_project": "oemetadata",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "oemetadata"
}
JSON
