scitex 2.13.0__py3-none-any.whl → 2.15.1__py3-none-any.whl

scitex/compat/__init__.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+# Timestamp: "2026-01-13 (ywatanabe)"
+# File: /home/ywatanabe/proj/scitex-code/src/scitex/compat/__init__.py
+
+"""SciTeX Backward Compatibility Module.
+
+This module provides aliases and wrappers for deprecated APIs.
+Import from here to use old function names that delegate to new implementations.
+
+Deprecation Timeline:
+- v1.x: Old APIs work with deprecation warnings
+- v2.x: Old APIs removed, use new APIs directly
+"""
+
+from __future__ import annotations
+
+import warnings
+from functools import wraps
+from typing import Callable
+
+
+def deprecated(new_name: str, removal_version: str = "2.0"):
+    """Decorator to mark functions as deprecated."""
+
+    def decorator(func: Callable) -> Callable:
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                f"{func.__name__} is deprecated. "
+                f"Use {new_name} instead. "
+                f"Will be removed in v{removal_version}.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+# UI/Notification compatibility
+def notify(*args, **kwargs):
+    """Deprecated: Use scitex.ui.alert() instead."""
+    warnings.warn(
+        "scitex.compat.notify is deprecated. Use scitex.ui.alert instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    from scitex.ui import alert
+
+    return alert(*args, **kwargs)
+
+
+async def notify_async(*args, **kwargs):
+    """Deprecated: Use scitex.ui.alert_async() instead."""
+    warnings.warn(
+        "scitex.compat.notify_async is deprecated. Use scitex.ui.alert_async instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    from scitex.ui import alert_async
+
+    return await alert_async(*args, **kwargs)
+
+
+__all__ = [
+    "deprecated",
+    "notify",
+    "notify_async",
+]
+
+
+# EOF

scitex/config/README.md

@@ -1,7 +1,7 @@
 <!-- ---
 !-- Timestamp: 2025-12-09
 !-- Author: ywatanabe
-!-- File: /home/ywatanabe/proj/scitex-code/src/scitex/config/README.md
+!-- File: /home/ywatanabe/proj/scitex-python/src/scitex/config/README.md
 !-- --- -->
 
 # SciTeX Configuration Module

scitex/config/__init__.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # Timestamp: "2025-12-09 (ywatanabe)"
 # File: ./src/scitex/config/__init__.py
 
@@ -34,8 +33,16 @@ Usage:
     cache_dir = paths.resolve("cache", user_provided_path)
 """
 
-from ._PriorityConfig import PriorityConfig, get_scitex_dir, load_dotenv
+from ._env_registry import (
+    ENV_REGISTRY,
+    EnvVar,
+    generate_template,
+    get_all_modules,
+    get_env_by_module,
+    get_env_docs,
+)
 from ._paths import ScitexPaths, get_paths
+from ._PriorityConfig import PriorityConfig, get_scitex_dir, load_dotenv
 from ._ScitexConfig import ScitexConfig, get_config, load_yaml
 
 __all__ = [
@@ -50,6 +57,13 @@ __all__ = [
     "PriorityConfig",
     "get_scitex_dir",
     "load_dotenv",
+    # Environment variable registry
+    "ENV_REGISTRY",
+    "EnvVar",
+    "generate_template",
+    "get_all_modules",
+    "get_env_by_module",
+    "get_env_docs",
 ]
 
 

scitex/config/_env_registry.py

@@ -0,0 +1,191 @@
+#!/usr/bin/env python3
+# Timestamp: 2026-01-24
+# File: src/scitex/config/_env_registry.py
+
+"""
+Registry of all SCITEX environment variables.
+
+Provides documentation and template generation for environment configuration.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+
+
+@dataclass
+class EnvVar:
+    """Environment variable definition."""
+
+    name: str
+    description: str
+    module: str
+    default: Optional[str] = None
+    required: bool = False
+    sensitive: bool = False
+
+
+# Registry of all SCITEX environment variables
+ENV_REGISTRY: List[EnvVar] = [
+    # Core
+    EnvVar("SCITEX_DIR", "Base directory for scitex data", "core", "~/.scitex"),
+    EnvVar("SCITEX_ENV_SRC", "Path to env source file/directory", "core"),
+    EnvVar("SCITEX_LOGGING_LEVEL", "Logging level", "logging", "INFO"),
+    EnvVar("SCITEX_LOG_FORMAT", "Log format style", "logging", "default"),
+    EnvVar("SCITEX_FORCE_COLOR", "Force colored output", "logging", "false"),
+    # Audio
+    EnvVar("SCITEX_AUDIO_MODE", "Audio mode: local/remote/auto", "audio", "auto"),
+    EnvVar("SCITEX_AUDIO_RELAY_URL", "Relay server URL for remote audio", "audio"),
+    EnvVar("SCITEX_AUDIO_RELAY_HOST", "Relay server host", "audio"),
+    EnvVar("SCITEX_AUDIO_RELAY_PORT", "Relay server port", "audio", "31293"),
+    EnvVar("SCITEX_AUDIO_PORT", "Audio server port", "audio", "31293"),
+    EnvVar("ELEVENLABS_API_KEY", "ElevenLabs API key", "audio", sensitive=True),
+    # Scholar
+    EnvVar("SCITEX_SCHOLAR_DIR", "Scholar library directory", "scholar"),
+    EnvVar("SCITEX_CROSSREF_EMAIL", "Email for Crossref API", "scholar"),
+    EnvVar("SCITEX_PUBMED_EMAIL", "Email for PubMed API", "scholar"),
+    EnvVar("SCITEX_SCHOLAR_CROSSREF_DB", "Local Crossref database path", "scholar"),
+    EnvVar("SCITEX_SCHOLAR_CROSSREF_API_URL", "Crossref API URL", "scholar"),
+    EnvVar(
+        "SCITEX_SCHOLAR_CROSSREF_MODE", "Crossref mode: local/api/hybrid", "scholar"
+    ),
+    EnvVar("SCITEX_SCHOLAR_OPENATHENS_EMAIL", "OpenAthens login email", "scholar"),
+    EnvVar(
+        "SCITEX_SCHOLAR_OPENATHENS_ENABLED",
+        "Enable OpenAthens auth",
+        "scholar",
+        "false",
+    ),
+    EnvVar(
+        "SCITEX_SCHOLAR_EZPROXY_URL", "EZProxy URL for institutional access", "scholar"
+    ),
+    EnvVar("SCITEX_SCHOLAR_OPENURL_RESOLVER_URL", "OpenURL resolver URL", "scholar"),
+    EnvVar(
+        "SCITEX_SCHOLAR_ZENROWS_API_KEY",
+        "ZenRows API key for scraping",
+        "scholar",
+        sensitive=True,
+    ),
+    # Social
+    EnvVar("SCITEX_X_CONSUMER_KEY", "Twitter/X consumer key", "social", sensitive=True),
+    EnvVar(
+        "SCITEX_X_CONSUMER_SECRET",
+        "Twitter/X consumer secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar("SCITEX_X_ACCESS_TOKEN", "Twitter/X access token", "social", sensitive=True),
+    EnvVar(
+        "SCITEX_X_ACCESS_TOKEN_SECRET",
+        "Twitter/X access token secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_LINKEDIN_ACCESS_TOKEN",
+        "LinkedIn access token",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar("SCITEX_REDDIT_CLIENT_ID", "Reddit client ID", "social", sensitive=True),
+    EnvVar(
+        "SCITEX_REDDIT_CLIENT_SECRET",
+        "Reddit client secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar("SCITEX_YOUTUBE_API_KEY", "YouTube API key", "social", sensitive=True),
+    EnvVar("SCITEX_GA_PROPERTY_ID", "Google Analytics property ID", "social"),
+    # Cloud
+    EnvVar("SCITEX_CLOUD_USERNAME", "Cloud username", "cloud", sensitive=True),
+    EnvVar("SCITEX_CLOUD_PASSWORD", "Cloud password", "cloud", sensitive=True),
+    EnvVar(
+        "SCITEX_CLOUD_CODE_WORKSPACE", "Running in cloud workspace", "cloud", "false"
+    ),
+    EnvVar("SCITEX_CLOUD_CODE_PROJECT_ROOT", "Cloud project root", "cloud"),
+    EnvVar("SCITEX_CLOUD_CODE_BACKEND", "Cloud backend type", "cloud"),
+    # UI/Notification
+    EnvVar("SCITEX_UI_DEFAULT_BACKEND", "Default notification backend", "ui"),
+    EnvVar(
+        "SCITEX_UI_BACKEND_PRIORITY",
+        "Notification backend priority (comma-sep)",
+        "ui",
+    ),
+    EnvVar("SCITEX_UI_INFO_BACKENDS", "Backends for info notifications", "ui"),
+    EnvVar("SCITEX_UI_WARNING_BACKENDS", "Backends for warning notifications", "ui"),
+    EnvVar("SCITEX_UI_ERROR_BACKENDS", "Backends for error notifications", "ui"),
+    EnvVar("SCITEX_UI_CRITICAL_BACKENDS", "Backends for critical notifications", "ui"),
+    EnvVar("SCITEX_NOTIFY_EMAIL_FROM", "Email notification sender", "ui"),
+    EnvVar("SCITEX_NOTIFY_EMAIL_TO", "Email notification recipient", "ui"),
+    EnvVar("SCITEX_NOTIFY_WEBHOOK_URL", "Webhook URL for notifications", "ui"),
+    # Capture
+    EnvVar("SCITEX_CAPTURE_DIR", "Screenshot capture directory", "capture"),
+    # Web
+    EnvVar("SCITEX_WEB_DOWNLOADS_DIR", "Web downloads directory", "web"),
+    # PLT
+    EnvVar("SCITEX_PLT_AXES_WIDTH_MM", "Default axes width in mm", "plt"),
+    EnvVar("SCITEX_PLT_LINES_TRACE_MM", "Default line trace width in mm", "plt"),
+    EnvVar("SCITEX_STYLE", "Default plot style", "plt"),
+    EnvVar("SCITEX_COLORS", "Color palette to use", "plt"),
+]
+
+
+def get_env_by_module(module: str) -> List[EnvVar]:
+    """Get all environment variables for a module."""
+    return [e for e in ENV_REGISTRY if e.module == module]
+
+
+def get_all_modules() -> List[str]:
+    """Get list of all modules with env vars."""
+    return sorted(set(e.module for e in ENV_REGISTRY))
+
+
+def generate_template(
+    include_sensitive: bool = True, include_defaults: bool = True
+) -> str:
+    """Generate a template .src file with all environment variables."""
+    lines = [
+        "#!/bin/bash",
+        "# SciTeX Environment Variables Template",
+        "# Generated by scitex.config.generate_template()",
+        "#",
+        "# Usage: source this file or set SCITEX_ENV_SRC to this path",
+        "",
+    ]
+
+    for module in get_all_modules():
+        lines.append(f"# === {module.upper()} ===")
+        for env in get_env_by_module(module):
+            if env.sensitive and not include_sensitive:
+                continue
+
+            if env.description:
+                lines.append(f"# {env.description}")
+
+            if env.default and include_defaults:
+                lines.append(f'export {env.name}="{env.default}"')
+            elif env.sensitive:
+                lines.append(f'# export {env.name}="YOUR_{env.name}_HERE"')
+            else:
+                lines.append(f"# export {env.name}=")
+        lines.append("")
+
+    return "\n".join(lines)
+
+
+def get_env_docs() -> Dict[str, Dict]:
+    """Get documentation for all environment variables."""
+    return {
+        e.name: {
+            "description": e.description,
+            "module": e.module,
+            "default": e.default,
+            "required": e.required,
+            "sensitive": e.sensitive,
+        }
+        for e in ENV_REGISTRY
+    }
+
+
+# EOF

scitex/config/default.yaml

@@ -78,4 +78,35 @@ debug:
   verbose: ${SCITEX_VERBOSE:-false}
   capture_screenshots: ${SCITEX_CAPTURE_SCREENSHOTS:-true}
 
+# ----------------------------------------
+# UI Notification Settings
+# ----------------------------------------
+ui:
+  default_backend: ${SCITEX_UI_DEFAULT_BACKEND:-"audio"}
+  backend_priority:
+    - audio
+    - desktop
+    - matplotlib
+    - playwright
+    - email
+    - webhook
+  level_backends:
+    info:
+      - audio
+    warning:
+      - audio
+      - desktop
+    error:
+      - audio
+      - desktop
+      - email
+    critical:
+      - audio
+      - desktop
+      - matplotlib
+      - email
+  timeouts:
+    matplotlib: ${SCITEX_UI_TIMEOUT_MATPLOTLIB:-5.0}
+    playwright: ${SCITEX_UI_TIMEOUT_PLAYWRIGHT:-5.0}
+
 # EOF

scitex/cv/__init__.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+# Timestamp: 2026-01-08
+# File: src/scitex/cv/__init__.py
+"""SciTeX Computer Vision Module.
+
+Provides reusable cv2-based utilities for image processing:
+- I/O: load, save, color conversions
+- Transform: resize, rotate, flip, crop, pad
+- Filters: blur, sharpen, edge detection, threshold, denoise
+- Draw: rectangle, circle, line, text, polylines, arrow
+
+Example
+-------
+>>> import scitex.cv as cv
+>>> # Load and process an image
+>>> img = cv.load("input.png")
+>>> img = cv.resize(img, scale=0.5)
+>>> img = cv.blur(img, ksize=5)
+>>> edges = cv.edge_detect(img, method="canny")
+>>> cv.save(edges, "edges.png")
+"""
+
+# I/O
+# Drawing
+from ._draw import (
+    arrow,
+    circle,
+    line,
+    polylines,
+    rectangle,
+    text,
+)
+
+# Filters
+from ._filters import (
+    blur,
+    denoise,
+    edge_detect,
+    sharpen,
+    threshold,
+)
+from ._io import (
+    load,
+    save,
+    to_bgr,
+    to_gray,
+    to_rgb,
+)
+
+# Transforms
+from ._transform import (
+    crop,
+    flip,
+    pad,
+    resize,
+    rotate,
+)
+
+__all__ = [
+    # I/O
+    "load",
+    "save",
+    "to_rgb",
+    "to_bgr",
+    "to_gray",
+    # Transforms
+    "resize",
+    "rotate",
+    "flip",
+    "crop",
+    "pad",
+    # Filters
+    "blur",
+    "sharpen",
+    "edge_detect",
+    "threshold",
+    "denoise",
+    # Drawing
+    "rectangle",
+    "circle",
+    "line",
+    "text",
+    "polylines",
+    "arrow",
+]
+
+# EOF

scitex/cv/_draw.py

@@ -0,0 +1,236 @@
+#!/usr/bin/env python3
+# Timestamp: 2026-01-08
+# File: src/scitex/cv/_draw.py
+"""Drawing utilities using cv2."""
+
+from __future__ import annotations
+
+from typing import Tuple
+
+import cv2
+import numpy as np
+
+
+def rectangle(
+    img: np.ndarray,
+    pt1: Tuple[int, int],
+    pt2: Tuple[int, int],
+    color: Tuple[int, int, int] = (0, 255, 0),
+    thickness: int = 2,
+    filled: bool = False,
+) -> np.ndarray:
+    """Draw a rectangle on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    pt1 : tuple
+        Top-left corner (x, y).
+    pt2 : tuple
+        Bottom-right corner (x, y).
+    color : tuple
+        BGR color.
+    thickness : int
+        Line thickness (-1 for filled).
+    filled : bool
+        If True, fill the rectangle.
+
+    Returns
+    -------
+    np.ndarray
+        Image with rectangle.
+    """
+    t = -1 if filled else thickness
+    cv2.rectangle(img, pt1, pt2, color, t)
+    return img
+
+
+def circle(
+    img: np.ndarray,
+    center: Tuple[int, int],
+    radius: int,
+    color: Tuple[int, int, int] = (0, 255, 0),
+    thickness: int = 2,
+    filled: bool = False,
+) -> np.ndarray:
+    """Draw a circle on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    center : tuple
+        Center coordinates (x, y).
+    radius : int
+        Circle radius.
+    color : tuple
+        BGR color.
+    thickness : int
+        Line thickness.
+    filled : bool
+        If True, fill the circle.
+
+    Returns
+    -------
+    np.ndarray
+        Image with circle.
+    """
+    t = -1 if filled else thickness
+    cv2.circle(img, center, radius, color, t)
+    return img
+
+
+def line(
+    img: np.ndarray,
+    pt1: Tuple[int, int],
+    pt2: Tuple[int, int],
+    color: Tuple[int, int, int] = (0, 255, 0),
+    thickness: int = 2,
+) -> np.ndarray:
+    """Draw a line on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    pt1 : tuple
+        Start point (x, y).
+    pt2 : tuple
+        End point (x, y).
+    color : tuple
+        BGR color.
+    thickness : int
+        Line thickness.
+
+    Returns
+    -------
+    np.ndarray
+        Image with line.
+    """
+    cv2.line(img, pt1, pt2, color, thickness)
+    return img
+
+
+def text(
+    img: np.ndarray,
+    text: str,
+    position: Tuple[int, int],
+    color: Tuple[int, int, int] = (255, 255, 255),
+    scale: float = 1.0,
+    thickness: int = 2,
+    font: str = "simplex",
+) -> np.ndarray:
+    """Draw text on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    text : str
+        Text to draw.
+    position : tuple
+        Bottom-left corner of text (x, y).
+    color : tuple
+        BGR color.
+    scale : float
+        Font scale.
+    thickness : int
+        Text thickness.
+    font : str
+        Font type: 'simplex', 'plain', 'duplex', 'complex', 'triplex'.
+
+    Returns
+    -------
+    np.ndarray
+        Image with text.
+    """
+    font_map = {
+        "simplex": cv2.FONT_HERSHEY_SIMPLEX,
+        "plain": cv2.FONT_HERSHEY_PLAIN,
+        "duplex": cv2.FONT_HERSHEY_DUPLEX,
+        "complex": cv2.FONT_HERSHEY_COMPLEX,
+        "triplex": cv2.FONT_HERSHEY_TRIPLEX,
+    }
+    font_face = font_map.get(font, cv2.FONT_HERSHEY_SIMPLEX)
+    cv2.putText(img, text, position, font_face, scale, color, thickness)
+    return img
+
+
+def polylines(
+    img: np.ndarray,
+    points: np.ndarray,
+    closed: bool = True,
+    color: Tuple[int, int, int] = (0, 255, 0),
+    thickness: int = 2,
+) -> np.ndarray:
+    """Draw polylines on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    points : np.ndarray
+        Array of points with shape (N, 1, 2) or (N, 2).
+    closed : bool
+        Whether to close the polyline.
+    color : tuple
+        BGR color.
+    thickness : int
+        Line thickness.
+
+    Returns
+    -------
+    np.ndarray
+        Image with polylines.
+    """
+    if len(points.shape) == 2:
+        points = points.reshape((-1, 1, 2))
+    cv2.polylines(img, [points.astype(np.int32)], closed, color, thickness)
+    return img
+
+
+def arrow(
+    img: np.ndarray,
+    pt1: Tuple[int, int],
+    pt2: Tuple[int, int],
+    color: Tuple[int, int, int] = (0, 255, 0),
+    thickness: int = 2,
+    tip_length: float = 0.1,
+) -> np.ndarray:
+    """Draw an arrowed line on an image.
+
+    Parameters
+    ----------
+    img : np.ndarray
+        Input image (modified in place).
+    pt1 : tuple
+        Start point (x, y).
+    pt2 : tuple
+        End point (arrow tip) (x, y).
+    color : tuple
+        BGR color.
+    thickness : int
+        Line thickness.
+    tip_length : float
+        Arrow tip length as fraction of line length.
+
+    Returns
+    -------
+    np.ndarray
+        Image with arrow.
+    """
+    cv2.arrowedLine(img, pt1, pt2, color, thickness, tipLength=tip_length)
+    return img
+
+
+__all__ = [
+    "rectangle",
+    "circle",
+    "line",
+    "text",
+    "polylines",
+    "arrow",
+]
+
+# EOF