Skip to main content

DataLad extension to deposit datasets on Dataverse

Project description

DataLad extension for working Dataverse

Build status codecov Documentation Status License: MIT GitHub release PyPI version fury.io

All Contributors

Dataverse is open source research data repository software that is deployed all over the world as data or metadata repositories. It supports sharing, preserving, citing, exploring, and analyzing research data with descriptive metadata, and thus contributes greatly to open, reproducible, and FAIR science. DataLad, on the other hand, is a data management and data publication tool build on Git and git-annex. Its core data structure, DataLad datasets, can version control files of any size, and streamline data sharing, updating, and collaboration. This DataLad extension package provides interoperablity with Dataverse to support dataset transport to and from Dataverse instances.

Installation

# create and enter a new virtual environment (optional)
$ virtualenv --python=python3 ~/env/dl-dataverse
$ . ~/env/dl-dataverse/bin/activate
# install from PyPi
$ python -m pip install datalad-dataverse

How to use

Additional commands provided by this extension are immediately available after installation. However, in order to fully benefit from all improvements, the extension has to be enabled for auto-loading by executing:

git config --global --add datalad.extensions.load dataverse

Doing so will enable the extension to also alter the behavior the core DataLad package and its commands, from example to be able to directly clone from a Dataverse dataset landing page.

Full-compatibility with Windows requires a git-annex installation of version 10.20230321 (or later).

Summary of functionality provided by this extension

  • Interoperability between DataLad and Dataverse version 5 (or later).
  • A add-sibling-dataverse command to register a Dataverse dataset as remote sibling for a DataLad dataset.
  • A git-annex-remote-dataverse special remote implementation for storage and retrieval of data in Dataverse dataset via git-annex.
  • These two features combined enable the deposition and retrieveal of complete DataLad dataset on Dataverse, including version history and metadata. A direct datalad clone from a Dataverse dataset landing page is supported, and yields a fully functional DataLad dataset clone (Git repository).

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Johanna Bayer
Johanna Bayer

📖
Nadine Spychala
Nadine Spychala

🚇 📖
Benjamin Poldrack
Benjamin Poldrack

🚇 💻 📖 🚧 👀 🤔 🔧
Adina Wagner
Adina Wagner

💻 🤔 🚇 📖 🚧 👀
Michael Hanke
Michael Hanke

💻 🤔 🚧 🚇 👀 🔧
enicolaisen
enicolaisen

📖
Roza
Roza

📖
Kelvin Sarink
Kelvin Sarink

💻
Jan Ernsting
Jan Ernsting

💻
Chris Markiewicz
Chris Markiewicz

💻
Alex Waite
Alex Waite

🚇 💻 🚧 🔧
Shammi270787
Shammi270787

💻
Wu Jianxiao
Wu Jianxiao

💻 👀 📓
Laura Waite
Laura Waite

📖
Michał Szczepanik
Michał Szczepanik

🚇
Benedikt Ehinger
Benedikt Ehinger

🐛 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Acknowledgements

This DataLad extension was developed with support from the German Federal Ministry of Education and Research (BMBF 01GQ1905), the US National Science Foundation (NSF 1912266), the Helmholtz research center Jülich (RDM challenge 2022), and the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451 (431549029, INF project).

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

datalad_dataverse-1.0.3-py3-none-any.whl (45.8 kB view details)

Uploaded Python 3

File details

Details for the file datalad_dataverse-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for datalad_dataverse-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fd0c5d835c251b643fbc31fcf3258bbb858864debb64e095a0ff2d90e040e47f
MD5 1a5aa88b4dd331c9ac533c791bc43e1b
BLAKE2b-256 5b6964f7bc87807ea738f9896c772ede72e6d2537a156c81199d98a5b8ba82b1

See more details on using hashes here.

Supported by

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