`archivebox.cli`

Submodules

`LazySubcommands`
`NotProvided`

`wait_for_bg_threads_to_exit`	Block until the specified threads exit. e.g. pass thread_names=(‘default_hook_handler’,) to wait for webhooks. Useful for waiting for signal handlers, webhooks, etc. to finish running after a mgmt command completes.
`run_subcommand`	Run a given ArchiveBox subcommand with the given list of args
`main`

archivebox.cli.required_attrs[source]: (’package’, ‘command’, ‘main’)

class archivebox.cli.LazySubcommands[source]

Bases: collections.abc.Mapping

archivebox.cli.archive_cmds[source]: (‘add’, ‘remove’, ‘update’, ‘list’, ‘status’, ‘schedule’, ‘server’, ‘shell’, ‘manage’)

archivebox.cli.IGNORED_BG_THREADS[source]: (‘MainThread’, ‘ThreadPoolExecutor’, ‘IPythonHistorySavingThread’, ‘Scheduler’)

archivebox.cli.wait_for_bg_threads_to_exit(thread_names: Iterable[str] = (), ignore_names: Iterable[str] = IGNORED_BG_THREADS, timeout: int = 60) → int[source]: Block until the specified threads exit. e.g. pass thread_names=(‘default_hook_handler’,) to wait for webhooks. Useful for waiting for signal handlers, webhooks, etc. to finish running after a mgmt command completes.

archivebox.cli.run_subcommand(subcommand: str, subcommand_args: List[str] | None = None, stdin: Optional[IO] = None, pwd: Union[pathlib.Path, str, None] = None) → None[source]: Run a given ArchiveBox subcommand with the given list of args

class archivebox.cli.NotProvided[source]

archivebox.cli.main(args: List[str] | archivebox.cli.Omitted = OMITTED, stdin: IO | archivebox.cli.Omitted = OMITTED, pwd: str | None = None) → None[source]