1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
.. -*- mode: rst -*-
.. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79:
.. _chap_modref:
***********************
Python module reference
***********************
This module reference extends the manual with a comprehensive overview of the
available functionality built into datalad. Each module in the package is
documented by a general summary of its purpose and the list of classes and
functions it provides.
High-level user interface
=========================
Dataset operations
------------------
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
api.Dataset
api.create
api.create_sibling
api.create_sibling_github
api.create_sibling_gitlab
api.create_sibling_gogs
api.create_sibling_gitea
api.create_sibling_gin
api.create_sibling_ria
api.drop
api.get
api.install
api.push
api.remove
api.save
api.status
api.update
api.unlock
Reproducible execution
----------------------
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
api.run
api.rerun
api.run_procedure
Plumbing commands
-----------------
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
api.clean
api.clone
api.copy_file
api.create_test_dataset
api.diff
api.download_url
api.foreach_dataset
api.siblings
api.sshrun
api.subdatasets
Miscellaneous commands
----------------------
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
api.add_archive_content
api.add_readme
api.addurls
api.check_dates
api.configuration
api.export_archive
api.export_archive_ora
api.export_to_figshare
api.no_annex
api.shell_completion
api.wtf
Support functionality
=====================
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
cmd
consts
log
utils
version
support.gitrepo
support.annexrepo
support.archives
support.extensions
customremotes.base
customremotes.archives
runner.nonasyncrunner
runner.protocol
Configuration management
========================
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
config
Test infrastructure
===================
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
tests.utils_pytest
tests.utils_testrepos
tests.heavyoutput
Command interface
=================
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
interface.base
Command line interface infrastructure
=====================================
.. currentmodule:: datalad
.. autosummary::
:toctree: generated
cli.exec
cli.main
cli.parser
cli.renderer
|
