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¶
|
Representation of a DataLad dataset/repository |
|
Create a new dataset from scratch. |
|
Create a dataset sibling on a UNIX-like Shell (local or SSH)-accessible machine |
|
Create dataset sibling on GitHub. |
|
Create dataset sibling at a GitLab site |
|
Drop file content from datasets |
|
Get any dataset content (files/directories/subdatasets). |
|
Install a dataset from a (remote) source. |
|
Publish a dataset to a known sibling. |
|
Remove components from datasets |
|
Save the current state of a dataset |
|
Update a dataset from a sibling. |
|
Uninstall subdatasets |
|
Unlock file(s) of a dataset |
Metadata handling¶
|
Search dataset metadata |
|
Metadata reporting for files and entire datasets |
|
Aggregate metadata of one or more datasets for later query. |
|
Run one or more of DataLad's metadata extractors on a dataset or file. |
Reproducible execution¶
|
Run an arbitrary shell command and record its impact on a dataset. |
|
Re-execute previous datalad run commands. |
|
Run prepared procedures (DataLad scripts) on a dataset |
Plumbing commands¶
|
Analyze and act upon input paths |
|
Clean up after DataLad (possible temporary files etc.) |
|
Obtain a dataset (copy) from a URL or local directory |
|
Copy files and their availability metadata from one dataset to another. |
|
Create test (meta-)dataset. |
|
Report differences between two states of a dataset (hierarchy) |
|
Download content |
|
List summary information about URLs and dataset(s) |
|
Push a dataset to a known sibling. |
|
Run command on remote machines via SSH. |
|
Manage sibling configuration |
|
Report subdatasets and their properties. |
Miscellaneous commands¶
|
Add content of an archive under git annex control. |
|
Run internal DataLad (unit)tests. |
Plugins¶
DataLad can be customized by plugins. The following plugins are shipped with DataLad.
|
Add basic information about DataLad datasets to a README file |
|
Create and update a dataset from a list of URLs. |
|
Find repository dates that are more recent than a reference date. |
|
Export the content of a dataset as a TAR/ZIP archive. |
|
Export the content of a dataset as a ZIP archive to figshare |
|
Configure a dataset to never put some content into the dataset's annex |
|
Generate a report about the DataLad installation and configuration |
Support functionality¶
Proxy basic file operations (e.g. |
|
Wrapper for command and function calls, allowing for dry runs and output handling |
|
constants for datalad |
|
Internal low-level interface to Git repositories |
|
Interface to git-annex by Joey Hess. |
|
Various handlers/functionality for different types of files (e.g. |
|
Base classes to custom git-annex remotes (e.g. |
|
Custom remote to support getting the load from archives present under annex |
Configuration management¶
Test infrastructure¶
Helper to provide heavy load on stdout and stderr |