======
medali
======
.. image:: https://travis-ci.com/TUW-GEO/medali.svg?branch=master
:target: https://travis-ci.org/TUW-GEO/medali
.. image:: https://coveralls.io/repos/github/TUW-GEO/medali/badge.svg?branch=master
:target: https://coveralls.io/github/TUW-GEO/medali?branch=master
.. image:: https://badge.fury.io/py/medali.svg
:target: https://badge.fury.io/py/medali
.. image:: https://readthedocs.org/projects/medali/badge/?version=latest
:target: https://medali.readthedocs.io/en/latest/?badge=latest
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
*medali* stands for **ME**\ ta\ **DA**\ ta **LI**\ brary and is responsible for parsing, tagging and interpreting product metadata.
Description
===========
*medali* should be a place to establish version-controlled metadata definitions to guarantee homogeneous reading and writing
of metadata within the scope of one product. It provides one module, the `core` module containing the class `MetaData`.
This class offers a simple interface to actual metadata items, which are defined with respect to reference metadata.
Such reference metadata can either be prepared manually as a dictionary or can be set in a configuration file.
For mature products, the configuration files are stored in the folder in "src/medali/lib" under a product ID and a metadata version.
The `Metadata` class offers the following functionality:
* initialisation via a metadata dictionary (+ optionally a reference metadata dictionary), via a product ID and
metadata version combination, or via a configuration file path
* setting and encoding (from a given data type to a string) the given metadata items
* returning and decoding (from a string to a given data type) the given metadata items
* checking if given metadata meets the criteria defined in the reference metadata (e.g., if the value is within a list of allowed values or if the value contains a specific string, ...)
Installation
============
*medali* is a very light-weight package and has no dependencies. It can be installed via `pip`:
.. code-block:: bash
pip install medali
Adding products
===============
A template configuration file for creating new reference metadata for a product can be found in the "templates" folder.
The file should be named according to the metadata version and should be placed in a sub-folder in "src/medali/lib" named after the product ID.
The reference metadata should have two sections:
- "Metadata": all needed tags and their data type (currently supported: string, boolean, datetime, integer, number)
- "Expected_value": should list metadata items that need to meet some specific criteria
Raw data
{
"_id": null,
"home_page": "https://github.com/TUW-GEO/medali",
"name": "medali",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Metadata",
"author": "TU Wien GEO MRS group",
"author_email": "remote.sensing@geo.tuwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/15/67/546d925dca99cb60b28ca917eac942b972d87a9618112971bfde0db5f152/medali-0.2.8.tar.gz",
"platform": "any",
"description": "======\nmedali\n======\n.. image:: https://travis-ci.com/TUW-GEO/medali.svg?branch=master\n :target: https://travis-ci.org/TUW-GEO/medali\n.. image:: https://coveralls.io/repos/github/TUW-GEO/medali/badge.svg?branch=master\n :target: https://coveralls.io/github/TUW-GEO/medali?branch=master\n.. image:: https://badge.fury.io/py/medali.svg\n :target: https://badge.fury.io/py/medali\n.. image:: https://readthedocs.org/projects/medali/badge/?version=latest\n :target: https://medali.readthedocs.io/en/latest/?badge=latest\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n\n\n*medali* stands for **ME**\\ ta\\ **DA**\\ ta **LI**\\ brary and is responsible for parsing, tagging and interpreting product metadata. \n\n\nDescription\n===========\n\n*medali* should be a place to establish version-controlled metadata definitions to guarantee homogeneous reading and writing\nof metadata within the scope of one product. It provides one module, the `core` module containing the class `MetaData`.\nThis class offers a simple interface to actual metadata items, which are defined with respect to reference metadata.\nSuch reference metadata can either be prepared manually as a dictionary or can be set in a configuration file.\nFor mature products, the configuration files are stored in the folder in \"src/medali/lib\" under a product ID and a metadata version.\n\nThe `Metadata` class offers the following functionality:\n\n * initialisation via a metadata dictionary (+ optionally a reference metadata dictionary), via a product ID and\n metadata version combination, or via a configuration file path\n * setting and encoding (from a given data type to a string) the given metadata items\n * returning and decoding (from a string to a given data type) the given metadata items\n * checking if given metadata meets the criteria defined in the reference metadata (e.g., if the value is within a list of allowed values or if the value contains a specific string, ...)\n\nInstallation\n============\n\n*medali* is a very light-weight package and has no dependencies. It can be installed via `pip`:\n\n.. code-block:: bash\n\n pip install medali\n\nAdding products\n===============\n\nA template configuration file for creating new reference metadata for a product can be found in the \"templates\" folder.\nThe file should be named according to the metadata version and should be placed in a sub-folder in \"src/medali/lib\" named after the product ID.\nThe reference metadata should have two sections:\n\n- \"Metadata\": all needed tags and their data type (currently supported: string, boolean, datetime, integer, number)\n- \"Expected_value\": should list metadata items that need to meet some specific criteria\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "mit",
"summary": "medali is responsible for parsing, tagging and interpreting product metadata",
"version": "0.2.8",
"project_urls": {
"Homepage": "https://github.com/TUW-GEO/medali"
},
"split_keywords": [
"metadata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9784d687d2e1e424ada34954238a77576d623ea7f81753fca1b5b074fe820c5f",
"md5": "f39a5cf3c7280d53cc3893c5a132f537",
"sha256": "721c47f1365f95b01f98e88b35200e7d886f74ce26819fb6699c99d6fa61ec03"
},
"downloads": -1,
"filename": "medali-0.2.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f39a5cf3c7280d53cc3893c5a132f537",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 23145,
"upload_time": "2023-08-30T10:25:50",
"upload_time_iso_8601": "2023-08-30T10:25:50.847760Z",
"url": "https://files.pythonhosted.org/packages/97/84/d687d2e1e424ada34954238a77576d623ea7f81753fca1b5b074fe820c5f/medali-0.2.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1567546d925dca99cb60b28ca917eac942b972d87a9618112971bfde0db5f152",
"md5": "db308cbcaa61696460eae9332b1cc8fa",
"sha256": "2ca5b87bbf931c353afa74a16e9049caecd623c32bc2f337352f4223784afdbe"
},
"downloads": -1,
"filename": "medali-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "db308cbcaa61696460eae9332b1cc8fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20251,
"upload_time": "2023-08-30T10:25:52",
"upload_time_iso_8601": "2023-08-30T10:25:52.577133Z",
"url": "https://files.pythonhosted.org/packages/15/67/546d925dca99cb60b28ca917eac942b972d87a9618112971bfde0db5f152/medali-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 10:25:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TUW-GEO",
"github_project": "medali",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "medali"
}
JSON
