archivebox.api.v1_cli

Module Contents

Classes

CLICommandResponseSchema

AddCommandSchema

SnapshotFilterCommandSchema

UpdateCommandSchema

ScheduleCommandSchema

ListCommandSchema

RemoveCommandSchema

Functions

snapshot_filter_kwargs

cli_add

cli_update

cli_schedule

cli_search

cli_remove

Data

router

JSONType

FILTER_PATTERNS_EXAMPLES

FilterTypeChoices

API

archivebox.api.v1_cli.router[source]

β€˜Router(…)’

archivebox.api.v1_cli.JSONType[source]

None

archivebox.api.v1_cli.FILTER_PATTERNS_EXAMPLES[source]

[[’https://example.com’]]

class archivebox.api.v1_cli.CLICommandResponseSchema[source]

Bases: ninja.Schema

success: bool[source]

None

errors: list[str][source]

None

result: archivebox.api.v1_cli.JSONType[source]

None

result_format: str[source]

β€˜str’

stdout: str[source]

None

stderr: str[source]

None

archivebox.api.v1_cli.FilterTypeChoices[source]

β€˜Enum(…)’

class archivebox.api.v1_cli.AddCommandSchema[source]

Bases: ninja.Schema

urls: list[str][source]

None

snapshot_ids: list[str] | None[source]

None

tag: str = <Multiline-String>[source]
depth: int[source]

0

max_urls: int[source]

0

crawl_max_size: int[source]

0

crawl_timeout: int[source]

0

snapshot_max_size: int[source]

0

parser: str[source]

β€˜auto’

plugins: str = <Multiline-String>[source]
only_new: bool | None[source]

None

update: bool[source]

False

overwrite: bool[source]

False

index_only: bool[source]

False

class archivebox.api.v1_cli.SnapshotFilterCommandSchema[source]

Bases: ninja.Schema

after: float | None[source]

0

before: float | None[source]

None

filter_type: str | None[source]

None

filter_patterns: list[str] | None[source]

β€˜Field(…)’

status: str | None[source]

None

url__icontains: str | None[source]

None

url__istartswith: str | None[source]

None

tag: str | None[source]

None

crawl_id: str | None[source]

None

limit: int | None[source]

None

sort: str | None[source]

None

search: str | None[source]

None

class archivebox.api.v1_cli.UpdateCommandSchema[source]

Bases: archivebox.api.v1_cli.SnapshotFilterCommandSchema

resume: str | None[source]

None

batch_size: int[source]

100

continuous: bool[source]

False

index_only: bool[source]

False

migrate_only: bool[source]

False

class archivebox.api.v1_cli.ScheduleCommandSchema[source]

Bases: ninja.Schema

import_path: str | None[source]

None

add: bool[source]

False

show: bool[source]

False

foreground: bool[source]

False

run_all: bool[source]

False

quiet: bool[source]

False

every: str | None[source]

None

tag: str = <Multiline-String>[source]
depth: int[source]

0

only_new: bool | None[source]

None

update: bool[source]

False

overwrite: bool[source]

False

clear: bool[source]

False

class archivebox.api.v1_cli.ListCommandSchema[source]

Bases: archivebox.api.v1_cli.SnapshotFilterCommandSchema

as_json: bool[source]

True

as_html: bool[source]

False

as_csv: str | None[source]

β€˜timestamp,url’

with_headers: bool[source]

False

class archivebox.api.v1_cli.RemoveCommandSchema[source]

Bases: archivebox.api.v1_cli.SnapshotFilterCommandSchema

filter_type: str[source]

None

timeout: float[source]

60.0

archivebox.api.v1_cli.snapshot_filter_kwargs(args: archivebox.api.v1_cli.SnapshotFilterCommandSchema, *, default_filter_type: str) → dict[str, Any][source]
archivebox.api.v1_cli.cli_add(request: django.http.HttpRequest, args: archivebox.api.v1_cli.AddCommandSchema)[source]
archivebox.api.v1_cli.cli_update(request: django.http.HttpRequest, args: archivebox.api.v1_cli.UpdateCommandSchema)[source]
archivebox.api.v1_cli.cli_schedule(request: django.http.HttpRequest, args: archivebox.api.v1_cli.ScheduleCommandSchema)[source]
archivebox.api.v1_cli.cli_remove(request: django.http.HttpRequest, args: archivebox.api.v1_cli.RemoveCommandSchema)[source]