scitex 2.14.0__py3-none-any.whl → 2.15.3__py3-none-any.whl

scitex/config/_env_registry.py

@@ -0,0 +1,256 @@
+#!/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_LOGGING_FORMAT", "Log format style", "logging", "default"),
+    EnvVar("SCITEX_LOGGING_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(
+        "SCITEX_AUDIO_ELEVENLABS_API_KEY", "ElevenLabs API key", "audio", sensitive=True
+    ),
+    # Scholar
+    EnvVar("SCITEX_SCHOLAR_DIR", "Scholar library directory", "scholar"),
+    EnvVar("SCITEX_SCHOLAR_CROSSREF_EMAIL", "Email for Crossref API", "scholar"),
+    EnvVar("SCITEX_SCHOLAR_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_SOCIAL_X_CONSUMER_KEY",
+        "Twitter/X consumer key",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_X_CONSUMER_KEY_SECRET",
+        "Twitter/X consumer secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_X_ACCESS_TOKEN",
+        "Twitter/X access token",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_X_ACCESS_TOKEN_SECRET",
+        "Twitter/X access token secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_X_BEARER_TOKEN",
+        "Twitter/X bearer token",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_LINKEDIN_CLIENT_ID",
+        "LinkedIn client ID",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_LINKEDIN_CLIENT_SECRET",
+        "LinkedIn client secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_LINKEDIN_ACCESS_TOKEN",
+        "LinkedIn access token",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_REDDIT_CLIENT_ID",
+        "Reddit client ID",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_REDDIT_CLIENT_SECRET",
+        "Reddit client secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_YOUTUBE_API_KEY",
+        "YouTube API key",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_YOUTUBE_CLIENT_SECRETS_FILE",
+        "YouTube client secrets file path",
+        "social",
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_GOOGLE_ANALYTICS_PROPERTY_ID",
+        "Google Analytics property ID",
+        "social",
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_GOOGLE_ANALYTICS_MEASUREMENT_ID",
+        "Google Analytics measurement ID",
+        "social",
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_GOOGLE_ANALYTICS_API_SECRET",
+        "Google Analytics API secret",
+        "social",
+        sensitive=True,
+    ),
+    EnvVar(
+        "SCITEX_SOCIAL_GOOGLE_APPLICATION_CREDENTIALS",
+        "Google service account credentials path",
+        "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_UI_EMAIL_NOTIFICATION_FROM", "Email notification sender", "ui"),
+    EnvVar("SCITEX_UI_EMAIL_NOTIFICATION_TO", "Email notification recipient", "ui"),
+    EnvVar("SCITEX_UI_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_PLT_STYLE", "Default plot style", "plt"),
+    EnvVar("SCITEX_PLT_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/context/__init__.py

@@ -1,9 +1,31 @@
 #!/usr/bin/env python3
 """Scitex context module."""
 
+from ._detect_environment import (
+    detect_environment,
+    get_output_directory,
+    is_ipython,
+    is_notebook,
+    is_script,
+)
+from ._get_notebook_path import (
+    get_notebook_directory,
+    get_notebook_info_simple,
+    get_notebook_name,
+    get_notebook_path,
+)
 from ._suppress_output import quiet, suppress_output
 
 __all__ = [
+    "detect_environment",
+    "get_notebook_directory",
+    "get_notebook_info_simple",
+    "get_notebook_name",
+    "get_notebook_path",
+    "get_output_directory",
+    "is_ipython",
+    "is_notebook",
+    "is_script",
     "quiet",
     "suppress_output",
 ]

scitex/dev/__init__.py

@@ -1,20 +1,39 @@
 #!/usr/bin/env python3
-"""Scitex dev module."""
+"""Scitex dev module - Development and debugging utilities."""
 
 # Pyproject utilities (lazy import to avoid tomlkit dependency)
+# Installation guide utilities (moved from root scitex module)
+from .._install_guide import (
+    MODULE_REQUIREMENTS,
+    check_module_deps,
+    require_module,
+    requires,
+    show_install_guide,
+    warn_module_deps,
+)
 from . import _pyproject as pyproject
 from . import cv
 from ._analyze_code_flow import CodeFlowAnalyzer, analyze_code_flow, main, parse_args
 from ._reload import reload, reload_auto, reload_stop
 
 __all__ = [
+    # Code flow analysis
     "CodeFlowAnalyzer",
     "analyze_code_flow",
     "main",
     "parse_args",
+    # Hot reloading
     "reload",
     "reload_auto",
     "reload_stop",
+    # Submodules
     "pyproject",
     "cv",
+    # Installation guide utilities
+    "show_install_guide",
+    "check_module_deps",
+    "require_module",
+    "requires",
+    "warn_module_deps",
+    "MODULE_REQUIREMENTS",
 ]

scitex/diagram/__init__.py

@@ -1,38 +1,59 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Timestamp: 2025-12-15
+# Timestamp: 2026-01-24
 # Author: ywatanabe / Claude
 # File: scitex/diagram/__init__.py
 
 """
 SciTeX Diagram - Paper-optimized diagram generation.
 
-This module provides a semantic layer above Mermaid/Graphviz/D2 that
-understands paper constraints (column width, reading direction, emphasis)
-and compiles to backend formats with appropriate layout hints.
-
-Key insight: LLMs are good at generating CONSTRAINTS, not pixel layouts.
-SciTeX Diagram defines "what this diagram means for a paper" and compiles
-that to backend-specific layout directives.
+This module delegates entirely to figrecipe._diagram.
+figrecipe is the single source of truth for diagram functionality.
 
 Example
 -------
->>> from scitex.diagram import Diagram
+>>> import scitex as stx
+>>>
+>>> # Recommended: Use stx.Diagram directly
+>>> d = stx.Diagram(type="pipeline")
+>>> d.add_node("input", "Raw Data")
+>>> d.add_node("process", "Transform", emphasis="primary")
+>>> d.add_edge("input", "process")
+>>> d.to_mermaid("pipeline.mmd")
 >>>
->>> diagram = Diagram.from_yaml("workflow.diagram.yaml")
->>> diagram.to_mermaid("workflow.mmd")
->>> diagram.to_graphviz("workflow.dot")
+>>> # From YAML spec
+>>> d = stx.Diagram.from_yaml("workflow.diagram.yaml")
+>>> d.to_mermaid("workflow.mmd")
+>>> d.to_graphviz("workflow.dot")
 """
 
-from scitex.diagram._schema import DiagramSpec, PaperConstraints, LayoutHints, PaperMode
-from scitex.diagram._diagram import Diagram
-from scitex.diagram._compile import compile_to_mermaid, compile_to_graphviz
-from scitex.diagram._presets import WORKFLOW_PRESET, DECISION_PRESET, PIPELINE_PRESET
-from scitex.diagram._split import split_diagram, SplitConfig, SplitStrategy, SplitResult
+# Import everything from figrecipe._diagram (single source of truth)
+from figrecipe._diagram import (
+    DECISION_PRESET,
+    PIPELINE_PRESET,
+    SCIENTIFIC_PRESET,
+    WORKFLOW_PRESET,
+    Diagram,
+    DiagramSpec,
+    DiagramType,
+    EdgeSpec,
+    LayoutHints,
+    NodeSpec,
+    PaperConstraints,
+    PaperMode,
+    SplitConfig,
+    SplitResult,
+    SplitStrategy,
+    get_preset,
+    list_presets,
+)
+from figrecipe._diagram._compile import compile_to_graphviz, compile_to_mermaid
 
 __all__ = [
     "Diagram",
     "DiagramSpec",
+    "DiagramType",
+    "NodeSpec",
+    "EdgeSpec",
     "PaperConstraints",
     "LayoutHints",
     "PaperMode",
@@ -41,7 +62,9 @@ __all__ = [
     "WORKFLOW_PRESET",
     "DECISION_PRESET",
     "PIPELINE_PRESET",
-    "split_diagram",
+    "SCIENTIFIC_PRESET",
+    "get_preset",
+    "list_presets",
     "SplitConfig",
     "SplitStrategy",
     "SplitResult",

scitex/diagram/mcp_server.py

@@ -1,148 +1,36 @@
 #!/usr/bin/env python3
-# Timestamp: 2026-01-08
+# Timestamp: 2026-01-24
 # File: src/scitex/diagram/mcp_server.py
-# ----------------------------------------
 
 """
-MCP Server for SciTeX diagram - Paper-optimized diagram generation.
+MCP Server for SciTeX diagram - delegates to figrecipe.
 
-Provides tools for:
-- Creating diagrams from YAML specs
-- Compiling to Mermaid/Graphviz formats
-- Using workflow/decision/pipeline presets
-- Splitting large diagrams for publication layouts
+This is a thin wrapper that redirects to figrecipe's MCP server.
+figrecipe is the single source of truth for diagram functionality.
 """
 
 from __future__ import annotations
 
-import asyncio
-
-# Graceful MCP dependency handling
-try:
-    import mcp.types as types
-    from mcp.server import NotificationOptions, Server
-    from mcp.server.models import InitializationOptions
-    from mcp.server.stdio import stdio_server
-
-    MCP_AVAILABLE = True
-except ImportError:
-    MCP_AVAILABLE = False
-    types = None  # type: ignore
-    Server = None  # type: ignore
-    NotificationOptions = None  # type: ignore
-    InitializationOptions = None  # type: ignore
-    stdio_server = None  # type: ignore
-
-__all__ = ["DiagramServer", "main", "MCP_AVAILABLE"]
-
-
-class DiagramServer:
-    """MCP Server for Paper-Optimized Diagram Generation."""
-
-    def __init__(self):
-        self.server = Server("scitex-diagram")
-        self.setup_handlers()
-
-    def setup_handlers(self):
-        """Set up MCP server handlers."""
-        from ._mcp.handlers import (
-            compile_graphviz_handler,
-            compile_mermaid_handler,
-            create_diagram_handler,
-            get_paper_modes_handler,
-            get_preset_handler,
-            list_presets_handler,
-            split_diagram_handler,
-        )
-        from ._mcp.tool_schemas import get_tool_schemas
-
-        @self.server.list_tools()
-        async def handle_list_tools():
-            return get_tool_schemas()
-
-        @self.server.call_tool()
-        async def handle_call_tool(name: str, arguments: dict):
-            if name == "create_diagram":
-                return await self._wrap_result(create_diagram_handler(**arguments))
-
-            elif name == "compile_mermaid":
-                return await self._wrap_result(compile_mermaid_handler(**arguments))
-
-            elif name == "compile_graphviz":
-                return await self._wrap_result(compile_graphviz_handler(**arguments))
-
-            elif name == "list_presets":
-                return await self._wrap_result(list_presets_handler())
-
-            elif name == "get_preset":
-                return await self._wrap_result(get_preset_handler(**arguments))
-
-            elif name == "split_diagram":
-                return await self._wrap_result(split_diagram_handler(**arguments))
-
-            elif name == "get_paper_modes":
-                return await self._wrap_result(get_paper_modes_handler())
-
-            else:
-                raise ValueError(f"Unknown tool: {name}")
-
-    async def _wrap_result(self, coro):
-        """Wrap handler result as MCP TextContent."""
-        import json
-
-        try:
-            result = await coro
-            return [
-                types.TextContent(
-                    type="text",
-                    text=json.dumps(result, indent=2, default=str),
-                )
-            ]
-        except Exception as e:
-            return [
-                types.TextContent(
-                    type="text",
-                    text=json.dumps({"success": False, "error": str(e)}, indent=2),
-                )
-            ]
-
-
-async def _run_server():
-    """Run the MCP server (internal)."""
-    server = DiagramServer()
-    async with stdio_server() as (read_stream, write_stream):
-        await server.server.run(
-            read_stream,
-            write_stream,
-            InitializationOptions(
-                server_name="scitex-diagram",
-                server_version="0.1.0",
-                capabilities=server.server.get_capabilities(
-                    notification_options=NotificationOptions(),
-                    experimental_capabilities={},
-                ),
-            ),
-        )
-
 
 def main():
-    """Main entry point for the MCP server."""
-    if not MCP_AVAILABLE:
+    """Main entry point - delegates to figrecipe's MCP server."""
+    try:
+        from figrecipe._mcp.server import mcp
+
+        mcp.run()
+    except ImportError as e:
         import sys
 
         print("=" * 60)
-        print("MCP Server 'scitex-diagram' requires the 'mcp' package.")
+        print("scitex-diagram requires figrecipe with MCP support.")
         print()
         print("Install with:")
-        print("  pip install mcp")
+        print("  pip install figrecipe[mcp]")
         print()
-        print("Or install scitex with MCP support:")
-        print("  pip install scitex[mcp]")
+        print(f"Error: {e}")
         print("=" * 60)
         sys.exit(1)
 
-    asyncio.run(_run_server())
-
 
 if __name__ == "__main__":
     main()