pyheimdall


Namepyheimdall JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryHigh End Interoperability Module when Data is ALL over the place
upload_time2024-12-24 11:48:00
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseaGPL
keywords databases hera interoperability
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ##########
pyHeimdall
##########

.. image:: https://sharedocs.huma-num.fr/wl/?id=bTXaJHOJwSa2swWiqdHxHPbfqMouu38u&fmode=download
   :target: https://datasphere.readthedocs.io/projects/heimdall/en/latest/
   :width: 100%
   :align: center

.. 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/wip.svg
   :target: https://www.repostatus.org/#project-statuses
.. image:: https://img.shields.io/pypi/v/pyheimdall
   :target: https://pypi.org/project/pyheimdall/
   :alt: PyPI - Python Version
.. image:: https://img.shields.io/badge/documentation-api-green
   :target: https://datasphere.gitpages.huma-num.fr/heimdall/python/doc/

.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/python/badges/main/pipeline.svg
   :target: https://gitlab.huma-num.fr/datasphere/heimdall/python/pipelines/latest
.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/python/badges/main/coverage.svg
   :target: https://datasphere.gitpages.huma-num.fr/heimdall/python/coverage/index.html
.. image:: https://datasphere.gitpages.huma-num.fr/heimdall/python/badges/loc.svg
   :target: https://gitlab.huma-num.fr/datasphere/heimdall/python/-/tree/main/src/heimdall
.. image:: https://datasphere.gitpages.huma-num.fr/heimdall/python/badges/hoc.svg
   :target: https://www.yegor256.com/2014/11/14/hits-of-code.html

*************
What is this?
*************

Heimdall is a tool for converting more easily one or more databases from one format to another.



********************
Why should I use it?
********************

If, for example, you find yourself in one of the following situations...

- you need access to data, but it is not stored in a format compatible with your favorite software...
- you'd prefer to merge several heterogeneous databases into a single corpus, easier to analyze...
- you're considering which input format to use for your software or database...
- you want to make your data more accessible and interoperable...

... then Heimdall can offer you an exchange format, and abstract the details of data implementation: yours, but also those of others.

Thanks to Heimdall, you can also switch from one technology to another in a matter of moments, as and when you need to, without ever losing, disorganizing or corrupting your data.

In a nutshell, **HEIMDALL** is your **H**\ igh **E**\ nd **I**\ nteroperability **M**\ odule when **D**\ ata is **ALL** over the place.
It's a bridge between scattered islands of data.



*****************
How can I use it?
*****************

Setup
=====

You can install Heimdall using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:

.. code-block:: bash

   pip install pyheimdall

You can use `pip <https://pip.pypa.io/en/stable/>`_ to either upgrade or uninstall Heimdall, too:

.. code-block:: bash

   pip install --upgrade pyheimdall
   pip uninstall pyheimdall

Usage
=====

.. code-block:: python

   import heimdall

   config = {
       'format': 'sql:mysql',
       'url': 'mysql://user:password@localhost:3306/database',
   }
   tree = heimdall.getDatabase(**config)



*****************
Is it documented?
*****************

Sure!
Here's `the link <https://datasphere.gitpages.huma-num.fr/heimdall/python/doc/>`_.



*************
Is it tested?
*************

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

You can run all tests on your machine, too.
After having cloned this repository, enter it, setup your dev environment, and then:

.. code-block:: bash

   pytest



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

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

*******
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",
    "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/9e/15/6c557af13212c96171b5bbafeda4ba808659c7ca3be0013fee407b877e19/pyheimdall-1.0.0.tar.gz",
    "platform": null,
    "description": "##########\npyHeimdall\n##########\n\n.. image:: https://sharedocs.huma-num.fr/wl/?id=bTXaJHOJwSa2swWiqdHxHPbfqMouu38u&fmode=download\n   :target: https://datasphere.readthedocs.io/projects/heimdall/en/latest/\n   :width: 100%\n   :align: center\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/wip.svg\n   :target: https://www.repostatus.org/#project-statuses\n.. image:: https://img.shields.io/pypi/v/pyheimdall\n   :target: https://pypi.org/project/pyheimdall/\n   :alt: PyPI - Python Version\n.. image:: https://img.shields.io/badge/documentation-api-green\n   :target: https://datasphere.gitpages.huma-num.fr/heimdall/python/doc/\n\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/python/badges/main/pipeline.svg\n   :target: https://gitlab.huma-num.fr/datasphere/heimdall/python/pipelines/latest\n.. image:: https://gitlab.huma-num.fr/datasphere/heimdall/python/badges/main/coverage.svg\n   :target: https://datasphere.gitpages.huma-num.fr/heimdall/python/coverage/index.html\n.. image:: https://datasphere.gitpages.huma-num.fr/heimdall/python/badges/loc.svg\n   :target: https://gitlab.huma-num.fr/datasphere/heimdall/python/-/tree/main/src/heimdall\n.. image:: https://datasphere.gitpages.huma-num.fr/heimdall/python/badges/hoc.svg\n   :target: https://www.yegor256.com/2014/11/14/hits-of-code.html\n\n*************\nWhat is this?\n*************\n\nHeimdall is a tool for converting more easily one or more databases from one format to another.\n\n\n\n********************\nWhy should I use it?\n********************\n\nIf, for example, you find yourself in one of the following situations...\n\n- you need access to data, but it is not stored in a format compatible with your favorite software...\n- you'd prefer to merge several heterogeneous databases into a single corpus, easier to analyze...\n- you're considering which input format to use for your software or database...\n- you want to make your data more accessible and interoperable...\n\n... then Heimdall can offer you an exchange format, and abstract the details of data implementation: yours, but also those of others.\n\nThanks to Heimdall, you can also switch from one technology to another in a matter of moments, as and when you need to, without ever losing, disorganizing or corrupting your data.\n\nIn a nutshell, **HEIMDALL** is your **H**\\ igh **E**\\ nd **I**\\ nteroperability **M**\\ odule when **D**\\ ata is **ALL** over the place.\nIt's a bridge between scattered islands of data.\n\n\n\n*****************\nHow can I use it?\n*****************\n\nSetup\n=====\n\nYou can install Heimdall using the `pip <https://pip.pypa.io/en/stable/>`_ package manager:\n\n.. code-block:: bash\n\n   pip install pyheimdall\n\nYou can use `pip <https://pip.pypa.io/en/stable/>`_ to either upgrade or uninstall Heimdall, too:\n\n.. code-block:: bash\n\n   pip install --upgrade pyheimdall\n   pip uninstall pyheimdall\n\nUsage\n=====\n\n.. code-block:: python\n\n   import heimdall\n\n   config = {\n       'format': 'sql:mysql',\n       'url': 'mysql://user:password@localhost:3306/database',\n   }\n   tree = heimdall.getDatabase(**config)\n\n\n\n*****************\nIs it documented?\n*****************\n\nSure!\nHere's `the link <https://datasphere.gitpages.huma-num.fr/heimdall/python/doc/>`_.\n\n\n\n*************\nIs it tested?\n*************\n\nOf course!\nHere's `the coverage report <https://datasphere.gitpages.huma-num.fr/heimdall/python/coverage/index.html>`_.\n\nYou can run all tests on your machine, too.\nAfter having cloned this repository, enter it, setup your dev environment, and then:\n\n.. code-block:: bash\n\n   pytest\n\n\n\n*********************\nHow can I contribute?\n*********************\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\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": "High End Interoperability Module when Data is ALL over the place",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://gitlab.huma-num.fr/datasphere/heimdall/python/",
        "Issues": "https://gitlab.huma-num.fr/datasphere/heimdall/python/-/issues"
    },
    "split_keywords": [
        "databases",
        " hera",
        " interoperability"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0912b61d726f62f0a558da835677fcc0322d8c90ea509c719e2b11bd26602efa",
                "md5": "a29045fbe6d148a3efce1a8505756626",
                "sha256": "47c50ca75b0fe9c1fb2ea5ece8d1bd8d9db85f1e237197a208a0ae4f48583161"
            },
            "downloads": -1,
            "filename": "pyheimdall-1.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a29045fbe6d148a3efce1a8505756626",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 59506,
            "upload_time": "2024-12-24T11:47:56",
            "upload_time_iso_8601": "2024-12-24T11:47:56.865716Z",
            "url": "https://files.pythonhosted.org/packages/09/12/b61d726f62f0a558da835677fcc0322d8c90ea509c719e2b11bd26602efa/pyheimdall-1.0.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e156c557af13212c96171b5bbafeda4ba808659c7ca3be0013fee407b877e19",
                "md5": "0aaba4ac9be2286257dc1f3a6251cff5",
                "sha256": "b771e33269241ba83e28894a7a424ff119af75c5c3c7da4df202a8aedb78f5c3"
            },
            "downloads": -1,
            "filename": "pyheimdall-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0aaba4ac9be2286257dc1f3a6251cff5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 43016,
            "upload_time": "2024-12-24T11:48:00",
            "upload_time_iso_8601": "2024-12-24T11:48:00.186826Z",
            "url": "https://files.pythonhosted.org/packages/9e/15/6c557af13212c96171b5bbafeda4ba808659c7ca3be0013fee407b877e19/pyheimdall-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-24 11:48:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pyheimdall"
}
None
Elapsed time: 1.15425s