Add Configuration overview

Author: JorjMcKie

setup.py

@@ -640,6 +640,7 @@ def build():
         ret.append( (f'{g_root}/src/utils.py', to_dir) )
         ret.append( (f'{g_root}/src/_wxcolors.py', to_dir) )
         ret.append( (f'{g_root}/src/_apply_pages.py', to_dir) )
+        ret.append( (f'{g_root}/src/show_features.py', to_dir) )
         ret.append( (f'{g_root}/src/build/extra.py', to_dir) )
         ret.append( (b'', f'{to_dir}/py.typed') )
         ret.append( (f'{g_root}/src/build/{path_so_leaf}', to_dir) )
@@ -1390,6 +1391,7 @@ def platform_release_tuple():
 g_entry_points = textwrap.dedent('''
         [console_scripts]
         pymupdf = pymupdf.__main__:main
+        pymupdf-config = pymupdf.show_features:config
         ''')
 
 

src/__main__.py

@@ -844,6 +844,7 @@ def _internal(args):
     pymupdf.message('This is from PyMuPDF message().')
     pymupdf.log('This is from PyMuPDF log().')
 
+
 def main():
     """Define command configurations."""
     parser = argparse.ArgumentParser(

src/show_features.py

@@ -0,0 +1,188 @@
+import subprocess
+import sys
+import importlib.metadata
+import pymupdf
+
+def get_tesseract_version():
+    try:
+        out = subprocess.check_output(
+            ["tesseract", "--version"], stderr=subprocess.STDOUT
+        )
+        line = out.decode().splitlines()[0]
+        return line.split()[-1]
+    except Exception:
+        return None
+
+
+def get_pkg_version(name: str):
+    try:
+        return importlib.metadata.version(name)
+    except importlib.metadata.PackageNotFoundError:
+        return None
+
+
+_pymupdf_feature_list = [
+    (
+        "pymupdf_core",
+        pymupdf.__version__,
+        "Core PyMuPDF Functionality",
+        "",
+    ),
+    (
+        "pymupdf4llm",
+        pymupdf.__version__,
+        "4LLM Extensions",
+        "",
+    ),
+    (
+        "pymupdf_layout",
+        pymupdf.__version__,
+        "ML Based Layout Extensions",
+        "",
+    ),
+    (
+        "pymupdf_fonts",
+        "1.0.4",
+        "Additional Fonts",
+        "An optional package that makes more fonts available to PyMuPDF programmers.",
+    ),
+    (
+        "pymupdf_office",
+        pymupdf.__version__,
+        "Extended Support for Office Documents",
+        "A commercial extension that handles Office files like native documents.\n    Install via 'pip install pymupdf-office', and obtain a license key from this\n    website: https://pymupdf.io/office",
+    ),
+]
+
+_other_feature_list = [
+    (
+        "tesseract",
+        "4.0.0",
+        "Tesseract OCR Engine",
+        "A popular OCR engine that PyMuPDF can use during document extraction.",
+    ),
+    (
+        "rapidocr",
+        "3.9.2",
+        "Rapid OCR Engine",
+        "An OCR engine that PyMuPDF can use during document extraction.\n    Its installation is strongly recommended for much better OCR results\n    than with Tesseract OCR alone.",
+    ),
+    (
+        "Pillow",
+        "0",
+        "Python Imaging Library",
+        "A popular image library that PyMuPDF can use to deal with images having exotic formats.",
+    ),
+    (
+        "pandas",
+        "0",
+        "Data Analysis Library",
+        "A popular data analysis library that PyMuPDF can use for storing tables as DataFrames.",
+    ),
+]
+
+
+def _check_installed_package_version(pack, vsn):
+    if pack == "tesseract":  # this is  not a Python package!
+        version = get_tesseract_version()
+    else:
+        version = get_pkg_version(pack)
+    if version is None:
+        return 2, None
+    if version >= vsn:
+        return 0, version
+    else:
+        return 1, version
+
+
+def _build_feature_dict(feature_list):
+    """
+    Builds a dict {package_name: info_dict} for the given list of
+    (pack, required_version, short, desc) tuples.
+    """
+    _STATE_LABELS = {
+        0: "installed",
+        1: "outdated",
+        2: "missing",
+    }
+
+    result = {}
+    for pack, vsn, short, desc in feature_list:
+        state, installed_version = _check_installed_package_version(pack, vsn)
+        result[pack] = {
+            "required_version": vsn,
+            "installed_version": installed_version,
+            "status": _STATE_LABELS[state],
+            "short": short,
+            "desc": desc,
+        }
+    return result
+
+
+def print_feature_dict(title, feature_dict):
+    print(f"\n{title}")
+    print("=" * len(title))
+    max_pack_len = max(len(pack) for pack in feature_dict.keys()) + 2
+    pack_fmt = f"  {{:<{max_pack_len}}}"
+    max_version_len = (
+        max(len(info["required_version"]) for info in feature_dict.values()) + 2
+    )
+    max_version_len = max(max_version_len, len("min required") + 2)
+    version_fmt = f"{{:<{max_version_len}}}"
+    header = f"{'Package':<{max_pack_len+2}}{'Min Required':<{max_version_len}}Status"
+    print(header)
+    print("-" * (len(header) + 15))
+    for pack, info in feature_dict.items():
+        status = info["status"]
+        vsn = info["required_version"]
+        if vsn == "0":
+            vsn = "any"
+        this_version = info["installed_version"]
+        if status == "missing":
+            print(pack_fmt.format(pack) + version_fmt.format(vsn) + "not installed")
+            print(f"    {info['desc']}")
+        elif status == "outdated":
+            print(
+                pack_fmt.format(pack)
+                + version_fmt.format(vsn)
+                + f"installed: {this_version} (out of date)"
+            )
+            print(f"    {info['short']}")
+        elif status == "installed":
+            if vsn == "any" or vsn != this_version:
+                print(
+                    pack_fmt.format(pack)
+                    + version_fmt.format(vsn)
+                    + f"installed: {this_version}"
+                )
+            else:
+                print(pack_fmt.format(pack) + version_fmt.format(vsn) + "installed")
+
+            print(f"    {info['short']}")
+        print()
+
+
+def collect_features():
+    """
+    Determines the install status of all the different packages that
+    contribute to PyMuPDF features (both default and optional ones) and
+    stores the results in two dictionaries:
+
+    - pymupdf_components: the PyMuPDF packages themselves
+    - other_packages: useful third-party packages PyMuPDF can use
+
+    Returns:
+        tuple[dict, dict]: (pymupdf_components, other_packages)
+    """
+    pymupdf_components = _build_feature_dict(_pymupdf_feature_list)
+    other_packages = _build_feature_dict(_other_feature_list)
+    return pymupdf_components, other_packages
+
+
+def config():
+    print(f"Python: {sys.version}")
+    print("PyMuPDF Configuration Overview")
+    pymupdf_components, other_packages = collect_features()
+    print_feature_dict("PyMuPDF Configuration", pymupdf_components)
+    print_feature_dict("Useful Third-party Packages for PyMuPDF", other_packages)
+

tests/test_pylint.py

@@ -129,6 +129,7 @@ def test_pylint():
             'pymupdf.py',
             'table.py',
             'utils.py',
+            'show_features.py',
             ]
     leafs.sort()
     try: