maidr 1.5.0__tar.gz → 1.6.0__tar.gz

{maidr-1.5.0 → maidr-1.6.0}/CHANGELOG.md

@@ -1,6 +1,20 @@
 # CHANGELOG
 
 
+## v1.6.0 (2025-08-04)
+
+### Continuous Integration
+
+- Update uv.lock ([#227](https://github.com/xability/py-maidr/pull/227),
+  [`f162971`](https://github.com/xability/py-maidr/commit/f162971f4e2585e055de3c837ce9342b292cb378))
+
+### Features
+
+- Add WSL compatibility for opening HTML files
+  ([#224](https://github.com/xability/py-maidr/pull/224),
+  [`2f2a899`](https://github.com/xability/py-maidr/commit/2f2a899b1df4137db94aeb843099ee6f0df952f0))
+
+
 ## v1.5.0 (2025-08-04)
 
 ### Features

{maidr-1.5.0 → maidr-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.5.0
+Version: 1.6.0
 Summary: Multimodal Access and Interactive Data Representations
 Project-URL: Homepage, https://xability.github.io/py-maidr
 Project-URL: Repository, https://github.com/xability/py-maidr

{maidr-1.5.0 → maidr-1.6.0}/maidr/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.5.0"
+__version__ = "1.6.0"
 
 from .api import close, render, save_html, show, stacked
 from .core import Maidr

{maidr-1.5.0 → maidr-1.6.0}/maidr/core/maidr.py

@@ -7,6 +7,8 @@ import os
 import tempfile
 import uuid
 import webbrowser
+import subprocess
+from pathlib import Path
 from typing import Any, Literal, cast
 
 import matplotlib.pyplot as plt
@@ -137,7 +139,48 @@ class Maidr:
         html_file_path = self.save_html(
             temp_file_path
         )  # This will use use_iframe=False
-        webbrowser.open(f"file://{html_file_path}")
+        if Environment.is_wsl():
+            wsl_distro_name = Environment.get_wsl_distro_name()
+
+            # Validate that WSL distro name is available
+            if not wsl_distro_name:
+                raise ValueError(
+                    "WSL_DISTRO_NAME environment variable is not set or is empty. "
+                    "Cannot construct WSL file URL. Please ensure you are running in a WSL environment."
+                )
+
+            # Ensure html_file_path is an absolute POSIX path for proper WSL URL construction
+            html_file_path = Path(html_file_path).resolve().as_posix()
+
+            url = f"file://wsl$/{wsl_distro_name}{html_file_path}"
+
+            # Try to open the file in Windows using explorer.exe with robust path detection
+            explorer_path = Environment.find_explorer_path()
+            if explorer_path:
+                try:
+                    result = subprocess.run(
+                        [explorer_path, url],
+                        capture_output=True,
+                        text=True,
+                        timeout=10
+                    )
+
+                    if result.returncode == 0:
+                        return
+                    else:
+                        # Fall back to webbrowser.open() if explorer.exe fails
+                        webbrowser.open(url)
+
+                except subprocess.TimeoutExpired:
+                    webbrowser.open(url)
+                except Exception:
+                    # Fall back to webbrowser.open() if explorer.exe fails
+                    webbrowser.open(url)
+            else:
+                webbrowser.open(url)
+
+        else:
+            webbrowser.open(f"file://{html_file_path}")
 
     def _create_html_tag(self, use_iframe: bool = True) -> Tag:
         """Create the MAIDR HTML using HTML tags."""

{maidr-1.5.0 → maidr-1.6.0}/maidr/util/environment.py

@@ -1,6 +1,8 @@
 import json
 import os
+import subprocess
 import sys
+from typing import Union
 
 
 class Environment:
@@ -99,6 +101,93 @@ class Environment:
                 return False
         except ImportError:
             return False
+    @staticmethod
+    def is_wsl() -> bool:
+        """
+        Check if the current environment is WSL (Windows Subsystem for Linux).
+
+        This method detects WSL environments by reading the `/proc/version` file
+        and checking for 'microsoft' or 'wsl' keywords in the version string.
+        WSL environments typically contain these identifiers in their kernel version.
+
+        Returns
+        -------
+        bool
+            True if the environment is WSL, False otherwise.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.is_wsl()
+        False  # When not in WSL
+        """
+        try:
+            with open('/proc/version', 'r') as f:
+                version_info = f.read().lower()
+                if 'microsoft' in version_info or 'wsl' in version_info:
+                    return True
+        except FileNotFoundError:
+            pass
+        return False
+
+    @staticmethod
+    def get_wsl_distro_name() -> str:
+        """
+        Get the WSL distribution name from environment variables.
+
+        This method retrieves the WSL distribution name from the `WSL_DISTRO_NAME`
+        environment variable, which is automatically set by WSL when running
+        in a WSL environment.
+
+        Returns
+        -------
+        str
+            The WSL distribution name (e.g., 'Ubuntu-20.04', 'Debian') if set,
+            otherwise an empty string.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.get_wsl_distro_name()
+        ''  # When not in WSL or WSL_DISTRO_NAME not set
+        """
+        return os.environ.get('WSL_DISTRO_NAME', '')
+
+    @staticmethod
+    def find_explorer_path() -> Union[str, None]:
+        """
+        Find the correct path to explorer.exe in WSL environment.
+
+        This method checks if explorer.exe is available in the PATH
+        and returns the path if found.
+
+        Returns
+        -------
+        str | None
+            The path to explorer.exe if found, None otherwise.
+
+        Examples
+        --------
+        >>> from maidr.util.environment import Environment
+        >>> Environment.find_explorer_path()
+        '/mnt/c/Windows/explorer.exe'  # When found
+        """
+        # Check if explorer.exe is in PATH
+        try:
+            result = subprocess.run(
+                ['which', 'explorer.exe'],
+                capture_output=True,
+                text=True,
+                timeout=5
+            )
+            if result.returncode == 0:
+                return result.stdout.strip()
+        except Exception:
+            pass
+
+        return None
+
+
 
     @staticmethod
     def get_renderer() -> str:

{maidr-1.5.0 → maidr-1.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "maidr"
-version = "1.5.0"
+version = "1.6.0"
 description = "Multimodal Access and Interactive Data Representations"
 authors = [
     { name = "JooYoung Seo", email = "jseo1005@illinois.edu" },

{maidr-1.5.0 → maidr-1.6.0}/uv.lock

@@ -1675,7 +1675,7 @@ wheels = [
 
 [[package]]
 name = "maidr"
-version = "1.4.10"
+version = "1.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "htmltools" },