DataLad-OSF: Opening up the Open Science Framework for DataLad

Welcome! This repository contains a DataLad extension that enables DataLad to work with the Open Science Framework (OSF). Use it to share, retrieve and collaborate on DataLad datasets via the OSF.

The development of this tool started at OHBM Brainhack 2020 in June 2020, coordinated in this repository. See our documentation for more extensive information.

Requirements

Datalad: relies on git-annex, Git and Python. If you don’t have DataLad installed yet, please follow the instructions here.
Account on the Open Science Framework (OSF)

Installation

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

How to use

See our documentation for more info on how to use this tool and a tutorial on major use cases.

How to contribute

You are very welcome to help out developing this tool further. You can contribute by:

Creating an issue for bugs or tips for further development
Making a pull request for any changes suggested by yourself
Testing out the software and communicating your feedback to us

Please see our contributing guidelines for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Michael Hanke} 🚧 💻 🐛 🤔	_{Dorien Huijser} 📖 📆 🤔 📓	_{Ashish Sahoo} 📖 🚧	_{Simon Steinkamp} ⚠️ 📖 📆 🤔 📓 🚧	_{Benjamin Poldrack} 📆 🤔 💻 🚧	_Nick 📆 🤔 💻 🚧	_{Nikita Beliy} 🤔 📓
_{Moritz J. Boos} 💻 📓 🤔 🚧	_{Adina Wagner} 📆 🤔 💻 📖 🚧	_{Stefan Appelhoff} 📖 📓	_{Tom Hu} 🚇

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), and the US National Science Foundation (NSF 1912266).