Function version

archivebox/main.py:218–290

Print the ArchiveBox version and dependency information

(quiet: bool=False,
            out_dir: Path=OUTPUT_DIR)

@enforce_types
def version(quiet: bool=False,
            out_dir: Path=OUTPUT_DIR) -> None:
    """Print the ArchiveBox version and dependency information"""
    
    print(VERSION)
    
    if not quiet:
        # 0.7.1
        # ArchiveBox v0.7.1+editable COMMIT_HASH=951bba5 BUILD_TIME=2023-12-17 16:46:05 1702860365
        # IN_DOCKER=False IN_QEMU=False ARCH=arm64 OS=Darwin PLATFORM=macOS-14.2-arm64-arm-64bit PYTHON=Cpython
        # FS_ATOMIC=True FS_REMOTE=False FS_USER=501:20 FS_PERMS=644
        # DEBUG=False IS_TTY=True TZ=UTC SEARCH_BACKEND=ripgrep LDAP=False
        
        p = platform.uname()
        print(
            'ArchiveBox v{}'.format(get_version(CONFIG)),
            *((f'COMMIT_HASH={COMMIT_HASH[:7]}',) if COMMIT_HASH else ()),
            f'BUILD_TIME={BUILD_TIME}',
        )
        print(
            f'IN_DOCKER={IN_DOCKER}',
            f'IN_QEMU={IN_QEMU}',
            f'ARCH={p.machine}',
            f'OS={p.system}',
            f'PLATFORM={platform.platform()}',
            f'PYTHON={sys.implementation.name.title()}',
        )
        OUTPUT_IS_REMOTE_FS = DATA_LOCATIONS['OUTPUT_DIR']['is_mount'] or DATA_LOCATIONS['ARCHIVE_DIR']['is_mount']
        print(
            f'FS_ATOMIC={ENFORCE_ATOMIC_WRITES}',
            f'FS_REMOTE={OUTPUT_IS_REMOTE_FS}',
            f'FS_USER={PUID}:{PGID}',
            f'FS_PERMS={OUTPUT_PERMISSIONS}',
        )
        print(
            f'DEBUG={DEBUG}',
            f'IS_TTY={IS_TTY}',
            f'TZ={TIMEZONE}',
            f'SEARCH_BACKEND={SEARCH_BACKEND_ENGINE}',
            f'LDAP={LDAP}',
            #f'DB=django.db.backends.sqlite3 (({CONFIG["SQLITE_JOURNAL_MODE"]})',  # add this if we have more useful info to show eventually
        )
        print()

        print('{white}[i] Dependency versions:{reset}'.format(**ANSI))
        for name, dependency in DEPENDENCIES.items():
            print(printable_dependency_version(name, dependency))
            
            # add a newline between core dependencies and extractor dependencies for easier reading
            if name == 'ARCHIVEBOX_BINARY':
                print()
        
        print()
        print('{white}[i] Source-code locations:{reset}'.format(**ANSI))
        for name, path in CODE_LOCATIONS.items():
            print(printable_folder_status(name, path))

        print()