Skip to main content
https://img.shields.io/badge/license-AGPL3.0-informational?logo=gnu&color=success https://www.repostatus.org/badges/latest/inactive.svg PyPI Version https://img.shields.io/badge/documentation-api-green https://gitlab.huma-num.fr/datasphere/heimdall/connectors/sword/badges/main/pipeline.svg https://gitlab.huma-num.fr/datasphere/heimdall/connectors/sword/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 SWORD API endpoints.

Why should I use it?

You can use this connector, along with the pyheimdall software, to retrieve any data from SWORD endpoints, like Dataverse and derivates (_eg._ Recherche Data Gouv) or arXiv and derivates. 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 some SWORD servers.
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 SWORD pyHeimdall connector is available as a PyPI package named pyheimdall-sword. You can install it using the pip package manager:

pip install pyheimdall-sword

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

pip install --upgrade pyheimdall-sword
pip uninstall pyheimdall-sword

Usage

import heimdall

tree = heimdall.getDatabase(url, format='sword:api')

Please note that you don’t need to use pyheimdall-sword 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-sword 0.0.1

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-sword 0.0.1
File Size Uploaded
pyheimdall_sword-0.0.1.tar.gz 19.1 kB Details

Built distribution (wheel)

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

Total release size: 39.4 kB

Release files / pyheimdall_sword-0.0.1.tar.gz

Download URL pyheimdall_sword-0.0.1.tar.gz
Size 19.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d6e3163b3363534e883081e44276bdd5c20a66289e4c58e4c25aec9a261ad620
BLAKE2b-256 checksum
How to use checksums
ca90805e110530995b9504250a56b35bf3068d82a230cb364782842c71461978
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.11

Release files / pyheimdall_sword-0.0.1-py2.py3-none-any.whl

Download URL pyheimdall_sword-0.0.1-py2.py3-none-any.whl
Size 20.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
13ee06d950dd25f56eac51032fa95e3300e7ea55a02e4e38038df53c7188c161
BLAKE2b-256 checksum
How to use checksums
d3e9297d67d318b45f4de897ee5d5d03f9a1b5a840f89d81e3bb48f1562772f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.11

Release history Release notifications | RSS feed

This release

0.0.1 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