badc.data

Helpers for tracking DataLad datasets and recording connection status.

Functions

available_method([preferred])	Determine which clone method to use.
collect_dataset_statuses([show_siblings, ...])	Return registry entries annotated with filesystem information.
connect_dataset(spec, target_dir, *[, ...])	Clone or refresh spec into target_dir and record it.
disconnect_dataset(name, dataset_path, *, ...)	Mark a dataset as disconnected and optionally delete its files.
find_dataset_root(path)	Walk parents until a DataLad dataset (.datalad) is located.
get_data_config_path()	Return the path to the dataset registry TOML file.
get_dataset_spec(name)	Return the built-in dataset specification for name.
list_tracked_datasets([config_path])	Return the dataset registry.
load_data_config([config_path])	Load the dataset registry (if present).
override_spec_url(spec, url)	Return a new spec with url overridden when provided.
resolve_dataset_path(name, base_path[, ...])	Resolve the expected filesystem path for name.
save_data_config(config[, config_path])	Persist the registry to disk in TOML form.

Classes

DatasetSpec(name, url[, description, ...])	Definition for a known dataset target.
DatasetStatus(name, registry_status, method, ...)	Filesystem + registry view for a tracked dataset.
SiblingInfo(name, url, push_url, here[, ...])	Description of a DataLad sibling reported by datalad siblings.