archivebox.api.v1_cli

Module Contents

Classes

CLICommandResponseSchema

FilterTypeChoices

StatusChoices

AddCommandSchema

UpdateCommandSchema

ScheduleCommandSchema

ListCommandSchema

RemoveCommandSchema

Functions

cli_add

cli_update

cli_schedule

cli_search

cli_remove

Data

router

JSONType

API

archivebox.api.v1_cli.router[source]

‘Router(…)’

archivebox.api.v1_cli.JSONType[source]

None

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

class archivebox.api.v1_cli.FilterTypeChoices[source]

Bases: str, enum.Enum

exact[source]

‘exact’

substring[source]

‘substring’

regex[source]

‘regex’

domain[source]

‘domain’

tag[source]

‘tag’

timestamp[source]

‘timestamp’

class archivebox.api.v1_cli.StatusChoices[source]

Bases: str, enum.Enum

indexed[source]

‘indexed’

archived[source]

‘archived’

unarchived[source]

‘unarchived’

present[source]

‘present’

valid[source]

‘valid’

invalid[source]

‘invalid’

duplicate[source]

‘duplicate’

orphaned[source]

‘orphaned’

corrupted[source]

‘corrupted’

unrecognized[source]

‘unrecognized’

class archivebox.api.v1_cli.AddCommandSchema[source]

Bases: ninja.Schema

urls: list[str][source]

None

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

0

parser: str[source]

‘auto’

plugins: str = <Multiline-String>[source]
update: bool[source]

None

overwrite: bool[source]

False

index_only: bool[source]

False

class archivebox.api.v1_cli.UpdateCommandSchema[source]

Bases: ninja.Schema

resume: str | None[source]

None

after: float | None[source]

0

before: float | None[source]

999999999999999

filter_type: str | None[source]

None

filter_patterns: list[str] | None[source]

[’https://example.com’]

batch_size: int[source]

100

continuous: 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

overwrite: bool[source]

False

update: bool[source]

None

clear: bool[source]

False

class archivebox.api.v1_cli.ListCommandSchema[source]

Bases: ninja.Schema

filter_patterns: list[str] | None[source]

[’https://example.com’]

filter_type: str[source]

None

status: archivebox.api.v1_cli.StatusChoices[source]

None

after: float | None[source]

0

before: float | None[source]

999999999999999

sort: str[source]

‘bookmarked_at’

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: ninja.Schema

delete: bool[source]

True

after: float | None[source]

0

before: float | None[source]

999999999999999

filter_type: str[source]

None

filter_patterns: list[str] | None[source]

[’https://example.com’]

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]