pyheimdall-sword 0.0.1

SWORD API connector for pyHeimdall

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