feat: add DoclingDocument viewer to CLI (#99)

feat: add docling document viewer to CLI

Signed-off-by: Panos Vagenas <[email protected]>

Author: vagenas

docling_core/cli/__init__.py

@@ -0,0 +1 @@
+"""CLI package."""

docling_core/cli/view.py

@@ -0,0 +1,68 @@
+#
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: MIT
+#
+
+"""CLI for docling viewer."""
+import importlib
+import tempfile
+import webbrowser
+from pathlib import Path
+from typing import Annotated, Optional
+
+import typer
+
+from docling_core.types.doc import DoclingDocument
+from docling_core.types.doc.base import ImageRefMode
+from docling_core.utils.file import resolve_source_to_path
+
+app = typer.Typer(
+    name="Docling",
+    no_args_is_help=True,
+    add_completion=False,
+    pretty_exceptions_enable=False,
+)
+
+
+def version_callback(value: bool):
+    """Callback for version inspection."""
+    if value:
+        docling_core_version = importlib.metadata.version("docling-core")
+        print(f"Docling Core version: {docling_core_version}")
+        raise typer.Exit()
+
+
+@app.command(no_args_is_help=True)
+def view(
+    source: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            metavar="source",
+            help="Docling JSON file to view.",
+        ),
+    ],
+    version: Annotated[
+        Optional[bool],
+        typer.Option(
+            "--version",
+            callback=version_callback,
+            is_eager=True,
+            help="Show version information.",
+        ),
+    ] = None,
+):
+    """Display a Docling JSON file on the default browser."""
+    path = resolve_source_to_path(source=source)
+    doc = DoclingDocument.load_from_json(filename=path)
+    target_path = Path(tempfile.mkdtemp()) / "out.html"
+    html_output = doc.export_to_html(image_mode=ImageRefMode.EMBEDDED)
+    with open(target_path, "w") as f:
+        f.write(html_output)
+    webbrowser.open(url=f"file://{target_path.absolute().resolve()}")
+
+
+click_app = typer.main.get_command(app)
+
+if __name__ == "__main__":
+    app()

poetry.lock

@@ -44,6 +44,7 @@ packages = [{ include = "docling_core" }]
 validate = "docling_core.utils.validate:main"
 generate_jsonschema = "docling_core.utils.generate_jsonschema:main"
 generate_docs = "docling_core.utils.generate_docs:main"
+docling-view = "docling_core.cli.view:app"
 
 [tool.poetry.dependencies]
 python = "^3.9"
@@ -57,6 +58,7 @@ pyyaml = ">=5.1,<7.0.0"
 typing-extensions = "^4.12.2"
 transformers = { version = "^4.34.0", optional = true }
 semchunk = { version = "^2.2.0", optional = true }
+typer = "^0.12.5"
 
 [tool.poetry.extras]
 chunking = ["transformers", "semchunk"]