archivebox.cli.archivebox_search

Module Contents

Functions

_apply_pattern_filters
_snapshots_to_json
_snapshots_to_csv
_snapshots_to_html
get_snapshots	Filter and return Snapshots matching the given criteria.
search	List, filter, and export information about archive entries
main

Data

__command__
LINK_FILTERS
STATUS_CHOICES

API

archivebox.cli.archivebox_search.__command__

‘archivebox search’

archivebox.cli.archivebox_search.LINK_FILTERS: dict[str, collections.abc.Callable[[str], django.db.models.Q]]

None

archivebox.cli.archivebox_search.STATUS_CHOICES

[‘indexed’, ‘archived’, ‘unarchived’]

archivebox.cli.archivebox_search._apply_pattern_filters(snapshots: django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot], filter_patterns: list[str], filter_type: str) → django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot]

archivebox.cli.archivebox_search._snapshots_to_json(snapshots: django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot], *, with_headers: bool) → str

archivebox.cli.archivebox_search._snapshots_to_csv(snapshots: django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot], *, cols: list[str], with_headers: bool) → str

archivebox.cli.archivebox_search._snapshots_to_html(snapshots: django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot], *, with_headers: bool) → str

archivebox.cli.archivebox_search.get_snapshots(snapshots: django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot] | None = None, filter_patterns: list[str] | None = None, filter_type: str = 'substring', after: float | None = None, before: float | None = None, out_dir: pathlib.Path = DATA_DIR) → django.db.models.QuerySet[archivebox.core.models.Snapshot, archivebox.core.models.Snapshot]

Filter and return Snapshots matching the given criteria.

archivebox.cli.archivebox_search.search(filter_patterns: list[str] | None = None, filter_type: str = 'substring', status: str = 'indexed', before: float | None = None, after: float | None = None, sort: str | None = None, json: bool = False, html: bool = False, csv: str | None = None, with_headers: bool = False)

List, filter, and export information about archive entries

archivebox.cli.archivebox_search.main(**kwargs)