Skip to main content

Heimdall - Opentheso connector

https://img.shields.io/badge/license-AGPL3.0-informational?logo=gnu&color=success https://www.repostatus.org/badges/latest/wip.svg PyPI Version https://img.shields.io/badge/documentation-api-green https://gitlab.huma-num.fr/datasphere/heimdall/connectors/opentheso/badges/main/pipeline.svg https://gitlab.huma-num.fr/datasphere/heimdall/connectors/opentheso/badges/main/coverage.svg

What is this?

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.

Why should I use it?

You can use this connector, along with the pyheimdall software, to retrieve any data from Opentheso. 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 Opentheso.
Plus, if at the end of your project, you share your data, please cite the original data properly.

How can I use it?

Setup

This Opentheso pyHeimdall connector is available as a PyPI package named pyheimdall-opentheso. You can install it using the pip package manager:

pip install pyheimdall-opentheso

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

pip install --upgrade pyheimdall-opentheso
pip uninstall pyheimdall-opentheso

Usage

import heimdall

tree = heimdall.getDatabase(
        format='api:opentheso',
        url='https://pactols.frantiq.fr/api/',
        naan='26678',
        ark: 'pcrtuxpF5YgM3S',
    )

Please note that you don’t need to use pyheimdall-opentheso 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 or external connector.

Is it tested?

Of course! Here’s the coverage report.

How can I contribute?

PyHeimdall welcomes any feedback or proposal. Details can be accessed here

License

GNU Affero General Public License version 3.0 or later

Metadata

Release files for pyheimdall-opentheso 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyheimdall-opentheso 0.2.0
File Size Uploaded
pyheimdall_opentheso-0.2.0.tar.gz 17.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyheimdall-opentheso 0.2.0
File Interpreter ABI Platform
pyheimdall_opentheso-0.2.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 34.8 kB

Release files / pyheimdall_opentheso-0.2.0.tar.gz

Download URL pyheimdall_opentheso-0.2.0.tar.gz
Size 17.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0aee5c3a59e75a3f8e940f00f10c93c07038b7acc78bb6ace63956849d99adc1
BLAKE2b-256 checksum
How to use checksums
b2dd2808eae955aba696b1266bf7c45c7f8ca2b153fb83ee1179b31d0d67b639
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / pyheimdall_opentheso-0.2.0-py2.py3-none-any.whl

Download URL pyheimdall_opentheso-0.2.0-py2.py3-none-any.whl
Size 17.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7d11e6ff6cb928e6c231fb5e3d0ec6c02947dc5bcd4ccb3cab283750dc5cdeea
BLAKE2b-256 checksum
How to use checksums
3eba1d369ef43fbc8cae0fa4b88f6a47b13681a67661471bf62e9cc0eabc92f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page