############################
Heimdall - MariaDB 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/active.svg
:target: https://www.repostatus.org/#project-statuses
.. image:: https://img.shields.io/pypi/v/pyheimdall-mariadb
:target: https://pypi.org/project/pyheimdall-mariadb/
: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/mariadb/badges/main/pipeline.svg
:target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/mariadb/pipelines/latest
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/mariadb/badges/main/coverage.svg
:target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/mariadb/coverage/index.html
*************
What is this?
*************
`pyHeimdall <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 implements a connector to retrieve data from a MariaDB database.
The implementation doesn't need any intervention on pyHeimdall proper.
*****************
How can I use it?
*****************
Setup
=====
This MariaDB pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-mariadb/>`_ named ``pyheimdall-mariadb``.
You can install it using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:
.. code-block:: bash
pip install pyheimdall-mariadb
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-mariadb
pip uninstall pyheimdall-mariadb
Usage
=====
.. code-block:: python
import heimdall
tree = heimdall.getDatabase(
format='sql:mariadb',
url='mariadb://myusername:mypassword@myhost:myport/mydatabase',
entities=('mytable', 'myothertable', ),
)
heimdall.createDatabase(tree, format='xml:hera', url='mydatabase.xml')
Please note that you don't need to use ``pyheimdall-mariadb`` 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/mariadb/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-mariadb",
"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/f1/00/0decbe21920cca3931c47ddd36e236e5961df2bc0aae7b414240a4123475/pyheimdall_mariadb-1.0.0.tar.gz",
"platform": null,
"description": "############################\nHeimdall - MariaDB 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/active.svg\n :target: https://www.repostatus.org/#project-statuses\n.. image:: https://img.shields.io/pypi/v/pyheimdall-mariadb\n :target: https://pypi.org/project/pyheimdall-mariadb/\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/mariadb/badges/main/pipeline.svg\n :target: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/mariadb/pipelines/latest\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/connectors/mariadb/badges/main/coverage.svg\n :target: https://datasphere.gitpages.huma-num.fr/heimdall/connectors/mariadb/coverage/index.html\n\n\n*************\nWhat is this?\n*************\n\n`pyHeimdall <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 implements a connector to retrieve data from a MariaDB database.\nThe implementation doesn't need any intervention on pyHeimdall proper.\n\n\n*****************\nHow can I use it?\n*****************\n\nSetup\n=====\n\nThis MariaDB pyHeimdall connector is available as a `PyPI package <https://pypi.org/project/pyheimdall-mariadb/>`_ named ``pyheimdall-mariadb``.\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-mariadb\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-mariadb\n pip uninstall pyheimdall-mariadb\n\nUsage\n=====\n\n.. code-block:: python\n\n import heimdall\n\n tree = heimdall.getDatabase(\n format='sql:mariadb',\n url='mariadb://myusername:mypassword@myhost:myport/mydatabase',\n entities=('mytable', 'myothertable', ),\n )\n heimdall.createDatabase(tree, format='xml:hera', url='mydatabase.xml')\n\nPlease note that you don't need to use ``pyheimdall-mariadb`` 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/mariadb/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\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": "MariaDB connector for pyHeimdall",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://gitlab.huma-num.fr/datasphere/heimdall/connectors/mariadb/",
"Issues": "https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues"
},
"split_keywords": [
"databases",
" hera",
" interoperability"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1a21ebae295f2f37e57215b08b8b58c13cb6728fb4b0ed02d87b4de8155c4cb6",
"md5": "2c64b48f1b501065fe800496d12395c5",
"sha256": "08bd0a87163ec39793c0f3867246060daa7725b4763f58f57ee5ab2094a0dda2"
},
"downloads": -1,
"filename": "pyheimdall_mariadb-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c64b48f1b501065fe800496d12395c5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17399,
"upload_time": "2025-01-24T13:35:10",
"upload_time_iso_8601": "2025-01-24T13:35:10.566088Z",
"url": "https://files.pythonhosted.org/packages/1a/21/ebae295f2f37e57215b08b8b58c13cb6728fb4b0ed02d87b4de8155c4cb6/pyheimdall_mariadb-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f1000decbe21920cca3931c47ddd36e236e5961df2bc0aae7b414240a4123475",
"md5": "d67470365829202d9c4277ac27c866fc",
"sha256": "d4db71585e198e0f52d85e3d5f4602072261f7637f2412c37154cb6b9cf71de7"
},
"downloads": -1,
"filename": "pyheimdall_mariadb-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d67470365829202d9c4277ac27c866fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17414,
"upload_time": "2025-01-24T13:35:13",
"upload_time_iso_8601": "2025-01-24T13:35:13.240944Z",
"url": "https://files.pythonhosted.org/packages/f1/00/0decbe21920cca3931c47ddd36e236e5961df2bc0aae7b414240a4123475/pyheimdall_mariadb-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 13:35:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyheimdall-mariadb"
}
JSON