.. image:: https://github.com/matthiaskoenig/pymetadata/raw/develop/docs/images/favicon/pymetadata-100x100-300dpi.png
:align: left
:alt: pymetadata logo
pymetadata: python utilities for metadata and COMBINE archives
==============================================================
|icon1| |icon2| |icon3| |icon4| |icon5| |icon6| |icon7|
.. |icon1| image:: https://github.com/matthiaskoenig/pymetadata/workflows/CI-CD/badge.svg
:target: https://github.com/matthiaskoenig/pymetadata/workflows/CI-CD
:alt: GitHub Actions CI/CD Status
.. |icon2| image:: https://img.shields.io/pypi/v/pymetadata.svg
:target: https://pypi.org/project/pymetadata/
:alt: Current PyPI Version
.. |icon3| image:: https://img.shields.io/pypi/pyversions/pymetadata.svg
:target: https://pypi.org/project/pymetadata/
:alt: Supported Python Versions
.. |icon4| image:: https://img.shields.io/pypi/l/pymetadata.svg
:target: http://opensource.org/licenses/LGPL-3.0
:alt: GNU Lesser General Public License 3
.. |icon5| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5308801.svg
:target: https://doi.org/10.5281/zenodo.5308801
:alt: Zenodo DOI
.. |icon6| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Black
.. |icon7| image:: http://www.mypy-lang.org/static/mypy_badge.svg
:target: http://mypy-lang.org/
:alt: mypy
pymetadata is a collection of python utilities for working with
metadata in the context of COMBINE standards with source code available from
`https://github.com/matthiaskoenig/pymetadata <https://github.com/matthiaskoenig/pymetadata>`__.
Features include among others
- COMBINE archive version 1 support (OMEX)
- annotation classes and helpers
- SBO and KISAO ontology enums
If you have any questions or issues please `open an issue <https://github.com/matthiaskoenig/pymetadata/issues>`__.
Documentation
=============
Documentation is still work in progress. For an example usage of the COMBINE archive
see `src/pymetadata/examples/omex_example.py <src/pymetadata/examples/omex_example.py>`__.
How to cite
===========
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5308801.svg
:target: https://doi.org/10.5281/zenodo.5308801
:alt: Zenodo DOI
Contributing
============
Contributions are always welcome! Please read the `contributing guidelines
<https://github.com/matthiaskoenig/pymetadata/blob/develop/.github/CONTRIBUTING.rst>`__ to
get started.
License
=======
* Source Code: `LGPLv3 <http://opensource.org/licenses/LGPL-3.0>`__
* Documentation: `CC BY-SA 4.0 <http://creativecommons.org/licenses/by-sa/4.0/>`__
The pymetadata source is released under both the GPL and LGPL licenses version 2 or
later. You may choose which license you choose to use the software under.
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License or the GNU Lesser General Public
License as published by the Free Software Foundation, either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
Funding
=======
Matthias König (MK) was supported by the Federal Ministry of Education and Research
(BMBF, Germany) within the research network Systems Medicine of the Liver
(**LiSyM**, grant number 031L0054). MK is supported by the Federal Ministry of
Education and Research (BMBF, Germany) within ATLAS by grant number 031L0304B and
by the German Research Foundation (DFG) within the Research Unit Program FOR 5151
QuaLiPerF (Quantifying Liver Perfusion-Function Relationship in Complex Resection
- A Systems Medicine Approach) by grant number 436883643 and by grant number
465194077 (Priority Programme SPP 2311, Subproject SimLivA).
Installation
============
`pymetadata` is available from `pypi <https://pypi.python.org/pypi/pymetadata>`__ and
can be installed via::
pip install pymetadata
Develop version
---------------
The latest develop version can be installed via::
pip install git+https://github.com/matthiaskoenig/pymetadata.git@develop
Or via cloning the repository and installing via::
git clone https://github.com/matthiaskoenig/pymetadata.git
cd pymetadata
pip install -e .
To install for development use::
pip install -e .[development]
Cache path
==========
`pymetadata` caches some information for faster retrieval. The cache path is set to::
CACHE_PATH: Path = Path.home() / ".cache" / "pymetadata"
To use a custom cache path use::
import pymetadata
pymetadata.CACHE_PATH = <cache_path>
© 2021-2024 Matthias König
Raw data
{
"_id": null,
"home_page": "https://github.com/matthiaskoenig/pymetadata",
"name": "pymetadata",
"maintainer": "Matthias Koenig",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "konigmatt@googlemail.com",
"keywords": "modeling, standardization, COMBINE, metadata, archive, annotation",
"author": "Matthias Koenig",
"author_email": "konigmatt@googlemail.com",
"download_url": "https://files.pythonhosted.org/packages/8e/56/977f4900ff85b342519278fd1dee6bf8fd4841b552190cfa5f6d549ef493/pymetadata-0.4.4.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/matthiaskoenig/pymetadata/raw/develop/docs/images/favicon/pymetadata-100x100-300dpi.png\n :align: left\n :alt: pymetadata logo\n\npymetadata: python utilities for metadata and COMBINE archives\n==============================================================\n|icon1| |icon2| |icon3| |icon4| |icon5| |icon6| |icon7|\n\n\n.. |icon1| image:: https://github.com/matthiaskoenig/pymetadata/workflows/CI-CD/badge.svg\n :target: https://github.com/matthiaskoenig/pymetadata/workflows/CI-CD\n :alt: GitHub Actions CI/CD Status\n.. |icon2| image:: https://img.shields.io/pypi/v/pymetadata.svg\n :target: https://pypi.org/project/pymetadata/\n :alt: Current PyPI Version\n.. |icon3| image:: https://img.shields.io/pypi/pyversions/pymetadata.svg\n :target: https://pypi.org/project/pymetadata/\n :alt: Supported Python Versions\n.. |icon4| image:: https://img.shields.io/pypi/l/pymetadata.svg\n :target: http://opensource.org/licenses/LGPL-3.0\n :alt: GNU Lesser General Public License 3\n.. |icon5| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5308801.svg\n :target: https://doi.org/10.5281/zenodo.5308801\n :alt: Zenodo DOI\n.. |icon6| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n :alt: Black\n.. |icon7| image:: http://www.mypy-lang.org/static/mypy_badge.svg\n :target: http://mypy-lang.org/\n :alt: mypy\n\npymetadata is a collection of python utilities for working with\nmetadata in the context of COMBINE standards with source code available from \n`https://github.com/matthiaskoenig/pymetadata <https://github.com/matthiaskoenig/pymetadata>`__.\n\nFeatures include among others\n\n- COMBINE archive version 1 support (OMEX)\n- annotation classes and helpers\n- SBO and KISAO ontology enums\n \nIf you have any questions or issues please `open an issue <https://github.com/matthiaskoenig/pymetadata/issues>`__.\n\nDocumentation\n=============\nDocumentation is still work in progress. For an example usage of the COMBINE archive\nsee `src/pymetadata/examples/omex_example.py <src/pymetadata/examples/omex_example.py>`__.\n\nHow to cite\n===========\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5308801.svg\n :target: https://doi.org/10.5281/zenodo.5308801\n :alt: Zenodo DOI\n\nContributing\n============\n\nContributions are always welcome! Please read the `contributing guidelines\n<https://github.com/matthiaskoenig/pymetadata/blob/develop/.github/CONTRIBUTING.rst>`__ to\nget started.\n\nLicense\n=======\n\n* Source Code: `LGPLv3 <http://opensource.org/licenses/LGPL-3.0>`__\n* Documentation: `CC BY-SA 4.0 <http://creativecommons.org/licenses/by-sa/4.0/>`__\n\nThe pymetadata source is released under both the GPL and LGPL licenses version 2 or\nlater. You may choose which license you choose to use the software under.\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU General Public License or the GNU Lesser General Public\nLicense as published by the Free Software Foundation, either version 2 of the\nLicense, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nFunding\n=======\nMatthias K\u00f6nig (MK) was supported by the Federal Ministry of Education and Research \n(BMBF, Germany) within the research network Systems Medicine of the Liver \n(**LiSyM**, grant number 031L0054). MK is supported by the Federal Ministry of \nEducation and Research (BMBF, Germany) within ATLAS by grant number 031L0304B and \nby the German Research Foundation (DFG) within the Research Unit Program FOR 5151 \nQuaLiPerF (Quantifying Liver Perfusion-Function Relationship in Complex Resection \n- A Systems Medicine Approach) by grant number 436883643 and by grant number \n465194077 (Priority Programme SPP 2311, Subproject SimLivA).\n\nInstallation\n============\n`pymetadata` is available from `pypi <https://pypi.python.org/pypi/pymetadata>`__ and \ncan be installed via:: \n\n pip install pymetadata\n\nDevelop version\n---------------\nThe latest develop version can be installed via::\n\n pip install git+https://github.com/matthiaskoenig/pymetadata.git@develop\n\nOr via cloning the repository and installing via::\n\n git clone https://github.com/matthiaskoenig/pymetadata.git\n cd pymetadata\n pip install -e .\n\n\nTo install for development use::\n\n pip install -e .[development]\n\n\nCache path\n==========\n`pymetadata` caches some information for faster retrieval. The cache path is set to::\n\n CACHE_PATH: Path = Path.home() / \".cache\" / \"pymetadata\"\n\nTo use a custom cache path use::\n\n import pymetadata\n pymetadata.CACHE_PATH = <cache_path>\n\n\u00a9 2021-2024 Matthias K\u00f6nig\n",
"bugtrack_url": null,
"license": "LGPL-3.0",
"summary": "pymetadata are python utilities for working with metadata.",
"version": "0.4.4",
"project_urls": {
"Bug Tracker": "https://github.com/matthiaskoenig/pymetadata/issues",
"Documentation": "https://github.com/matthiaskoenig/pymetadata",
"Download": "https://pypi.org/project/pymetadata",
"Homepage": "https://github.com/matthiaskoenig/pymetadata",
"Source Code": "https://github.com/matthiaskoenig/pymetadata"
},
"split_keywords": [
"modeling",
" standardization",
" combine",
" metadata",
" archive",
" annotation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b54be04bba7a1aa6f89eafb04d3ae4d245ea1e14ca72ddacbd2f1a23dd84a29",
"md5": "acf5b2d2c547c9c2eecc1c2069bb4679",
"sha256": "ec72ff1eed0255c09e754e042aaa514fcba7dbfc877e4a6fc88fb3e63466c3e0"
},
"downloads": -1,
"filename": "pymetadata-0.4.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "acf5b2d2c547c9c2eecc1c2069bb4679",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 186866,
"upload_time": "2024-06-13T16:23:43",
"upload_time_iso_8601": "2024-06-13T16:23:43.678854Z",
"url": "https://files.pythonhosted.org/packages/2b/54/be04bba7a1aa6f89eafb04d3ae4d245ea1e14ca72ddacbd2f1a23dd84a29/pymetadata-0.4.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e56977f4900ff85b342519278fd1dee6bf8fd4841b552190cfa5f6d549ef493",
"md5": "71ccd6963aec93afd4aa4b82703a7208",
"sha256": "a6e264d74b1b6c4b3e9d354429819ab8fa2e3c6349e923ef5d17ccec1ea2524a"
},
"downloads": -1,
"filename": "pymetadata-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "71ccd6963aec93afd4aa4b82703a7208",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 183404,
"upload_time": "2024-06-13T16:23:45",
"upload_time_iso_8601": "2024-06-13T16:23:45.812261Z",
"url": "https://files.pythonhosted.org/packages/8e/56/977f4900ff85b342519278fd1dee6bf8fd4841b552190cfa5f6d549ef493/pymetadata-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-13 16:23:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matthiaskoenig",
"github_project": "pymetadata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pymetadata"
}
JSON
