viewinline 0.2.1__tar.gz → 0.2.2__tar.gz

{viewinline-0.2.1 → viewinline-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viewinline
-Version: 0.2.1
+Version: 0.2.2
 Summary: Quick look geospatial viewer for iTerm2 compatible terminals
 Project-URL: Homepage, https://github.com/nkeikon/viewinline
 Project-URL: Repository, https://github.com/nkeikon/viewinline
@@ -36,6 +36,11 @@ Description-Content-Type: text/markdown
 **Quick-look geospatial viewer for compatible terminals.**  
 Displays rasters, vectors, and tabular data directly in the terminal with no GUI and no temporary files.
 
+<p align="center">
+  <a href="viewinline_gif1.gif"><img src="viewinline_gif1.gif" width="49%"></a>
+  <a href="viewinline_gif2.gif"><img src="viewinline_gif2.gif" width="49%"></a>
+</p>
+
 Think of it as `ls` for geospatial files — designed for quick visual inspection at the command line, not a replacement for QGIS, ArcGIS, or analytical workflows.
 
 Particularly useful on HPC systems and remote servers accessed via SSH. Images render on your local terminal without X11 forwarding, VNC, or file downloads.
@@ -101,6 +106,8 @@ The iTerm2 inline image protocol (OSC 1337) is supported by:
 
 **tmux/screen:** Inline images don't work inside tmux or screen sessions, even with `allow-passthrough on`. Use a plain terminal tab.
 
+**Fallback:** In terminals that do not support inline images, you can fallback to ASCII art by installing [`chafa`](https://hpjansson.org/chafa/) command-line tool. Install `chafa` with your package manager (e.g. `brew install chafa` or `sudo apt install chafa`). You can also force the use of `chafa` by setting the environment variable `INLINE_VIEWER_ENGINE=chafa`.
+
 ## Features  
 - Previews rasters, vectors, and tabular data directly in the terminal  
 - Non-interactive: everything is controlled through command-line options
@@ -218,11 +225,7 @@ CSV and Parquet:
 ```
 
 ## Need help?
-You can ask questions about usage via the documentation-based assistant:
-
-👉 [Ask the viewtif + viewgeom + viewinline Helper](https://chatgpt.com/g/g-698b61c42f788191b884aed1b99dfcd8-viewtif-viewgeom-viewinline-helper)
-
-👉 For NASA staff: find 'viewtif + viewgeom + viewinline Helper' via the ChatGSFC Agent Marketplace
+NASA staff can ask questions about usage via the documentation-based assistant 'viewtif + viewgeom + viewinline Helper' via the ChatGSFC Agent Marketplace.
 
 ## License
 This project is released under the Apache License 2.0 © 2026 Keiko Nomura.

{viewinline-0.2.1 → viewinline-0.2.2}/README.md

@@ -6,6 +6,11 @@
 **Quick-look geospatial viewer for compatible terminals.**  
 Displays rasters, vectors, and tabular data directly in the terminal with no GUI and no temporary files.
 
+<p align="center">
+  <a href="viewinline_gif1.gif"><img src="viewinline_gif1.gif" width="49%"></a>
+  <a href="viewinline_gif2.gif"><img src="viewinline_gif2.gif" width="49%"></a>
+</p>
+
 Think of it as `ls` for geospatial files — designed for quick visual inspection at the command line, not a replacement for QGIS, ArcGIS, or analytical workflows.
 
 Particularly useful on HPC systems and remote servers accessed via SSH. Images render on your local terminal without X11 forwarding, VNC, or file downloads.
@@ -71,6 +76,8 @@ The iTerm2 inline image protocol (OSC 1337) is supported by:
 
 **tmux/screen:** Inline images don't work inside tmux or screen sessions, even with `allow-passthrough on`. Use a plain terminal tab.
 
+**Fallback:** In terminals that do not support inline images, you can fallback to ASCII art by installing [`chafa`](https://hpjansson.org/chafa/) command-line tool. Install `chafa` with your package manager (e.g. `brew install chafa` or `sudo apt install chafa`). You can also force the use of `chafa` by setting the environment variable `INLINE_VIEWER_ENGINE=chafa`.
+
 ## Features  
 - Previews rasters, vectors, and tabular data directly in the terminal  
 - Non-interactive: everything is controlled through command-line options
@@ -188,11 +195,7 @@ CSV and Parquet:
 ```
 
 ## Need help?
-You can ask questions about usage via the documentation-based assistant:
-
-👉 [Ask the viewtif + viewgeom + viewinline Helper](https://chatgpt.com/g/g-698b61c42f788191b884aed1b99dfcd8-viewtif-viewgeom-viewinline-helper)
-
-👉 For NASA staff: find 'viewtif + viewgeom + viewinline Helper' via the ChatGSFC Agent Marketplace
+NASA staff can ask questions about usage via the documentation-based assistant 'viewtif + viewgeom + viewinline Helper' via the ChatGSFC Agent Marketplace.
 
 ## License
 This project is released under the Apache License 2.0 © 2026 Keiko Nomura.

{viewinline-0.2.1 → viewinline-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "viewinline"
-version = "0.2.1"
+version = "0.2.2"
 description = "Quick look geospatial viewer for iTerm2 compatible terminals"
 readme = "README.md"
 license = { text = "Apache-2.0" }

{viewinline-0.2.1 → viewinline-0.2.2}/src/viewinline/viewinline.py

@@ -26,13 +26,14 @@ import pandas as pd
 from PIL import Image, ImageOps, ImageDraw, ImageFont
 from matplotlib import colormaps
 import matplotlib as mpl
+import subprocess
 
 import warnings
 
 warnings.filterwarnings("ignore", message="More than one layer found", category=UserWarning)
 warnings.filterwarnings("ignore", message="Dataset has no geotransform", category=UserWarning)
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 AVAILABLE_COLORMAPS = [
     "viridis", "inferno", "magma", "plasma",
@@ -40,6 +41,70 @@ AVAILABLE_COLORMAPS = [
     "Spectral", "cubehelix", "tab10", "turbo"
 ]
 
+_TERMINALS_WITHOUT_IMAGES = [
+    'unknown', 'cygwin', 'tmux', 'screen',
+    'vscode', 'xterm', 'rxvt', 'alacritty', 'foot', 'st', 'kitty',
+    'gnome-terminal', 'xfce4-terminal', 'lxterminal', 'terminator',
+    'tilix', 'hyper', 'windows terminal', 'putty', 'sakura',
+    'terminology', 'eterm', 'guake', 'tilda', 'deepin-terminal',
+]
+
+def detect_terminal() -> dict[str, str]:
+    """Detect terminal emulator by checking environment variables and parent process.
+    Returns a dictionary of detected terminal-related variables.
+    """
+    env = os.environ
+    terms = {}
+    # Check for common terminal-specific variables
+    for var in [
+        "TERM_PROGRAM", "KONSOLE_VERSION", "KONSOLE_PROFILE_NAME",
+        "VTE_VERSION", "TERMINATOR_UUID", "ALACRITTY_SOCKET",
+        "WEZTERM_EXECUTABLE", "ITERM_SESSION_ID"
+    ]:
+        if var in env:
+            term = env[var]
+            if term:
+                terms[var] = term
+    # Fallback: check parent process
+    if not terms:
+        try:
+            ppid = os.getppid()
+            parent = subprocess.check_output(["ps", "-p", str(ppid), "-o", "comm="]).decode().strip()
+            if parent:
+                terms["PARENT_PROCESS"] = parent
+        except Exception:
+            pass
+    term = env.get("TERM")
+    if term:
+        terms["TERM"] = term
+    return terms
+
+def is_terminal_without_images(term_info: dict[str, str]) -> bool:
+    """Determine if the terminal is likely to support inline images based on detected info.
+    Args:
+        term_info: Dictionary of terminal-related environment variables.
+    Returns:
+        True if terminal is likely supported, False if known to be unsupported.
+    """
+    if os.environ.get("INLINE_VIEWER_ENGINE") == "chafa":
+        return True
+    terms = term_info.values()
+    for unsupported in _TERMINALS_WITHOUT_IMAGES:
+        if unsupported in terms:
+            return True
+    return False
+
+def is_chafa_available() -> bool:
+    """Check if the 'chafa' command-line tool is available for ASCII art fallback."""
+    try:
+        subprocess.run(["chafa", "--version"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        return True
+    except FileNotFoundError:
+        return False
+
+_TERMINAL_INFO = detect_terminal()
+_TERMINAL_SUPPORTS_IMAGES = not is_terminal_without_images(_TERMINAL_INFO)
+
 # ---------------------------------------------------------------------
 # Display utilities
 # ---------------------------------------------------------------------
@@ -52,7 +117,8 @@ def show_inline_image(image_array: np.ndarray, display_scale = None, is_vector:
     buffer = BytesIO()
     # Use lower compression level for performance in speed
     Image.fromarray(image_array).save(buffer, format="PNG", compress_level=1, optimize=False)
-    encoded = base64.b64encode(buffer.getvalue()).decode("utf-8")
+    image_bytes = buffer.getvalue()
+    encoded = base64.b64encode(image_bytes).decode("utf-8")
 
     if display_scale is None:
         width_pct = 33  # same default for both
@@ -67,7 +133,19 @@ def show_inline_image(image_array: np.ndarray, display_scale = None, is_vector:
     # Clamp range
     width_pct = max(5, min(width_pct, 400))
 
-    sys.stdout.write(f"\033]1337;File=inline=1;width={width_pct}%:{encoded}\a\n")
+    if _TERMINAL_SUPPORTS_IMAGES:
+        sys.stdout.write(f"\033]1337;File=inline=1;width={width_pct}%:{encoded}\a\n")
+    else:
+        if is_chafa_available():
+            chafa_output = subprocess.check_output(
+                ["chafa", "-"],  
+                input=image_bytes
+            ).decode()
+            
+            sys.stdout.write(f"\n{chafa_output}\a\n")
+        else:
+            sys.stdout.write(f"[INFO] Use supported terminal or install 'chafa' for ascii art fallback. Detected: {_TERMINAL_INFO}\n")
+    
     sys.stdout.flush()