View in validator

docs/source/cli.rst

@@ -21,6 +21,14 @@ Use the `ome_zarr` command to interrogate Zarr datasets::
     # Local data (after downloading as below)
     $ ome_zarr info 6001240.zarr/
 
+view
+====
+
+Use the `ome_zarr` command to view Zarr data in the https://ome.github.io/ome-ngff-validator::
+
+    # Local data (after downloading as below)
+    $ ome_zarr view 6001240.zarr/
+
 download
 ========
 

ome_zarr/cli.py

@@ -9,6 +9,7 @@
 from .scale import Scaler
 from .utils import download as zarr_download
 from .utils import info as zarr_info
+from .utils import view as zarr_view
 
 
 def config_logging(loglevel: int, args: argparse.Namespace) -> None:
@@ -29,6 +30,12 @@ def info(args: argparse.Namespace) -> None:
     list(zarr_info(args.path, stats=args.stats))
 
 
+def view(args: argparse.Namespace) -> None:
+    """Wrap the :func:`~ome_zarr.utils.view` method."""
+    config_logging(logging.WARN, args)
+    zarr_view(args.path, args.port)
+
+
 def download(args: argparse.Namespace) -> None:
     """Wrap the :func:`~ome_zarr.utils.download` method."""
     config_logging(logging.WARN, args)
@@ -105,6 +112,12 @@ def main(args: Union[List[str], None] = None) -> None:
     parser_download.add_argument("--output", default=".")
     parser_download.set_defaults(func=download)
 
+    # view (in ome-ngff-validator in a browser)
+    parser_view = subparsers.add_parser("view")
+    parser_view.add_argument("path")
+    parser_view.add_argument("--port", type=int, default=8000)
+    parser_view.set_defaults(func=view)
+
     # create
     parser_create = subparsers.add_parser("create")
     parser_create.add_argument(

ome_zarr/utils.py

@@ -2,6 +2,13 @@
 
 import json
 import logging
+import os
+import webbrowser
+from http.server import (  # type: ignore[attr-defined]
+    HTTPServer,
+    SimpleHTTPRequestHandler,
+    test,
+)
 from pathlib import Path
 from typing import Iterator, List
 
@@ -45,6 +52,35 @@ def info(path: str, stats: bool = False) -> Iterator[Node]:
         yield node
 
 
+def view(input_path: str, port: int = 8000) -> None:
+    # serve the parent directory in a simple server with CORS. Open browser
+
+    parent_dir, image_name = os.path.split(input_path)
+    parent_dir = str(parent_dir)
+
+    class CORSRequestHandler(SimpleHTTPRequestHandler):
+        def end_headers(self) -> None:
+            self.send_header("Access-Control-Allow-Origin", "*")
+            SimpleHTTPRequestHandler.end_headers(self)
+
+        def translate_path(self, path: str) -> str:
+            # Since we don't call the class constructor ourselves,
+            # we set the directory here instead
+            self.directory = parent_dir
+            super_path = super().translate_path(path)
+            return super_path
+
+    # open ome-ngff-validator in a web browser...
+    url = (
+        f"https://ome.github.io/ome-ngff-validator/"
+        f"?source=http://localhost:{port}/{image_name}"
+    )
+    webbrowser.open(url)
+
+    # ...then start serving content
+    test(CORSRequestHandler, HTTPServer, port=port)
+
+
 def download(input_path: str, output_dir: str = ".") -> None:
     """Download an OME-Zarr from the given path.