Debian Codegraph @

docs/source/modref.rst

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