#####################################
Heimdall - CollectiveAccess 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/suspended.svg
:target: https://www.repostatus.org/#project-statuses
.. image:: https://img.shields.io/pypi/v/pyheimdall-collectiveaccess
:target: https://pypi.org/project/pyheimdall-collectiveaccess/
: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/collectiveaccess/badges/main/pipeline.svg
:target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/pipelines/latest
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/badges/main/coverage.svg
:target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/collectiveaccess/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 containes a connector to `CollectiveAccess <https://www.collectiveaccess.org/>`_ server sharing their data with the CollectiveAccess `Web Service API <https://manual.collectiveaccess.org/providence/developer/web_service_api.html>`_.
********************
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 a CollectiveAccess server.
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 CollectiveAccess.
| 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 CollectiveAccess pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-collectiveaccess/>`_ named ``pyheimdall-colectiveaccess``.
You can install it using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:
.. code-block:: bash
pip install pyheimdall-collectiveaccess
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-collectiveaccess
pip uninstall pyheimdall-collectiveaccess
Usage
=====
.. code-block:: python
import heimdall
tree = heimdall.getDatabase(format='api:collectiveaccess')
Please note that you don't need to use ``pyheimdall-collectiveaccess`` 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/collectiveaccess/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/>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "pyheimdall-collectiveaccess",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "databases, hera, interoperability",
"author": null,
"author_email": "R\u00e9gis Witz <regis.witz@cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/59/0a/0296540cb48f9f6be663fbad796adbdb6dfe6285d13e57fe2cf28ec73db9/pyheimdall_collectiveaccess-0.6.0.tar.gz",
"platform": null,
"description": "#####################################\nHeimdall - CollectiveAccess 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/suspended.svg\n :target: https://www.repostatus.org/#project-statuses\n.. image:: https://img.shields.io/pypi/v/pyheimdall-collectiveaccess\n :target: https://pypi.org/project/pyheimdall-collectiveaccess/\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/collectiveaccess/badges/main/pipeline.svg\n :target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/pipelines/latest\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/badges/main/coverage.svg\n :target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/collectiveaccess/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 containes a connector to `CollectiveAccess <https://www.collectiveaccess.org/>`_ server sharing their data with the CollectiveAccess `Web Service API <https://manual.collectiveaccess.org/providence/developer/web_service_api.html>`_.\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 a CollectiveAccess server.\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 CollectiveAccess.\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\nThis CollectiveAccess pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-collectiveaccess/>`_ named ``pyheimdall-colectiveaccess``.\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-collectiveaccess\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-collectiveaccess\n pip uninstall pyheimdall-collectiveaccess\n\nUsage\n=====\n\n.. code-block:: python\n\n import heimdall\n\n tree = heimdall.getDatabase(format='api:collectiveaccess')\n\nPlease note that you don't need to use ``pyheimdall-collectiveaccess`` 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/collectiveaccess/coverage/index.html>`_.\n\n\n*********************\nHow can I contribute?\n*********************\n\nPyHeimdall 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": "CollectiveAccess connector for pyHeimdall",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://gitlab.huma-num.fr/datasphere/heimdall/connectors/collectiveaccess/",
"Issues": "https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues"
},
"split_keywords": [
"databases",
" hera",
" interoperability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a1ad27d170d14e052dc768ddd52277df6fec668a040914ad2c31895daa96e4c",
"md5": "1b3196279a1d8abac4022e0dae5dc141",
"sha256": "e88826132b7657a8d28ba3f86600c47b076895d5ab62030189fcd156e3fc24ae"
},
"downloads": -1,
"filename": "pyheimdall_collectiveaccess-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b3196279a1d8abac4022e0dae5dc141",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 16877,
"upload_time": "2024-12-18T16:02:53",
"upload_time_iso_8601": "2024-12-18T16:02:53.098591Z",
"url": "https://files.pythonhosted.org/packages/7a/1a/d27d170d14e052dc768ddd52277df6fec668a040914ad2c31895daa96e4c/pyheimdall_collectiveaccess-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "590a0296540cb48f9f6be663fbad796adbdb6dfe6285d13e57fe2cf28ec73db9",
"md5": "91728a9fa405153c6371a37417f22292",
"sha256": "32b8ffa8874b71aed20642bbeeb75b8db55c47bd6ce72418b15e10d1876adaf6"
},
"downloads": -1,
"filename": "pyheimdall_collectiveaccess-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "91728a9fa405153c6371a37417f22292",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16772,
"upload_time": "2024-12-18T16:02:54",
"upload_time_iso_8601": "2024-12-18T16:02:54.849098Z",
"url": "https://files.pythonhosted.org/packages/59/0a/0296540cb48f9f6be663fbad796adbdb6dfe6285d13e57fe2cf28ec73db9/pyheimdall_collectiveaccess-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 16:02:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyheimdall-collectiveaccess"
}
JSON