Skip to main content

High End Interoperability Module when Data is ALL over the place

Project description

https://gitlab.huma-num.fr/datasphere/doc/assets/-/raw/main/banners/HEIMDALL.png License Project status PyPI - Python Version GitLab - Latest release Digital Object Identifier (DOI) API Documentation Build status Code coverage Open Source Security Foundation (OpenSSF) best practices badge

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 High End Interoperability Module when Data 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 package manager:

pip install pyheimdall

You can use pip to either upgrade or uninstall Heimdall, too:

pip install --upgrade pyheimdall
pip uninstall pyheimdall

Usage

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.

Is it tested?

Of course! Here’s the coverage report.

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

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

Acknowledgments

Heimdall would like to thank all its contributors and users for their support and feedback. ʕᵔᴥᵔʔ

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyheimdall-1.1.1.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

pyheimdall-1.1.1-py2.py3-none-any.whl (61.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pyheimdall-1.1.1.tar.gz.

File metadata

  • Download URL: pyheimdall-1.1.1.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for pyheimdall-1.1.1.tar.gz
Algorithm Hash digest
SHA256 57e00034de0a86014a69433694a71637c72aeb35a2cb503272f5bb53991b38de
MD5 5a0722369e192147c3261a59bd9d4627
BLAKE2b-256 fb53ac7d0094e3773e0af197248555801b954678147db9c7243756c0b916676a

See more details on using hashes here.

File details

Details for the file pyheimdall-1.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pyheimdall-1.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 61.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for pyheimdall-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 75706fdacde6899bb092079f75cdd8c98762c402eae8de9259d2c97064a82f2c
MD5 5f1d66e2a58d4b82a65a0aec887301a5
BLAKE2b-256 6f8a9d9e23cbdaf7562a456b6f094073a1c7166f8f3d41e638df45012c9e83ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page