Function setup

archivebox/main.py:953–1065

Automatically install all ArchiveBox dependencies and extras

(out_dir: Path=OUTPUT_DIR)

@enforce_types
def setup(out_dir: Path=OUTPUT_DIR) -> None:
    """Automatically install all ArchiveBox dependencies and extras"""

    if not (out_dir / ARCHIVE_DIR_NAME).exists():
        run_subcommand('init', stdin=None, pwd=out_dir)

    setup_django(out_dir=out_dir, check_db=True)
    from core.models import User

    if not User.objects.filter(is_superuser=True).exists():
        stderr('\n[+] Creating new admin user for the Web UI...', color='green')
        run_subcommand('manage', subcommand_args=['createsuperuser'], pwd=out_dir)

    stderr('\n[+] Installing enabled ArchiveBox dependencies automatically...', color='green')

    stderr('\n    Installing YOUTUBEDL_BINARY automatically using pip...')
    if YOUTUBEDL_VERSION:
        print(f'{YOUTUBEDL_VERSION} is already installed', YOUTUBEDL_BINARY)
    else:
        try:
            run_shell([
                PYTHON_BINARY, '-m', 'pip',
                'install',
                '--upgrade',
                '--no-cache-dir',
                '--no-warn-script-location',
                'youtube_dl',
            ], capture_output=False, cwd=out_dir)
            pkg_path = run_shell([
                PYTHON_BINARY, '-m', 'pip',
                'show',
                'youtube_dl',
            ], capture_output=True, text=True, cwd=out_dir).stdout.decode().split('Location: ')[-1].split('\n', 1)[0]
            NEW_YOUTUBEDL_BINARY = Path(pkg_path) / 'youtube_dl' / '__main__.py'
            os.chmod(NEW_YOUTUBEDL_BINARY, 0o777)
            assert NEW_YOUTUBEDL_BINARY.exists(), f'youtube_dl must exist inside {pkg_path}'
            config(f'YOUTUBEDL_BINARY={NEW_YOUTUBEDL_BINARY}', set=True, out_dir=out_dir)
        except BaseException as e:                                              # lgtm [py/catch-base-exception]
            stderr(f'[X] Failed to install python packages: {e}', color='red')
            raise SystemExit(1)

    if platform.machine() == 'armv7l':
        stderr('\n    Skip the automatic installation of CHROME_BINARY because playwright is not available on armv7.')
    else:
        stderr('\n    Installing CHROME_BINARY automatically using playwright...')
        if CHROME_VERSION:
            print(f'{CHROME_VERSION} is already installed', CHROME_BINARY)
        else:
            try:
                run_shell([
                    PYTHON_BINARY, '-m', 'pip',
                    'install',
                    '--upgrade',
                    '--no-cache-dir',
                    '--no-warn-script-location',
                    'playwright',
                ], capture_output=False, cwd=out_dir)
                run_shell([PYTHON_BINARY, '-m', 'playwright', 'install', 'chromium'], capture_output=False, cwd=out_dir)