archivebox.plugins.hooks

ArchiveBox adapters around the framework-free abx-dl plugin runtime.

Discovery and execution are owned by abx-dl. ArchiveBox keeps only the small Django projection adapter and its application-specific URL-output reader.

Module Contents

Functions

is_background_hook
normalize_hook_event_name
discover_hooks	Return the exact catalog hooks used by abx-dl, in execution order.
collect_urls_from_plugins	Read the durable urls.jsonl interface emitted by parser plugins.

API

archivebox.plugins.hooks.is_background_hook(hook_name: str) → bool

archivebox.plugins.hooks.normalize_hook_event_name(event_name: str) → str | None

archivebox.plugins.hooks.discover_hooks(event_name: str, filter_disabled: bool = True, config: archivebox.plugins.discovery.ConfigLookup | None = None, **config_kwargs: Any) → list[pathlib.Path]

Return the exact catalog hooks used by abx-dl, in execution order.

archivebox.plugins.hooks.collect_urls_from_plugins(snapshot_dir: pathlib.Path) → list[dict[str, Any]]

Read the durable urls.jsonl interface emitted by parser plugins.