PraisonAI 3.0.0__py3-none-any.whl

praisonai/cli/features/doctor/checks/env_checks.py

@@ -0,0 +1,543 @@
+"""
+Environment checks for the Doctor CLI module.
+
+Validates Python version, packages, API keys, and environment variables.
+"""
+
+import os
+import platform
+import shutil
+import sys
+from typing import List, Optional
+
+from ..models import (
+    CheckCategory,
+    CheckResult,
+    CheckStatus,
+    CheckSeverity,
+    DoctorConfig,
+)
+from ..registry import register_check
+
+
+@register_check(
+    id="python_version",
+    title="Python Version",
+    description="Check Python version is 3.9+",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.CRITICAL,
+)
+def check_python_version(config: DoctorConfig) -> CheckResult:
+    """Check Python version is 3.9+."""
+    version = sys.version_info
+    version_str = f"{version.major}.{version.minor}.{version.micro}"
+    
+    if version.major >= 3 and version.minor >= 9:
+        return CheckResult(
+            id="python_version",
+            title="Python Version",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"Python {version_str} (>= 3.9 required)",
+            metadata={"version": version_str, "executable": sys.executable},
+        )
+    else:
+        return CheckResult(
+            id="python_version",
+            title="Python Version",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.FAIL,
+            message=f"Python {version_str} found, but 3.9+ required",
+            remediation="Upgrade Python to version 3.9 or higher",
+            severity=CheckSeverity.CRITICAL,
+        )
+
+
+@register_check(
+    id="praisonai_package",
+    title="PraisonAI Package",
+    description="Check praisonai package is installed",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.CRITICAL,
+)
+def check_praisonai_package(config: DoctorConfig) -> CheckResult:
+    """Check praisonai package is installed."""
+    try:
+        from praisonai.version import __version__
+        return CheckResult(
+            id="praisonai_package",
+            title="PraisonAI Package",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"praisonai {__version__} installed",
+            metadata={"version": __version__},
+        )
+    except ImportError as e:
+        return CheckResult(
+            id="praisonai_package",
+            title="PraisonAI Package",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.FAIL,
+            message="praisonai package not found",
+            details=str(e),
+            remediation="Install with: pip install praisonai",
+            severity=CheckSeverity.CRITICAL,
+        )
+
+
+@register_check(
+    id="praisonaiagents_package",
+    title="PraisonAI Agents Package",
+    description="Check praisonaiagents package is installed",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.CRITICAL,
+)
+def check_praisonaiagents_package(config: DoctorConfig) -> CheckResult:
+    """Check praisonaiagents package is installed."""
+    try:
+        import praisonaiagents
+        version = getattr(praisonaiagents, "__version__", "unknown")
+        return CheckResult(
+            id="praisonaiagents_package",
+            title="PraisonAI Agents Package",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"praisonaiagents {version} installed",
+            metadata={"version": version},
+        )
+    except ImportError as e:
+        return CheckResult(
+            id="praisonaiagents_package",
+            title="PraisonAI Agents Package",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.FAIL,
+            message="praisonaiagents package not found",
+            details=str(e),
+            remediation="Install with: pip install praisonaiagents",
+            severity=CheckSeverity.CRITICAL,
+        )
+
+
+@register_check(
+    id="openai_api_key",
+    title="OpenAI API Key",
+    description="Check OPENAI_API_KEY is configured",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.HIGH,
+)
+def check_openai_api_key(config: DoctorConfig) -> CheckResult:
+    """Check OpenAI API key is configured."""
+    key = os.environ.get("OPENAI_API_KEY", "")
+    
+    if key:
+        # Mask the key for display
+        if config.show_keys and len(key) > 12:
+            masked = f"{key[:4]}...{key[-4:]}"
+        else:
+            masked = "***configured***"
+        
+        # Basic validation
+        if key.startswith("sk-") or key.startswith("sk-proj-"):
+            return CheckResult(
+                id="openai_api_key",
+                title="OpenAI API Key",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.PASS,
+                message=f"OPENAI_API_KEY configured ({masked})",
+                metadata={"masked_key": masked},
+            )
+        else:
+            return CheckResult(
+                id="openai_api_key",
+                title="OpenAI API Key",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.WARN,
+                message=f"OPENAI_API_KEY set but format unexpected ({masked})",
+                remediation="Verify the API key format is correct",
+            )
+    else:
+        # Check for alternative providers
+        alternatives = []
+        if os.environ.get("ANTHROPIC_API_KEY"):
+            alternatives.append("ANTHROPIC_API_KEY")
+        if os.environ.get("GOOGLE_API_KEY") or os.environ.get("GEMINI_API_KEY"):
+            alternatives.append("GOOGLE/GEMINI_API_KEY")
+        if os.environ.get("OLLAMA_HOST") or shutil.which("ollama"):
+            alternatives.append("Ollama")
+        
+        if alternatives:
+            return CheckResult(
+                id="openai_api_key",
+                title="OpenAI API Key",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.WARN,
+                message=f"OPENAI_API_KEY not set, but alternatives found: {', '.join(alternatives)}",
+                details="OpenAI is the default provider. Other providers require explicit configuration.",
+            )
+        else:
+            return CheckResult(
+                id="openai_api_key",
+                title="OpenAI API Key",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.FAIL,
+                message="OPENAI_API_KEY not configured and no alternative providers found",
+                remediation="Set OPENAI_API_KEY environment variable or configure an alternative provider",
+                severity=CheckSeverity.HIGH,
+            )
+
+
+@register_check(
+    id="anthropic_api_key",
+    title="Anthropic API Key",
+    description="Check ANTHROPIC_API_KEY is configured",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.LOW,
+)
+def check_anthropic_api_key(config: DoctorConfig) -> CheckResult:
+    """Check Anthropic API key is configured."""
+    key = os.environ.get("ANTHROPIC_API_KEY", "")
+    
+    if key:
+        if config.show_keys and len(key) > 12:
+            masked = f"{key[:4]}...{key[-4:]}"
+        else:
+            masked = "***configured***"
+        
+        return CheckResult(
+            id="anthropic_api_key",
+            title="Anthropic API Key",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"ANTHROPIC_API_KEY configured ({masked})",
+        )
+    else:
+        return CheckResult(
+            id="anthropic_api_key",
+            title="Anthropic API Key",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.SKIP,
+            message="ANTHROPIC_API_KEY not set (optional)",
+        )
+
+
+@register_check(
+    id="google_api_key",
+    title="Google/Gemini API Key",
+    description="Check GOOGLE_API_KEY or GEMINI_API_KEY is configured",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.LOW,
+)
+def check_google_api_key(config: DoctorConfig) -> CheckResult:
+    """Check Google/Gemini API key is configured."""
+    key = os.environ.get("GOOGLE_API_KEY") or os.environ.get("GEMINI_API_KEY", "")
+    
+    if key:
+        if config.show_keys and len(key) > 12:
+            masked = f"{key[:4]}...{key[-4:]}"
+        else:
+            masked = "***configured***"
+        
+        return CheckResult(
+            id="google_api_key",
+            title="Google/Gemini API Key",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"Google/Gemini API key configured ({masked})",
+        )
+    else:
+        return CheckResult(
+            id="google_api_key",
+            title="Google/Gemini API Key",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.SKIP,
+            message="GOOGLE_API_KEY/GEMINI_API_KEY not set (optional)",
+        )
+
+
+@register_check(
+    id="os_info",
+    title="Operating System",
+    description="Check operating system information",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.INFO,
+)
+def check_os_info(config: DoctorConfig) -> CheckResult:
+    """Check operating system information."""
+    os_name = platform.system()
+    os_version = platform.release()
+    arch = platform.machine()
+    
+    return CheckResult(
+        id="os_info",
+        title="Operating System",
+        category=CheckCategory.ENVIRONMENT,
+        status=CheckStatus.PASS,
+        message=f"{os_name} {os_version} ({arch})",
+        metadata={
+            "os_name": os_name,
+            "os_version": os_version,
+            "architecture": arch,
+        },
+    )
+
+
+@register_check(
+    id="virtual_env",
+    title="Virtual Environment",
+    description="Check if running in a virtual environment",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.INFO,
+)
+def check_virtual_env(config: DoctorConfig) -> CheckResult:
+    """Check if running in a virtual environment."""
+    venv = os.environ.get("VIRTUAL_ENV")
+    conda_env = os.environ.get("CONDA_DEFAULT_ENV")
+    
+    if venv:
+        return CheckResult(
+            id="virtual_env",
+            title="Virtual Environment",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"Running in venv: {os.path.basename(venv)}",
+            metadata={"venv_path": venv},
+        )
+    elif conda_env:
+        return CheckResult(
+            id="virtual_env",
+            title="Virtual Environment",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"Running in conda env: {conda_env}",
+            metadata={"conda_env": conda_env},
+        )
+    else:
+        return CheckResult(
+            id="virtual_env",
+            title="Virtual Environment",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.WARN,
+            message="Not running in a virtual environment",
+            remediation="Consider using a virtual environment for isolation",
+        )
+
+
+@register_check(
+    id="git_available",
+    title="Git",
+    description="Check if git is available",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.LOW,
+)
+def check_git_available(config: DoctorConfig) -> CheckResult:
+    """Check if git is available."""
+    git_path = shutil.which("git")
+    
+    if git_path:
+        import subprocess
+        try:
+            result = subprocess.run(
+                ["git", "--version"],
+                capture_output=True,
+                text=True,
+                timeout=5,
+            )
+            version = result.stdout.strip() if result.returncode == 0 else "unknown"
+            return CheckResult(
+                id="git_available",
+                title="Git",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.PASS,
+                message=f"Git available: {version}",
+                metadata={"path": git_path},
+            )
+        except Exception:
+            return CheckResult(
+                id="git_available",
+                title="Git",
+                category=CheckCategory.ENVIRONMENT,
+                status=CheckStatus.PASS,
+                message=f"Git available at {git_path}",
+            )
+    else:
+        return CheckResult(
+            id="git_available",
+            title="Git",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.WARN,
+            message="Git not found in PATH",
+            remediation="Install git for version control features",
+        )
+
+
+@register_check(
+    id="docker_available",
+    title="Docker",
+    description="Check if Docker is available",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.LOW,
+)
+def check_docker_available(config: DoctorConfig) -> CheckResult:
+    """Check if Docker is available."""
+    docker_path = shutil.which("docker")
+    
+    if docker_path:
+        import subprocess
+        try:
+            result = subprocess.run(
+                ["docker", "--version"],
+                capture_output=True,
+                text=True,
+                timeout=5,
+            )
+            if result.returncode == 0:
+                version = result.stdout.strip()
+                return CheckResult(
+                    id="docker_available",
+                    title="Docker",
+                    category=CheckCategory.ENVIRONMENT,
+                    status=CheckStatus.PASS,
+                    message=f"Docker available: {version}",
+                    metadata={"path": docker_path},
+                )
+        except Exception:
+            pass
+        
+        return CheckResult(
+            id="docker_available",
+            title="Docker",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.WARN,
+            message="Docker found but not responding",
+            remediation="Ensure Docker daemon is running",
+        )
+    else:
+        return CheckResult(
+            id="docker_available",
+            title="Docker",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.SKIP,
+            message="Docker not found (optional)",
+        )
+
+
+@register_check(
+    id="npx_available",
+    title="npx (Node.js)",
+    description="Check if npx is available for MCP servers",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.LOW,
+)
+def check_npx_available(config: DoctorConfig) -> CheckResult:
+    """Check if npx is available for MCP servers."""
+    npx_path = shutil.which("npx")
+    
+    if npx_path:
+        return CheckResult(
+            id="npx_available",
+            title="npx (Node.js)",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"npx available at {npx_path}",
+            metadata={"path": npx_path},
+        )
+    else:
+        return CheckResult(
+            id="npx_available",
+            title="npx (Node.js)",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.WARN,
+            message="npx not found (required for some MCP servers)",
+            remediation="Install Node.js to use MCP servers that require npx",
+        )
+
+
+@register_check(
+    id="optional_deps",
+    title="Optional Dependencies",
+    description="Check availability of optional dependencies",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.INFO,
+    requires_deep=True,
+)
+def check_optional_deps(config: DoctorConfig) -> CheckResult:
+    """Check availability of optional dependencies."""
+    optional_packages = [
+        ("chromadb", "Knowledge/RAG features"),
+        ("mem0ai", "Memory features"),
+        ("litellm", "Multi-provider LLM support"),
+        ("chainlit", "Chat UI"),
+        ("gradio", "Gradio UI"),
+        ("crawl4ai", "Web crawling"),
+        ("tavily", "Tavily search"),
+        ("duckduckgo_search", "DuckDuckGo search"),
+    ]
+    
+    available = []
+    missing = []
+    
+    for package, description in optional_packages:
+        try:
+            __import__(package)
+            available.append(package)
+        except ImportError:
+            missing.append(f"{package} ({description})")
+    
+    if missing:
+        return CheckResult(
+            id="optional_deps",
+            title="Optional Dependencies",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"{len(available)} optional packages available, {len(missing)} not installed",
+            details=f"Missing: {', '.join(missing[:5])}{'...' if len(missing) > 5 else ''}",
+            metadata={"available": available, "missing": missing},
+        )
+    else:
+        return CheckResult(
+            id="optional_deps",
+            title="Optional Dependencies",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"All {len(available)} optional packages available",
+            metadata={"available": available},
+        )
+
+
+@register_check(
+    id="model_env_vars",
+    title="Model Configuration",
+    description="Check model-related environment variables",
+    category=CheckCategory.ENVIRONMENT,
+    severity=CheckSeverity.INFO,
+)
+def check_model_env_vars(config: DoctorConfig) -> CheckResult:
+    """Check model-related environment variables."""
+    model_vars = {
+        "MODEL_NAME": os.environ.get("MODEL_NAME"),
+        "OPENAI_MODEL_NAME": os.environ.get("OPENAI_MODEL_NAME"),
+        "OPENAI_BASE_URL": os.environ.get("OPENAI_BASE_URL"),
+        "OPENAI_API_BASE": os.environ.get("OPENAI_API_BASE"),
+    }
+    
+    configured = {k: v for k, v in model_vars.items() if v}
+    
+    if configured:
+        details = ", ".join(f"{k}={v}" for k, v in configured.items())
+        return CheckResult(
+            id="model_env_vars",
+            title="Model Configuration",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message=f"Model config: {details}",
+            metadata=configured,
+        )
+    else:
+        return CheckResult(
+            id="model_env_vars",
+            title="Model Configuration",
+            category=CheckCategory.ENVIRONMENT,
+            status=CheckStatus.PASS,
+            message="Using default model configuration (gpt-4o-mini)",
+            metadata={"default_model": "gpt-4o-mini"},
+        )