#############################
Heimdall - Wikidata connector
#############################
.. image:: https://img.shields.io/badge/license-AGPL3.0-informational?logo=gnu&color=success
:target: https://www.gnu.org/licenses/agpl-3.0.html
.. image:: https://www.repostatus.org/badges/latest/inactive.svg
:target: https://www.repostatus.org/#project-statuses
.. image:: https://img.shields.io/pypi/v/pyheimdall-wikidata
:target: https://pypi.org/project/pyheimdall-wikidata/
:alt: PyPI Version
.. image:: https://img.shields.io/badge/documentation-api-green
:target: https://datasphere.readthedocs.io/projects/heimdall/
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/badges/main/pipeline.svg
:target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/pipelines/latest
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/badges/main/coverage.svg
:target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/wikidata/coverage/index.html
*************
What is this?
*************
`pyHeimdall <https://datasphere.readthedocs.io/projects/heimdall/python/>`_ is a tool for converting more easily one or more databases from one format to another.
It leverages modules called "connectors", responsible for conversion of data between specific databases schemas and the HERA format.
This repository implements a connector to Wikidata.
The implementation was made without any intervention on pyHeimdall proper.
*****************
How can I use it?
*****************
Setup
=====
This Wikidata pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-wikidata/>`_ named ``pyheimdall-wikidata``.
You can install it using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:
.. code-block:: bash
pip install pyheimdall-wikidata
You can use `pip <https://pip.pypa.io/en/stable/>`_ to either upgrade or uninstall this connector, too:
.. code-block:: bash
pip install --upgrade pyheimdall-wikidata
pip uninstall pyheimdall-wikidata
Usage
=====
.. code-block:: python
import heimdall
HARRY_POTTER = 'https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q216930&format=json&languages=fr|en'
tree = heimdall.getDatabase(format='api:wikidata', url=HARRY_POTTER)
heimdall.serialize(tree, format='hera:xml', url='HARRY_POTTER.xml')
Please note that you don't need to use ``pyheimdall-wikidata`` functions directly.
As long as the package is installed on your system, pyHeimdall will automatically discover its features and allow you to use them as long as any other `default <https://gitlab.huma-num.fr/datasphere/heimdall/python/-/tree/main/src/heimdall/connectors>`_ or `external <https://gitlab.huma-num.fr/datasphere/heimdall/connectors>`_ connector.
*************
Is it tested?
*************
Of course!
Here's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/connectors/wikidata/coverage/index.html>`_.
*********************
How can I contribute?
*********************
This project welcomes any feedback or proposal.
Details can be accessed `here <https://gitlab.huma-num.fr/datasphere/heimdall/python/-/blob/main/CONTRIBUTING.rst>`_
*******
License
*******
`GNU Affero General Public License version 3.0 or later <https://choosealicense.com/licenses/agpl/>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "pyheimdall-wikidata",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "databases, hera, interoperability",
"author": null,
"author_email": "Elisa Michelet <elisa.michelet@bnu.fr>, Arthur Brody <arthur.brody@bnu.fr>, R\u00e9gis Witz <regis.witz@cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/eb/c3/9d2239c77018a48f8908504b211044ee65c828a04301f0f47ffb504f0154/pyheimdall_wikidata-1.0.1.tar.gz",
"platform": null,
"description": "#############################\nHeimdall - Wikidata connector\n#############################\n\n.. image:: https://img.shields.io/badge/license-AGPL3.0-informational?logo=gnu&color=success\n :target: https://www.gnu.org/licenses/agpl-3.0.html\n.. image:: https://www.repostatus.org/badges/latest/inactive.svg\n :target: https://www.repostatus.org/#project-statuses\n.. image:: https://img.shields.io/pypi/v/pyheimdall-wikidata\n :target: https://pypi.org/project/pyheimdall-wikidata/\n :alt: PyPI Version\n.. image:: https://img.shields.io/badge/documentation-api-green\n :target: https://datasphere.readthedocs.io/projects/heimdall/\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/badges/main/pipeline.svg\n :target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/pipelines/latest\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/badges/main/coverage.svg\n :target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/wikidata/coverage/index.html\n\n*************\nWhat is this?\n*************\n\n`pyHeimdall <https://datasphere.readthedocs.io/projects/heimdall/python/>`_ is a tool for converting more easily one or more databases from one format to another.\nIt leverages modules called \"connectors\", responsible for conversion of data between specific databases schemas and the HERA format.\n\nThis repository implements a connector to Wikidata.\nThe implementation was made without any intervention on pyHeimdall proper.\n\n*****************\nHow can I use it?\n*****************\n\nSetup\n=====\n\nThis Wikidata pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-wikidata/>`_ named ``pyheimdall-wikidata``.\nYou can install it using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:\n\n.. code-block:: bash\n\n pip install pyheimdall-wikidata\n\nYou can use `pip <https://pip.pypa.io/en/stable/>`_ to either upgrade or uninstall this connector, too:\n\n.. code-block:: bash\n\n pip install --upgrade pyheimdall-wikidata\n pip uninstall pyheimdall-wikidata\n\nUsage\n=====\n\n.. code-block:: python\n\n import heimdall\n\n HARRY_POTTER = 'https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q216930&format=json&languages=fr|en'\n tree = heimdall.getDatabase(format='api:wikidata', url=HARRY_POTTER)\n heimdall.serialize(tree, format='hera:xml', url='HARRY_POTTER.xml')\n\nPlease note that you don't need to use ``pyheimdall-wikidata`` functions directly.\nAs long as the package is installed on your system, pyHeimdall will automatically discover its features and allow you to use them as long as any other `default <https://gitlab.huma-num.fr/datasphere/heimdall/python/-/tree/main/src/heimdall/connectors>`_ or `external <https://gitlab.huma-num.fr/datasphere/heimdall/connectors>`_ connector.\n\n\n*************\nIs it tested?\n*************\n\nOf course!\nHere's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/connectors/wikidata/coverage/index.html>`_.\n\n\n*********************\nHow can I contribute?\n*********************\n\nThis project welcomes any feedback or proposal.\nDetails can be accessed `here <https://gitlab.huma-num.fr/datasphere/heimdall/python/-/blob/main/CONTRIBUTING.rst>`_\n\n*******\nLicense\n*******\n\n`GNU Affero General Public License version 3.0 or later <https://choosealicense.com/licenses/agpl/>`_\n",
"bugtrack_url": null,
"license": "aGPL",
"summary": "Wikidata connector for pyHeimdall",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://gitlab.huma-num.fr/datasphere/heimdall/connectors/wikidata/",
"Issues": "https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues"
},
"split_keywords": [
"databases",
" hera",
" interoperability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5aafb1ff18aef7e14b83d4d6b41f16c81e6cf9a0e2334a984be8db4eb8264640",
"md5": "3b51766c810a2c674fa6e190be9acae9",
"sha256": "dd44c5464b5c37c486431ec4ffd0b72a7aad7edd9c99afa753330864e5a7657d"
},
"downloads": -1,
"filename": "pyheimdall_wikidata-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b51766c810a2c674fa6e190be9acae9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 16084,
"upload_time": "2024-12-18T07:46:27",
"upload_time_iso_8601": "2024-12-18T07:46:27.966074Z",
"url": "https://files.pythonhosted.org/packages/5a/af/b1ff18aef7e14b83d4d6b41f16c81e6cf9a0e2334a984be8db4eb8264640/pyheimdall_wikidata-1.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebc39d2239c77018a48f8908504b211044ee65c828a04301f0f47ffb504f0154",
"md5": "f275f66132fb86712386157b8cb39902",
"sha256": "57fee3f83f83c7850efe3edbc53ac5a44c99bd864bb9670a1e64eb93c18a3b48"
},
"downloads": -1,
"filename": "pyheimdall_wikidata-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f275f66132fb86712386157b8cb39902",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23073,
"upload_time": "2024-12-18T07:46:30",
"upload_time_iso_8601": "2024-12-18T07:46:30.710789Z",
"url": "https://files.pythonhosted.org/packages/eb/c3/9d2239c77018a48f8908504b211044ee65c828a04301f0f47ffb504f0154/pyheimdall_wikidata-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 07:46:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyheimdall-wikidata"
}
JSON