archivebox.misc.checks

Module Contents

Functions

_migration_interrupt_message

_exit_on_migration_interrupt

check_data_folder

check_migrations

check_io_encoding

check_not_root

check_not_inside_source_dir

Prevent running ArchiveBox from inside its source directory (would pollute repo with data files).

check_data_dir_permissions

check_tmp_dir

check_lib_dir

API

archivebox.misc.checks._migration_interrupt_message(*, before_apply: bool = False) str[source]
archivebox.misc.checks._exit_on_migration_interrupt()[source]
archivebox.misc.checks.check_data_folder(config=None, **config_kwargs) None[source]
archivebox.misc.checks.check_migrations(*, blocking: bool = True, auto_apply: bool = False, cancel_delay: int = 3) list[str][source]
archivebox.misc.checks.check_io_encoding()[source]
archivebox.misc.checks.check_not_root()[source]
archivebox.misc.checks.check_not_inside_source_dir()[source]

Prevent running ArchiveBox from inside its source directory (would pollute repo with data files).

archivebox.misc.checks.check_data_dir_permissions(config=None, **config_kwargs)[source]
archivebox.misc.checks.check_tmp_dir(tmp_dir=None, throw=False, quiet=False, must_exist=True, config=None, **config_kwargs)[source]
archivebox.misc.checks.check_lib_dir(lib_dir: pathlib.Path | None = None, throw=False, quiet=False, must_exist=True, config=None, **config_kwargs)[source]