Metadata-Version: 2.4
Name: pyheimdall-nakala
Version: 0.10.0
Summary: Nakala connector for pyHeimdall
Project-URL: Homepage, https://gitlab.huma-num.fr/datasphere/heimdall/connectors/nakala/
Project-URL: Issues, https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues
Author-email: Régis Witz <regis.witz@cnrs.fr>
License: aGPL
License-File: LICENSE
Keywords: databases,heimdall,hera,interoperability
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Database
Classifier: Topic :: Documentation
Classifier: Topic :: File Formats
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Dist: pyheimdall>=1.2
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: pyheimdall[pep-8,tests]; extra == 'dev'
Provides-Extra: pep-8
Requires-Dist: pycodestyle; extra == 'pep-8'
Provides-Extra: tests
Requires-Dist: coverage; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Description-Content-Type: text/x-rst

###########################
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/pypi/v/pyheimdall-nakala
   :target: https://pypi.org/project/pyheimdall-nakala/
   :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/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
=====

This Nakala pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-wikidata/>`_ named ``pyheimdall-nakala``.
You can install it using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:

.. code-block:: bash

   pip install pyheimdall-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-nakala
   pip uninstall pyheimdall-nakala

Usage
=====

.. code-block:: python

   import heimdall

   tree = heimdall.getDatabase(url, format='api:nakala')

Please note that you don't need to use ``pyheimdall-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 tested?
*************

Of course!
Here's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/connectors/nakala/coverage/index.html>`_.


*********************
How can I contribute?
*********************

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/>`_
