archivebox.config package

Submodules

archivebox.config.stubs module

Module contents

archivebox.config.get_real_name(key: str) → str[source]
archivebox.config.load_config_val(key: str, default: Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[archivebox.config_stubs.ConfigDict], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]]]] = None, type: Optional[Type[CT_co]] = None, aliases: Optional[Tuple[str, ...]] = None, config: Optional[archivebox.config_stubs.ConfigDict] = None, env_vars: Optional[os._Environ] = None, config_file_vars: Optional[Dict[str, str]] = None) → Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]][source]

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

archivebox.config.load_config_file(out_dir: str = None) → Optional[Dict[str, str]][source]

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

archivebox.config.write_config_file(config: Dict[str, str], out_dir: str = None) → archivebox.config_stubs.ConfigDict[source]

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

archivebox.config.load_config(defaults: Dict[str, archivebox.config_stubs.ConfigDefault], config: Optional[archivebox.config_stubs.ConfigDict] = None, out_dir: Optional[str] = None, env_vars: Optional[os._Environ] = None, config_file_vars: Optional[Dict[str, str]] = None) → archivebox.config_stubs.ConfigDict[source]
archivebox.config.stdout(*args, color: Optional[str] = None, prefix: str = '', config: Optional[archivebox.config_stubs.ConfigDict] = None) → None[source]
archivebox.config.stderr(*args, color: Optional[str] = None, prefix: str = '', config: Optional[archivebox.config_stubs.ConfigDict] = None) → None[source]
archivebox.config.hint(text: Union[Tuple[str, ...], List[str], str], prefix=' ', config: Optional[archivebox.config_stubs.ConfigDict] = None) → None[source]
archivebox.config.bin_version(binary: Optional[str]) → Optional[str][source]

check the presence and return valid version line of a specified binary

archivebox.config.bin_path(binary: Optional[str]) → Optional[str][source]
archivebox.config.bin_hash(binary: Optional[str]) → Optional[str][source]
archivebox.config.find_chrome_binary() → Optional[str][source]

find any installed chrome binaries in the default locations

archivebox.config.find_chrome_data_dir() → Optional[str][source]

find any installed chrome user data directories in the default locations

archivebox.config.wget_supports_compression(config)[source]
archivebox.config.get_code_locations(config: archivebox.config_stubs.ConfigDict) → Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]][source]
archivebox.config.get_external_locations(config: archivebox.config_stubs.ConfigDict) → Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]][source]
archivebox.config.get_data_locations(config: archivebox.config_stubs.ConfigDict) → Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]][source]
archivebox.config.get_dependency_info(config: archivebox.config_stubs.ConfigDict) → Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]][source]
archivebox.config.get_chrome_info(config: archivebox.config_stubs.ConfigDict) → Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any], Dict[str, Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]], Callable[[], Union[str, bool, int, None, Pattern[AnyStr], Dict[str, Any]]]][source]
archivebox.config.load_all_config()[source]
archivebox.config.check_system_config(config: archivebox.config_stubs.ConfigDict = {'ACTIVE_THEME': 'default', 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy')}}, 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.58.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.58.0 (x86_64-pc-linux-gnu)', 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources')}, 'SQL_INDEX': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:5d4e48266ca3bfeb6e3f91c77e65bbe3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'version': '0.4.24'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.58.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:d678482566f7cae731ae9d5e4a4125c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'version': '3.0.8 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:4df726b0eb84ce3f0e170c322995d734', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.17.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': True, 'path': 'mercury-parser', 'version': '1.0.0'}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:da34bcaec808f532c6fad11797bf9cc6', 'is_valid': False, 'path': '/usr/bin/node', 'version': 'v8.10.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python3.7', 'version': '3.7.9'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:c3d53e47e50f2f61016331da435b3764', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.19.4'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:9d8d19caa9a068af4da4ee9772a5ea5a', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/youtube-dl', 'version': '2020.12.02'}}, 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'DJANGO_VERSION': '3.0.8 final (0)', 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com', 'GIT_SHA': '0.4.24', 'GIT_VERSION': 'git version 2.17.1', 'IN_DOCKER': False, 'IS_TTY': False, 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs'), 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'mercury-parser', 'MERCURY_VERSION': '1.0.0', 'NODE_BINARY': 'node', 'NODE_VERSION': 'v8.10.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs'), 'OUTPUT_PERMISSIONS': '755', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.7.9', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources'), 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'URL_BLACKLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_BLACKLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': '0.4.24', 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': False, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.19.4', 'WGET_VERSION': 'GNU Wget 1.19.4', 'YOUTUBEDL_ARGS': ['--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--user-agent', '--all-subs', '--extract-audio', '--keep-video', '--ignore-errors', '--geo-bypass', '--audio-format', 'mp3', '--audio-quality', '320K', '--embed-thumbnail', '--add-metadata'], 'YOUTUBEDL_BINARY': 'youtube-dl', 'YOUTUBEDL_VERSION': '2020.12.02'}) → None[source]
archivebox.config.check_dependencies(config: archivebox.config_stubs.ConfigDict = {'ACTIVE_THEME': 'default', 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy')}}, 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.58.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.58.0 (x86_64-pc-linux-gnu)', 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources')}, 'SQL_INDEX': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:5d4e48266ca3bfeb6e3f91c77e65bbe3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'version': '0.4.24'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.58.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:d678482566f7cae731ae9d5e4a4125c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'version': '3.0.8 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:4df726b0eb84ce3f0e170c322995d734', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.17.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': True, 'path': 'mercury-parser', 'version': '1.0.0'}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:da34bcaec808f532c6fad11797bf9cc6', 'is_valid': False, 'path': '/usr/bin/node', 'version': 'v8.10.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python3.7', 'version': '3.7.9'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:c3d53e47e50f2f61016331da435b3764', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.19.4'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:9d8d19caa9a068af4da4ee9772a5ea5a', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/youtube-dl', 'version': '2020.12.02'}}, 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'DJANGO_VERSION': '3.0.8 final (0)', 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com', 'GIT_SHA': '0.4.24', 'GIT_VERSION': 'git version 2.17.1', 'IN_DOCKER': False, 'IS_TTY': False, 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs'), 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'mercury-parser', 'MERCURY_VERSION': '1.0.0', 'NODE_BINARY': 'node', 'NODE_VERSION': 'v8.10.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs'), 'OUTPUT_PERMISSIONS': '755', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.7.9', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources'), 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'URL_BLACKLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_BLACKLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': '0.4.24', 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': False, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.19.4', 'WGET_VERSION': 'GNU Wget 1.19.4', 'YOUTUBEDL_ARGS': ['--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--user-agent', '--all-subs', '--extract-audio', '--keep-video', '--ignore-errors', '--geo-bypass', '--audio-format', 'mp3', '--audio-quality', '320K', '--embed-thumbnail', '--add-metadata'], 'YOUTUBEDL_BINARY': 'youtube-dl', 'YOUTUBEDL_VERSION': '2020.12.02'}, show_help: bool = True) → None[source]
archivebox.config.check_data_folder(out_dir: Optional[str] = None, config: archivebox.config_stubs.ConfigDict = {'ACTIVE_THEME': 'default', 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy')}}, 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.58.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.58.0 (x86_64-pc-linux-gnu)', 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources')}, 'SQL_INDEX': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:5d4e48266ca3bfeb6e3f91c77e65bbe3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'version': '0.4.24'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.58.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:d678482566f7cae731ae9d5e4a4125c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'version': '3.0.8 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:4df726b0eb84ce3f0e170c322995d734', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.17.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': True, 'path': 'mercury-parser', 'version': '1.0.0'}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:da34bcaec808f532c6fad11797bf9cc6', 'is_valid': False, 'path': '/usr/bin/node', 'version': 'v8.10.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python3.7', 'version': '3.7.9'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:c3d53e47e50f2f61016331da435b3764', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.19.4'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:9d8d19caa9a068af4da4ee9772a5ea5a', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/youtube-dl', 'version': '2020.12.02'}}, 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'DJANGO_VERSION': '3.0.8 final (0)', 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com', 'GIT_SHA': '0.4.24', 'GIT_VERSION': 'git version 2.17.1', 'IN_DOCKER': False, 'IS_TTY': False, 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs'), 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'mercury-parser', 'MERCURY_VERSION': '1.0.0', 'NODE_BINARY': 'node', 'NODE_VERSION': 'v8.10.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs'), 'OUTPUT_PERMISSIONS': '755', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.7.9', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources'), 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'URL_BLACKLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_BLACKLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': '0.4.24', 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': False, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.19.4', 'WGET_VERSION': 'GNU Wget 1.19.4', 'YOUTUBEDL_ARGS': ['--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--user-agent', '--all-subs', '--extract-audio', '--keep-video', '--ignore-errors', '--geo-bypass', '--audio-format', 'mp3', '--audio-quality', '320K', '--embed-thumbnail', '--add-metadata'], 'YOUTUBEDL_BINARY': 'youtube-dl', 'YOUTUBEDL_VERSION': '2020.12.02'}) → None[source]
archivebox.config.setup_django(out_dir: pathlib.Path = None, check_db=False, config: archivebox.config_stubs.ConfigDict = {'ACTIVE_THEME': 'default', 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy')}}, 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.58.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.58.0 (x86_64-pc-linux-gnu)', 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources')}, 'SQL_INDEX': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:5d4e48266ca3bfeb6e3f91c77e65bbe3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/sphinx-build', 'version': '0.4.24'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.58.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:d678482566f7cae731ae9d5e4a4125c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'version': '3.0.8 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:4df726b0eb84ce3f0e170c322995d734', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.17.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': True, 'path': 'mercury-parser', 'version': '1.0.0'}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:da34bcaec808f532c6fad11797bf9cc6', 'is_valid': False, 'path': '/usr/bin/node', 'version': 'v8.10.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:d7cf9722d98d814deda7822f260069c5', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python3.7', 'version': '3.7.9'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:c3d53e47e50f2f61016331da435b3764', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.19.4'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:9d8d19caa9a068af4da4ee9772a5ea5a', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/youtube-dl', 'version': '2020.12.02'}}, 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.7/site-packages/Django-3.0.8-py3.7.egg/django/bin/django-admin.py', 'DJANGO_VERSION': '3.0.8 final (0)', 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com', 'GIT_SHA': '0.4.24', 'GIT_VERSION': 'git version 2.17.1', 'IN_DOCKER': False, 'IS_TTY': False, 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/logs'), 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'mercury-parser', 'MERCURY_VERSION': '1.0.0', 'NODE_BINARY': 'node', 'NODE_VERSION': 'v8.10.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs'), 'OUTPUT_PERMISSIONS': '755', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.7.9', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/docs/sources'), 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/themes/legacy'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'URL_BLACKLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_BLACKLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': '0.4.24', 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': False, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'ArchiveBox/0.4.24 (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.19.4', 'WGET_VERSION': 'GNU Wget 1.19.4', 'YOUTUBEDL_ARGS': ['--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--user-agent', '--all-subs', '--extract-audio', '--keep-video', '--ignore-errors', '--geo-bypass', '--audio-format', 'mp3', '--audio-quality', '320K', '--embed-thumbnail', '--add-metadata'], 'YOUTUBEDL_BINARY': 'youtube-dl', 'YOUTUBEDL_VERSION': '2020.12.02'}) → None[source]
archivebox.config.TERM_WIDTH()