archivebox.api.v1_cli
Module Contents
Classes
Functions
Data
API
- archivebox.api.v1_cli.__package__
‘archivebox.api’
- archivebox.api.v1_cli.router
‘Router(…)’
- archivebox.api.v1_cli.JSONType
None
- class archivebox.api.v1_cli.CLICommandResponseSchema
Bases:
ninja.Schema
- success: bool
None
- errors: List[str]
None
- result: archivebox.api.v1_cli.JSONType
None
- stdout: str
None
- stderr: str
None
- class archivebox.api.v1_cli.FilterTypeChoices
Bases:
str
,enum.Enum
- exact
‘exact’
- substring
‘substring’
- regex
‘regex’
- domain
‘domain’
- tag
‘tag’
- timestamp
‘timestamp’
- class archivebox.api.v1_cli.StatusChoices
Bases:
str
,enum.Enum
- indexed
‘indexed’
- archived
‘archived’
- unarchived
‘unarchived’
- present
‘present’
- valid
‘valid’
- invalid
‘invalid’
- duplicate
‘duplicate’
- orphaned
‘orphaned’
- corrupted
‘corrupted’
- unrecognized
‘unrecognized’
- class archivebox.api.v1_cli.AddCommandSchema
Bases:
ninja.Schema
- urls: List[str]
None
- tag: str = <Multiline-String>
- depth: int
0
- update: bool
None
- update_all: bool
False
- index_only: bool
False
- overwrite: bool
False
- init: bool
False
- extractors: str = <Multiline-String>
- parser: str
‘auto’
- class archivebox.api.v1_cli.UpdateCommandSchema
Bases:
ninja.Schema
- resume: Optional[float]
0
- only_new: bool
None
- index_only: bool
False
- overwrite: bool
False
- after: Optional[float]
0
- before: Optional[float]
999999999999999
- status: Optional[archivebox.api.v1_cli.StatusChoices]
None
- filter_type: Optional[str]
None
- filter_patterns: Optional[List[str]]
- extractors: Optional[str] = <Multiline-String>
- class archivebox.api.v1_cli.ScheduleCommandSchema
Bases:
ninja.Schema
- import_path: Optional[str]
None
- add: bool
False
- every: Optional[str]
None
- tag: str = <Multiline-String>
- depth: int
0
- overwrite: bool
False
- update: bool
None
- clear: bool
False
- class archivebox.api.v1_cli.ListCommandSchema
Bases:
ninja.Schema
- filter_patterns: Optional[List[str]]
- filter_type: str
None
- status: Optional[archivebox.api.v1_cli.StatusChoices]
None
- after: Optional[float]
0
- before: Optional[float]
999999999999999
- sort: str
‘bookmarked_at’
- as_json: bool
True
- as_html: bool
False
- as_csv: str | bool
‘timestamp,url’
- with_headers: bool
False
- class archivebox.api.v1_cli.RemoveCommandSchema
Bases:
ninja.Schema
- delete: bool
True
- after: Optional[float]
0
- before: Optional[float]
999999999999999
- filter_type: str
None
- filter_patterns: Optional[List[str]]
- archivebox.api.v1_cli.cli_add(request, args: archivebox.api.v1_cli.AddCommandSchema)
- archivebox.api.v1_cli.cli_update(request, args: archivebox.api.v1_cli.UpdateCommandSchema)
- archivebox.api.v1_cli.cli_schedule(request, args: archivebox.api.v1_cli.ScheduleCommandSchema)
- archivebox.api.v1_cli.cli_list(request, args: archivebox.api.v1_cli.ListCommandSchema)
- archivebox.api.v1_cli.cli_remove(request, args: archivebox.api.v1_cli.RemoveCommandSchema)