Metadata-Version: 2.1
Name: oep-metadata
Version: 1.5.0
Summary: Open Energy Platform (OEP) - metadata schemas, examples and templates package
Home-page: https://github.com/OpenEnergyPlatform/oemetadata
Author: Alexis Michaltsis
Author-email: a.michaltsis@rl-institut.de
License: MIT
Description: ﻿[![Build Status](https://travis-ci.org/OpenEnergyPlatform/oemetadata.svg?branch=develop)](https://travis-ci.org/OpenEnergyPlatform/oemetadata)
        
        <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 (OEM)
        
        Open Energy Metadata (OEM) 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 oep-metadata`
        
        ## Usage Examples
        
        ```
        from metadata.v150.example import OEMETADATA_v150_EXAMPLE
        
        print(OEMETADATA_v150_EXAMPLE)
        ```
        
        ```
        from metadata.v150.schema import OEMETADATA_v150_SCHEMA
        
        print(OEMETADATA_v150_SCHEMA)
        ```
        
        ```
        from metadata.v150.template import OEMETADATA_v150_TEMPLATE
        
        print(OEMETADATA_v150_TEMPLATE)
        ```
        
        ## Contributing
        
        For further contributing infos and conventions see: [CONTRIBUTING.md](./CONTRIBUTING.md)
        
        ## Make PyPI release:
        
        First bump version in setup.py, then:
        
        ```
        python3 setup.py sdist bdist_wheel
        twine upload dist/*
        ```
        
Keywords: JSON metadata schema open energy platform oep
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
