###########################
Heimdall - Nakala 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/badge/documentation-api-green
:target: https://datasphere.readthedocs.io/projects/heimdall/
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/badges/main/pipeline.svg
:target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/pipelines/latest
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/badges/main/coverage.svg
:target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/nakala/coverage/index.html
*************
What is this?
*************
`Heimdall <https://datasphere.readthedocs.io/projects/heimdall/>`_ 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 contains a connector to french research infrastructure Huma-Num's data repository `Nakala <https://nakala.fr/>`_.
********************
Why should I use it?
********************
You can use this connector, along with the `pyheimdall software <https://gitlab.huma-num.fr/datasphere/heimdall/python>`_, to retrieve any data from Nakala.
You can then aggregate this data into your research corpus easily, for example using other Heimdall connectors.
| Take note, however that some legal restrictions might apply to data retrieved from Nakala.
| Plus, if at the end of your project, you share your data, please cite the original data properly (and reuploading it elsewhere is probably a bad idea, too).
*****************
How can I use it?
*****************
Setup
=====
You can install this connector using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:
.. code-block:: bash
pip install pyheimdall-connectors-nakala
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-connectors-nakala
pip uninstall pyheimdall-connectors-nakala
Usage
=====
.. code-block:: python
import heimdall
tree = heimdall.getDatabase(url, format='api:nakala')
Please note that you don't need to use ``pyheimdall-connectors-nakala`` 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 documented?
*****************
Sure!
Here's `the link <https://datasphere.readthedocs.io/projects/heimdall/>`_.
*************
Is it tested?
*************
Of course!
Here's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/connectors/nakala/coverage/index.html>`_.
*********************
How can I contribute?
*********************
This repository is only here for learning purposes, and has no feature of note.
However, pyHeimdall 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-nakala",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "databases, heimdall, hera, interoperability",
"author": null,
"author_email": "R\u00e9gis Witz <regis.witz@cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/b3/e3/a79a56aa78d757f645cf8a3bf482dce47bdcd065db11d478f141ccb087ef/pyheimdall_nakala-0.5.0.tar.gz",
"platform": null,
"description": "###########################\nHeimdall - Nakala 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/badge/documentation-api-green\n :target: https://datasphere.readthedocs.io/projects/heimdall/\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/badges/main/pipeline.svg\n :target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/pipelines/latest\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/badges/main/coverage.svg\n :target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/nakala/coverage/index.html\n\n*************\nWhat is this?\n*************\n\n`Heimdall <https://datasphere.readthedocs.io/projects/heimdall/>`_ 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 contains a connector to french research infrastructure Huma-Num's data repository `Nakala <https://nakala.fr/>`_.\n\n\n\n********************\nWhy should I use it?\n********************\n\nYou can use this connector, along with the `pyheimdall software <https://gitlab.huma-num.fr/datasphere/heimdall/python>`_, to retrieve any data from Nakala.\nYou can then aggregate this data into your research corpus easily, for example using other Heimdall connectors.\n\n| Take note, however that some legal restrictions might apply to data retrieved from Nakala.\n| Plus, if at the end of your project, you share your data, please cite the original data properly (and reuploading it elsewhere is probably a bad idea, too).\n\n\n\n*****************\nHow can I use it?\n*****************\n\nSetup\n=====\n\nYou can install this connector using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:\n\n.. code-block:: bash\n\n pip install pyheimdall-connectors-nakala\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-connectors-nakala\n pip uninstall pyheimdall-connectors-nakala\n\nUsage\n=====\n\n.. code-block:: python\n\n import heimdall\n\n tree = heimdall.getDatabase(url, format='api:nakala')\n\nPlease note that you don't need to use ``pyheimdall-connectors-nakala`` 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*****************\nIs it documented?\n*****************\n\nSure!\nHere's `the link <https://datasphere.readthedocs.io/projects/heimdall/>`_.\n\n\n\n*************\nIs it tested?\n*************\n\nOf course!\nHere's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/connectors/nakala/coverage/index.html>`_.\n\n\n*********************\nHow can I contribute?\n*********************\n\nThis repository is only here for learning purposes, and has no feature of note.\n\nHowever, pyHeimdall 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": "Nakala connector for pyHeimdall",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/",
"Issues": "https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues"
},
"split_keywords": [
"databases",
" heimdall",
" hera",
" interoperability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc10412e9347d98f0c83ca4401c7b0775c8be2fad20e3b64d44fe6abd1fb9712",
"md5": "8f91d4d858af613cc2ed0b25f287ca65",
"sha256": "e8602a39dc1f9b5e8b5cff8f27d59a550fa2a4010116edc83953c5a14047a222"
},
"downloads": -1,
"filename": "pyheimdall_nakala-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f91d4d858af613cc2ed0b25f287ca65",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 16999,
"upload_time": "2024-12-18T10:12:09",
"upload_time_iso_8601": "2024-12-18T10:12:09.804759Z",
"url": "https://files.pythonhosted.org/packages/dc/10/412e9347d98f0c83ca4401c7b0775c8be2fad20e3b64d44fe6abd1fb9712/pyheimdall_nakala-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3e3a79a56aa78d757f645cf8a3bf482dce47bdcd065db11d478f141ccb087ef",
"md5": "9b050af6b9c7562efc6c46789ae924e2",
"sha256": "25d8d4f443fc1a85e4522f8ecfa39b6f2d84a22dc4e27497b4529e0fa03ce715"
},
"downloads": -1,
"filename": "pyheimdall_nakala-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9b050af6b9c7562efc6c46789ae924e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17030,
"upload_time": "2024-12-18T10:12:11",
"upload_time_iso_8601": "2024-12-18T10:12:11.511610Z",
"url": "https://files.pythonhosted.org/packages/b3/e3/a79a56aa78d757f645cf8a3bf482dce47bdcd065db11d478f141ccb087ef/pyheimdall_nakala-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 10:12:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyheimdall-nakala"
}
JSON