hats.io.summary_file

Functions

generate_summary(→ str)	Generate summary content for any HATS catalog or collection.
write_catalog_summary_file(→ upath.UPath)	Write a summary readme file for any HATS catalog or collection

Module Contents

generate_summary(catalog, *, fmt: Literal['markdown', 'html'], name: str, description: str, uri: str | None, huggingface_metadata: bool, jinja2_template: str | None = None) → str

Generate summary content for any HATS catalog or collection.

write_catalog_summary_file(catalog_path: str | pathlib.Path | upath.UPath, *, fmt: Literal['markdown', 'html'], filename: str | None = None, output_dir: str | pathlib.Path | upath.UPath | None = None, name: str | None = None, description: str | None = None, uri: str | None = None, huggingface_metadata: bool = False, jinja2_template: str | None = None) → upath.UPath

Write a summary readme file for any HATS catalog or collection