some default

Adina Wagner 1b9fd861ea CI: add missing dependency as reported on appveyor 9 months ago
.github 5386b40f2f Merge pull request #1022 from yarikoptic/enh-codespell 1 year ago
artwork 521e797350 Transition handbook links to `https` 1 year ago
dataladhandbook_support d13da4ef0b make glossary entry on paths also work for windows 1 year ago
docs d4a4172ded Fix current linkcheck failures 9 months ago
tools b8473cf84c Merge branch 'main' of github.com:datalad-handbook/book into main-transition 1 year ago
.all-contributorsrc d4005d2070 add tosca's real name 10 months ago
.appveyor.yml 1b9fd861ea CI: add missing dependency as reported on appveyor 9 months ago
.gitattributes d4672a9ef0 Modernize versioning setup. 5 years ago
.gitignore 3ee8f52f84 git ignore venvs 1 year ago
.gitmodules 6b2c58419b Link artwork dataset 5 years ago
.readthedocs.yml f8fe083896 Declare / update RTD build environment 1 year ago
.travis.yml 6b206b0367 Consolidate link URLs throughout the handbook 1 year ago
.zenodo.json 62eb4c472b Add Tosca as contributor to the zenodo file 10 months ago
CHANGELOG.md 7b6be49896 Typo: usecase -> use case 1 year ago
CODE_OF_CONDUCT.md 52d488d1d4 Create CODE_OF_CONDUCT.md 5 years ago
CONTRIBUTORS.md 6b206b0367 Consolidate link URLs throughout the handbook 1 year ago
LICENSE d8ee43ec6a declare CC-BY-SA 5 years ago
MANIFEST.in d4672a9ef0 Modernize versioning setup. 5 years ago
Makefile 1e30157faa Make better use of make itself 1 year ago
README.md 34f170be43 docs: update README.md [skip ci] 10 months ago
pyproject.toml 7bab722fae Propagate the desired skips into the config 1 year ago
requirements-devel.txt 8de15ab34a updates related to bug fix and UI changes in datalad-catalog v1.1.1 10 months ago
requirements.txt b068f7439d Remove Jinja2 version pinning 9 months ago
setup.cfg 47b09ca6e5 Revert even more setup.cfg setup to get readthedocs to install deps 5 years ago
setup.py de746e85d6 Add alabaster theme to setup.py with minimal version of 0.7.11 for show_relbar 4 years ago
versioneer.py 62c921adf6 re-run -> rerun 1 year ago

README.md

Build status Monthly link check Documentation Status DOI made-with-datalad All Contributors

The DataLad handbook :orange_book:

This is a living resource on why and - more importantly - how to use DataLad. The rendered version is here: https://handbook.datalad.org, and is currently under initial development.

The handbook is a practical, hands-on crashcourse to learn and experience DataLad. You do not need to be a programmer, computer scientist, or Linux-crank. If you have never touched your computer's shell before, you will be fine. Regardless of your background and personal use cases for DataLad, the handbook will show you the principles of DataLad, and from chapter 1 onwards you will be using them.

Find more general information about the idea behind the handbook in the poster presented at the 2020 OHBM or dive straight into your DataLad adventure.

Contributing

Contributions in any form - pull requests, issues, content requests/ideas, ... are always welcome. If you are using the handbook and find that something does not work, please let us know. Likewise, if you are using DataLad for your individual project, consider contributing by telling us about your use-case. You can find out more on how to contribute here, and a list of all contributors so far below, in CONTRIBUTORS.md, and in .zenodo.json.

Notes for Instructors

The book is the basis for workshops and lectures on DataLad and data management. The handbook's course repository among other things contains live casts from the code examples in this book and slides. It is constantly growing, and everyone is free to use the material under the license terms below. Contributions and feedback are very welcome.

License

CC-BY-SA: You are free to

  • share - copy and redistribute the material in any medium or format
  • adapt - remix, transform, and build upon the material for any purpose, even commercially

under the following terms:

1) Attribution โ€” You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

2) ShareAlike โ€” If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

Adina S. Wagner
Adina S. Wagner

๐Ÿ’ป ๐Ÿ–‹ ๐Ÿ“– ๐ŸŽจ ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ“† ๐Ÿ‘€ ๐Ÿ““ ๐Ÿ“ข โš ๏ธ ๐Ÿ› ๐Ÿ’ก ๐Ÿ’ฌ ๏ธ๏ธ๏ธ๏ธโ™ฟ๏ธ
Laura Waite
Laura Waite

๐Ÿค” ๐Ÿšง ๐Ÿ‘€ ๐Ÿ“ข ๐Ÿ’ฌ ๐Ÿ–‹
Michael Hanke
Michael Hanke

๐Ÿ’ฌ ๐Ÿ› ๐Ÿ’ป ๐Ÿ–‹ ๐Ÿ“– ๐ŸŽจ ๐Ÿ’ก ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ”Œ ๐Ÿ“† ๐Ÿ‘€ ๐Ÿ”ง โš ๏ธ ๐Ÿ“ข ๐Ÿ““ ๏ธ๏ธ๏ธ๏ธโ™ฟ๏ธ
Kyle Meyer
Kyle Meyer

๐Ÿ› ๐Ÿ‘€ ๐Ÿ’ฌ ๐Ÿ–‹ ๐Ÿค”
Marisa Heckner
Marisa Heckner

๐Ÿค” ๐Ÿ““ ๐Ÿ› ๐Ÿ–‹
Benjamin Poldrack
Benjamin Poldrack

๐Ÿ’ฌ ๐Ÿค” ๐Ÿ’ก โœ…
Yaroslav Halchenko
Yaroslav Halchenko

๐Ÿ‘€ ๐Ÿ–‹ ๐Ÿค” ๐Ÿ›
Chris Markiewicz
Chris Markiewicz

๐Ÿ›
Pattarawat Chormai
Pattarawat Chormai

๐Ÿ› ๐Ÿ’ป
Lisa N. Mochalski
Lisa N. Mochalski

๐Ÿ› ๐Ÿ–‹ ๐Ÿ’ก ๐Ÿค”
Lisa Wiersch
Lisa Wiersch

๐Ÿ›
Jean-Baptiste Poline
Jean-Baptiste Poline

๐Ÿ–‹
Nevena Kraljevic
Nevena Kraljevic

๐Ÿ““
Alex Waite
Alex Waite

๐Ÿ‘€ ๐Ÿ› ๐Ÿค”
Lya K. Paas
Lya K. Paas

๐Ÿ› ๐Ÿ’ป
Niels Reuter
Niels Reuter

๐Ÿ–‹
Peter Vavra
Peter Vavra

๐Ÿค” ๐Ÿ““
Tobias Kadelka
Tobias Kadelka

๐Ÿ““
Peer Herholz
Peer Herholz

๐Ÿค”
Alexandre Hutton
Alexandre Hutton

๐Ÿ–‹ ๐Ÿ›
Sarah Oliveira
Sarah Oliveira

๐Ÿ‘€ ๐Ÿค”
Dorian Pustina
Dorian Pustina

๐Ÿค”
Hamzah Hamid Baagil
Hamzah Hamid Baagil

๐Ÿ““ ๐Ÿ›
Tristan Glatard
Tristan Glatard

๐Ÿ› ๐Ÿ–‹
Giulia Ippoliti
Giulia Ippoliti

๐Ÿ–‹ ๐Ÿ’ก
Christian Mรถnch
Christian Mรถnch

๐Ÿ–‹
Togaru Surya Teja
Togaru Surya Teja

๐Ÿ–‹
Dorien Huijser
Dorien Huijser

๐Ÿ› ๐Ÿ““
Ariel Rokem
Ariel Rokem

๐Ÿ›
Remi Gau
Remi Gau

๐Ÿ› ๐Ÿค” ๐Ÿšง ๐Ÿ‘€ ๐Ÿš‡ ๐Ÿ’ป ๐ŸŽจ
Judith Bomba
Judith Bomba

๐Ÿ›
Konrad Hinsen
Konrad Hinsen

๐Ÿ›
Wu Jianxiao
Wu Jianxiao

๐Ÿ›
Maล‚gorzata Wierzba
Maล‚gorzata Wierzba

๐Ÿ““ ๐Ÿ‘€ โœ…
Stefan Appelhoff
Stefan Appelhoff

๐Ÿš‡ ๐Ÿ”ง ๐Ÿ›
Michael Joseph
Michael Joseph

๐Ÿค” ๐Ÿ–‹ ๐Ÿ›
Tamara Cook
Tamara Cook

๐Ÿ‘€ ๐Ÿš‡
Stephan Heunis
Stephan Heunis

๐Ÿ› ๐Ÿšง ๐Ÿ–‹ ๐Ÿ’ก ๐Ÿ‘€
Joerg Stadler
Joerg Stadler

๐Ÿ›
Sin Kim
Sin Kim

๐Ÿ› ๐Ÿ–‹ ๐Ÿ‘€
Oscar Esteban
Oscar Esteban

๐Ÿ›
Michaล‚ Szczepanik
Michaล‚ Szczepanik

๐Ÿ‘€ ๐Ÿ› ๐Ÿ–‹
eort
eort

๐Ÿ›
Myrskyta
Myrskyta

๐Ÿ›
Thomas Guiot
Thomas Guiot

๐Ÿ›
jhpb7
jhpb7

๐Ÿ›
Ikko Ashimine
Ikko Ashimine

๐Ÿ›
Arshitha Basavaraj
Arshitha Basavaraj

๐Ÿ–‹ ๐Ÿ› ๐Ÿšง
Anthony J Veltri
Anthony J Veltri

๐Ÿ““
Isil Bilgin
Isil Bilgin

๐Ÿ› ๐Ÿšง
Julian Kosciessa
Julian Kosciessa

๐Ÿ–‹
Isaac To
Isaac To

๐Ÿšง ๐Ÿ–‹ ๐Ÿ›
Austin Macdonald
Austin Macdonald

๐Ÿ›
Christopher S. Hall
Christopher S. Hall

๐Ÿ›
jcf2
jcf2

๐Ÿ›
Julien Colomb
Julien Colomb

๐Ÿ–‹
Danny Garside
Danny Garside

๐Ÿ› ๐Ÿšง
Justus Kuhlmann
Justus Kuhlmann

๐Ÿ–‹
melanieganz
melanieganz

๐Ÿ›
Damien Franรงois
Damien Franรงois

๐Ÿ› ๐Ÿ–‹
tmheunis
tmheunis

๐Ÿ› ๐Ÿ““

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