smftools.informatics.sidecar_manifest

Functions

register_sidecar(manifest_path, key, ...[, ...])	Register or update one sidecar entry in the manifest JSON file.
resolve_sidecar(manifest_path, key)	Resolve a sidecar path from manifest by key, returning existing path only.
sidecar_manifest_path(output_dir)	Return canonical sidecar manifest path for a load output directory.

smftools.informatics.sidecar_manifest.sidecar_manifest_path(output_dir)

Return canonical sidecar manifest path for a load output directory.

Return type:

Path

smftools.informatics.sidecar_manifest.register_sidecar(manifest_path, key, sidecar_path, *, metadata=None)

Register or update one sidecar entry in the manifest JSON file.

Return type:

Path

smftools.informatics.sidecar_manifest.resolve_sidecar(manifest_path, key)

Resolve a sidecar path from manifest by key, returning existing path only.

Return type:

Optional[Path]