[
](https://materials-data-science-and-informatics.github.io/metador-core)
[
](https://github.com/Materials-Data-Science-and-Informatics/metador-core/actions/workflows/ci.yml)
[
](https://materials-data-science-and-informatics.github.io/metador-core/main/coverage)
[
](https://pypi.org/project/metador-core/)
[
](https://bestpractices.coreinfrastructure.org/projects/7174)
[
](https://fair-software.eu)
<!-- --8<-- [start:abstract] -->
# metador-core
The core library of the Metador framework. It provides:
* an interface for managing structured and validated metadata (`MetadorContainer`)
* an API to manage immutable (but still "patchable") HDF5 files (`IH5Record`)
* an extensible entry-points based plugin system for defining plugin groups and plugins
* core plugin group types and interfaces (schemas, packers, widgets, ...)
* general semantically aligned schemas that can be used and extended
* visualization widgets for common data types based on Bokeh and Panel
* generic dashboard presenting (meta)data for which suitable widgets are installed
<!-- --8<-- [end:abstract] -->
<!-- --8<-- [start:quickstart] -->
## Installation
You can install the current stable version of Metador from PyPI:
```
pip install metador-core
```
## Getting Started
If you successfully installed the package, check out the
[tutorial notebooks](https://materials-data-science-and-informatics.github.io/metador-core/main/notebooks/about/).
These are intended to showcase what Metador has to offer and get you started with usage
and development of your own schemas, widgets or other plugins.
To explore the notebooks interactively, clone this repo, install it, and then run:
```
pip install notebook
jupyter notebook ./docs/notebooks
```
You can use the
[metador-extension-cookiecutter](https://github.com/Materials-Data-Science-and-Informatics/metador-extension-cookiecutter)
template to generate a well-structured Python package repository that you can use to
quickly get started with Metador plugin development.
## Compatibility and Known Issues
Currently this package supports Python `>=3.8`.
We will try to support all still officially updated versions of Python,
unless forced to drop it for technical reasons.
<!-- --8<-- [end:quickstart] -->
**You can find more information on using and contributing to this repository in the
[documentation](https://materials-data-science-and-informatics.github.io/metador-core/main).**
<!-- --8<-- [start:citation] -->
## How to Cite
If you want to cite this project in your scientific work,
please use the [citation file](https://citation-file-format.github.io/)
in the [repository](https://github.com/Materials-Data-Science-and-Informatics/metador-core/blob/main/CITATION.cff).
<!-- --8<-- [end:citation] -->
<!-- --8<-- [start:acknowledgements] -->
## Acknowledgements
We kindly thank all
[authors and contributors](https://materials-data-science-and-informatics.github.io/metador-core/latest/credits).
<div>
<img style="vertical-align: middle;" alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png" width=50% height=50% />
<img style="vertical-align: middle;" alt="FZJ Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png" width=30% height=30% />
</div>
<br />
This project was developed at the Institute for Materials Data Science and Informatics
(IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration
(HMC), an incubator-platform of the Helmholtz Association within the framework of the
Information and Data Science strategic initiative.
<!-- --8<-- [end:acknowledgements] -->
Raw data
{
"_id": null,
"home_page": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
"name": "metador-core",
"maintainer": "Anton Pirogov",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "a.pirogov@fz-juelich.de",
"keywords": "metadata,rdm,FAIR,framework,python",
"author": "Anton Pirogov",
"author_email": "a.pirogov@fz-juelich.de",
"download_url": "https://files.pythonhosted.org/packages/11/8f/d540dc22252c26ef929bd538b6c887c44fc592a26791ea354b068452674d/metador_core-0.1.1.tar.gz",
"platform": null,
"description": "[\n\n](https://materials-data-science-and-informatics.github.io/metador-core)\n[\n\n](https://github.com/Materials-Data-Science-and-Informatics/metador-core/actions/workflows/ci.yml)\n[\n\n](https://materials-data-science-and-informatics.github.io/metador-core/main/coverage)\n[\n\n](https://pypi.org/project/metador-core/)\n[\n\n](https://bestpractices.coreinfrastructure.org/projects/7174)\n[\n\n](https://fair-software.eu)\n\n<!-- --8<-- [start:abstract] -->\n# metador-core\n\nThe core library of the Metador framework. It provides:\n\n* an interface for managing structured and validated metadata (`MetadorContainer`)\n* an API to manage immutable (but still \"patchable\") HDF5 files (`IH5Record`)\n* an extensible entry-points based plugin system for defining plugin groups and plugins\n* core plugin group types and interfaces (schemas, packers, widgets, ...)\n* general semantically aligned schemas that can be used and extended\n* visualization widgets for common data types based on Bokeh and Panel\n* generic dashboard presenting (meta)data for which suitable widgets are installed\n\n<!-- --8<-- [end:abstract] -->\n<!-- --8<-- [start:quickstart] -->\n\n## Installation\n\nYou can install the current stable version of Metador from PyPI:\n\n```\npip install metador-core\n```\n\n## Getting Started\n\nIf you successfully installed the package, check out the\n[tutorial notebooks](https://materials-data-science-and-informatics.github.io/metador-core/main/notebooks/about/).\n\nThese are intended to showcase what Metador has to offer and get you started with usage\nand development of your own schemas, widgets or other plugins.\n\nTo explore the notebooks interactively, clone this repo, install it, and then run:\n\n```\npip install notebook\njupyter notebook ./docs/notebooks\n```\n\nYou can use the\n[metador-extension-cookiecutter](https://github.com/Materials-Data-Science-and-Informatics/metador-extension-cookiecutter)\ntemplate to generate a well-structured Python package repository that you can use to\nquickly get started with Metador plugin development.\n\n## Compatibility and Known Issues\n\nCurrently this package supports Python `>=3.8`.\n\nWe will try to support all still officially updated versions of Python,\nunless forced to drop it for technical reasons.\n\n<!-- --8<-- [end:quickstart] -->\n\n**You can find more information on using and contributing to this repository in the\n[documentation](https://materials-data-science-and-informatics.github.io/metador-core/main).**\n\n<!-- --8<-- [start:citation] -->\n\n## How to Cite\n\nIf you want to cite this project in your scientific work,\nplease use the [citation file](https://citation-file-format.github.io/)\nin the [repository](https://github.com/Materials-Data-Science-and-Informatics/metador-core/blob/main/CITATION.cff).\n\n<!-- --8<-- [end:citation] -->\n<!-- --8<-- [start:acknowledgements] -->\n\n## Acknowledgements\n\nWe kindly thank all\n[authors and contributors](https://materials-data-science-and-informatics.github.io/metador-core/latest/credits).\n\n<div>\n<img style=\"vertical-align: middle;\" alt=\"HMC Logo\" src=\"https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png\" width=50% height=50% />\n \n<img style=\"vertical-align: middle;\" alt=\"FZJ Logo\" src=\"https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png\" width=30% height=30% />\n</div>\n<br />\n\nThis project was developed at the Institute for Materials Data Science and Informatics\n(IAS-9) of the J\u00fclich Research Center and funded by the Helmholtz Metadata Collaboration\n(HMC), an incubator-platform of the Helmholtz Association within the framework of the\nInformation and Data Science strategic initiative.\n\n<!-- --8<-- [end:acknowledgements] -->\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core of Metador, the metadata-first research data management framework.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
"Homepage": "https://github.com/Materials-Data-Science-and-Informatics/metador-core",
"Repository": "https://github.com/Materials-Data-Science-and-Informatics/metador-core"
},
"split_keywords": [
"metadata",
"rdm",
"fair",
"framework",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53d701da924e6ab8ad3f31f2727512d85819c0bf01ab1aac72709acff6a8c47d",
"md5": "6d77baad668db5d5d3df777da06aacae",
"sha256": "512082f4897868f7f49282ce863fbe0609c09496ed06722a87bbdeb01690b2cd"
},
"downloads": -1,
"filename": "metador_core-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d77baad668db5d5d3df777da06aacae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 172460,
"upload_time": "2023-09-11T11:02:54",
"upload_time_iso_8601": "2023-09-11T11:02:54.737211Z",
"url": "https://files.pythonhosted.org/packages/53/d7/01da924e6ab8ad3f31f2727512d85819c0bf01ab1aac72709acff6a8c47d/metador_core-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "118fd540dc22252c26ef929bd538b6c887c44fc592a26791ea354b068452674d",
"md5": "ad41eaccba01367a368d3cf84caec8b9",
"sha256": "1f1bdd4ee43b22a45c60a37af77425122051e3ea58ee810718a4399d53042eae"
},
"downloads": -1,
"filename": "metador_core-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ad41eaccba01367a368d3cf84caec8b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 648043,
"upload_time": "2023-09-11T11:02:56",
"upload_time_iso_8601": "2023-09-11T11:02:56.335011Z",
"url": "https://files.pythonhosted.org/packages/11/8f/d540dc22252c26ef929bd538b6c887c44fc592a26791ea354b068452674d/metador_core-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-11 11:02:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Materials-Data-Science-and-Informatics",
"github_project": "metador-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "metador-core"
}
JSON
