archivebox.config.collection

Module Contents

Functions

get_real_name

get the up-to-date canonical name for a given old alias or current key

load_config_val

parse bool, int, and str key=value pairs from env

load_config_file

load the ini-formatted config file from DATA_DIR/Archivebox.conf

section_for_key

write_config_file

load the ini-formatted config file from DATA_DIR/Archivebox.conf

load_config

load_all_config

API

archivebox.config.collection.get_real_name(key: str) str[source]

get the up-to-date canonical name for a given old alias or current key

archivebox.config.collection.load_config_val(key: str, default: Any = None, type: Optional[Type] = None, aliases: Optional[Tuple[str, ...]] = None, config: Optional[benedict.benedict] = None, env_vars: Optional[os._Environ] = None, config_file_vars: Optional[Dict[str, str]] = None) Any[source]

parse bool, int, and str key=value pairs from env

archivebox.config.collection.load_config_file() Optional[benedict.benedict][source]

load the ini-formatted config file from DATA_DIR/Archivebox.conf

archivebox.config.collection.section_for_key(key: str) Any[source]
archivebox.config.collection.write_config_file(config: Dict[str, str]) benedict.benedict[source]

load the ini-formatted config file from DATA_DIR/Archivebox.conf

archivebox.config.collection.load_config(defaults: Dict[str, Any], config: Optional[benedict.benedict] = None, out_dir: Optional[str] = None, env_vars: Optional[os._Environ] = None, config_file_vars: Optional[Dict[str, str]] = None) benedict.benedict[source]
archivebox.config.collection.load_all_config()[source]