Skip to content

API reference

The public API is exposed at the package top level:

from fwl_io import (
    create_fetcher, Fetcher,            # fetching
    load_manifest, discover_manifests,  # manifests
    fetch_for, Dataset,
    check_for, check_dataset,           # validate-only checking
    relocate_all, plan_relocations,         # moving a legacy tree into the current layout
    CheckReport, DatasetCheck, FileCheck,
    resolve_data_root, resolve_cache_root,
    DownloadError, OfflineDataError, MissingDataRootError,
    ManifestSchemaError,
)

Per-module reference pages:

  • Fetching: Fetcher, create_fetcher, error types
  • Checking: check_for, check_dataset, CheckReport, DatasetCheck, FileCheck
  • Relocating: relocate_all, plan_relocations, RelocationReport, Relocation
  • Manifests: Dataset, load_manifest, discover_manifests, fetch_for, ManifestSchemaError
  • Registries: registry file reading and writing
  • Sync: registry generation from the Zenodo API
  • Paths: data root, shared cache, offline mode