Merge pull request #10 from cmpnd-ai/isaac/dependency-test

Add testing workflow and require local installation

Author: isaacbmiller

.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: blacksmith-4vcpu-ubuntu-2404
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies and run tests
+        run: |
+          uv sync --all-extras
+          uv run pytest

README.md

@@ -5,7 +5,7 @@ A command-line interface tool for creating and serving DSPy projects, inspired b
 ## Installation
 
 ```bash
-pip install dspy-cli
+uv add dspy-cli
 ```
 
 ### Installing for Development/Testing
@@ -16,8 +16,8 @@ If you're testing or developing dspy-cli itself:
 # Clone or navigate to the dspy-cli repository
 cd /path/to/dspy-cli
 
-# Install in editable mode
-pip install -e .
+# Sync dependencies
+uv sync --extra dev
 
 # Now the dspy-cli command is available
 dspy-cli --help

examples/blog-tools/uv.lock

@@ -54,6 +54,9 @@ target-version = ["py39"]
 line-length = 120
 target-version = "py39"
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 [dependency-groups]
 dev = [
     "docker>=7.1.0",

pyproject.toml

@@ -23,7 +23,13 @@
     default=None,
     help='Inline signature string (e.g., "question -> answer" or "post -> tags: list[str]")',
 )
-def new(project_name, program_name, signature):
+@click.option(
+    "--link-dspy-cli",
+    type=click.Path(exists=True, file_okay=False, dir_okay=True),
+    default=None,
+    help="Add a uv path override for local dspy-cli development",
+)
+def new(project_name, program_name, signature, link_dspy_cli):
     """Create a new DSPy project with boilerplate structure.
 
     Creates a directory with PROJECT_NAME and sets up a complete
@@ -86,6 +92,9 @@ def new(project_name, program_name, signature):
         # Create configuration files
         _create_config_files(project_path, project_name, program_name, package_name)
 
+        # Add uv path override if requested
+        _add_uv_override_if_requested(project_path, link_dspy_cli)
+
         # Create Python code files
         _create_code_files(project_path, package_name, program_name, signature, signature_fields)
 
@@ -97,7 +106,8 @@ def new(project_name, program_name, signature):
         click.echo("Next steps:")
         click.echo(f"  cd {project_name}")
         click.echo("  # Edit .env and add your API keys")
-        click.echo("  pip install -e .")
+        click.echo("  uv sync")
+        click.echo("  source .venv/bin/activate")
         click.echo("  dspy-cli serve")
 
     except Exception as e:
@@ -128,6 +138,31 @@ def _create_directory_structure(project_path, package_name, program_name):
         click.echo(f"  Created: {directory.relative_to(project_path.parent)}")
 
 
+def _add_uv_override_if_requested(project_path, link_dspy_cli):
+    """Add uv path override for dspy-cli if requested."""
+    # Check flag or environment variable
+    link = link_dspy_cli or os.getenv("DSPY_CLI_PATH")
+    if not link:
+        return
+    
+    # Convert to relative path
+    link_path = Path(link).resolve()
+    try:
+        rel_path = os.path.relpath(link_path, project_path)
+    except ValueError:
+        # Different drives on Windows, use absolute
+        rel_path = str(link_path)
+    
+    # Append uv.sources block
+    uv_block = f'\n[tool.uv.sources]\ndspy-cli = {{ path = "{rel_path}", editable = true }}\n'
+    pyproject_path = project_path / "pyproject.toml"
+    current_content = pyproject_path.read_text()
+    pyproject_path.write_text(current_content + uv_block)
+    
+    click.echo(click.style(f"  Added uv path override: dspy-cli -> {rel_path}", fg="cyan"))
+    click.echo(click.style("  Note: This is for local development only - do not commit this override", fg="yellow"))
+
+
 def _create_config_files(project_path, project_name, program_name, package_name):
     """Create configuration files from templates."""
     from dspy_cli.templates import code_templates

src/dspy_cli/commands/new.py

@@ -1,21 +1,58 @@
 """Command to serve DSPy programs as an API."""
 
+import os
+import shlex
+import subprocess
 import sys
 from pathlib import Path
+from typing import NoReturn
 
 import click
-import uvicorn
 
-from dspy_cli.config import ConfigError, load_config
-from dspy_cli.config.validator import find_package_directory, validate_project_structure
-from dspy_cli.server.app import create_app
+from dspy_cli.server.runner import main as runner_main
+from dspy_cli.utils.venv import (
+    detect_venv_python,
+    has_package,
+    is_in_project_venv,
+    sanitize_env_for_exec,
+    show_install_instructions,
+    show_venv_warning,
+    validate_python_version,
+)
+
+
+def _exec_clean(target_python: Path, args: list[str]) -> NoReturn:
+    """Execute the server using the target Python with a clean environment."""
+    env = sanitize_env_for_exec()
+    cmd = [str(target_python)] + args
+    
+    # On Windows, os.execvpe has issues (Python bug #19124), use subprocess
+    if sys.platform == "win32":
+        try:
+            result = subprocess.run(cmd, env=env)
+            sys.exit(result.returncode)
+        except FileNotFoundError:
+            click.echo(click.style(f"Error: Python interpreter not found: {target_python}", fg="red"), err=True)
+            sys.exit(1)
+        except PermissionError:
+            click.echo(click.style(f"Error: Permission denied executing: {target_python}", fg="red"), err=True)
+            sys.exit(1)
+        except KeyboardInterrupt:
+            sys.exit(130)
+    else:
+        # Unix: use exec for efficient process replacement
+        try:
+            os.execvpe(str(target_python), cmd, env)
+        except OSError as e:
+            click.echo(click.style(f"Error executing {target_python}: {e}", fg="red"), err=True)
+            sys.exit(1)
 
 
 @click.command()
 @click.option(
     "--port",
     default=8000,
-    type=int,
+    type=click.IntRange(1, 65535),
     help="Port to run the server on (default: 8000)",
 )
 @click.option(
@@ -35,7 +72,18 @@
     is_flag=True,
     help="Enable web UI for interactive testing",
 )
-def serve(port, host, logs_dir, ui):
+@click.option(
+    "--python",
+    default=None,
+    type=click.Path(exists=True, dir_okay=False),
+    help="Path to Python interpreter to use (default: auto-detect)",
+)
+@click.option(
+    "--system",
+    is_flag=True,
+    help="Use system Python environment instead of project venv",
+)
+def serve(port, host, logs_dir, ui, python, system):
     """Start an HTTP API server that exposes your DSPy programs.
 
     This command:
@@ -47,107 +95,68 @@ def serve(port, host, logs_dir, ui):
     Example:
         dspy-cli serve
         dspy-cli serve --port 8080 --host 127.0.0.1
+        dspy-cli serve --python /path/to/venv/bin/python
     """
-    click.echo("Starting DSPy API server...")
-    click.echo()
-
-    # Validate project structure
-    if not validate_project_structure():
-        click.echo(click.style("Error: Not a valid DSPy project directory", fg="red"))
-        click.echo()
-        click.echo("Make sure you're in a directory created with 'dspy-cli new'")
-        click.echo("Required files: dspy.config.yaml, src/")
-        raise click.Abort()
-
-    # Find package directory
-    package_dir = find_package_directory()
-    if not package_dir:
-        click.echo(click.style("Error: Could not find package in src/", fg="red"))
-        raise click.Abort()
-
-    package_name = package_dir.name
-    modules_path = package_dir / "modules"
-
-    if not modules_path.exists():
-        click.echo(click.style(f"Error: modules directory not found: {modules_path}", fg="red"))
-        raise click.Abort()
-
-    # Load configuration
-    try:
-        config = load_config()
-    except ConfigError as e:
-        click.echo(click.style(f"Configuration error: {e}", fg="red"))
-        raise click.Abort()
-
-    click.echo(click.style("✓ Configuration loaded", fg="green"))
-
-    # Create logs directory
-    if logs_dir:
-        logs_path = Path(logs_dir)
-    else:
-        logs_path = Path.cwd() / "logs"
-    logs_path.mkdir(exist_ok=True)
-
-    # Create FastAPI app
-    try:
-        app = create_app(
-            config=config,
-            package_path=modules_path,
-            package_name=f"{package_name}.modules",
-            logs_dir=logs_path,
-            enable_ui=ui
-        )
-    except Exception as e:
-        click.echo(click.style(f"Error creating application: {e}", fg="red"))
-        raise click.Abort()
-
-    # Print discovered programs
-    click.echo()
-    click.echo(click.style("Discovered Programs:", fg="cyan", bold=True))
-    click.echo()
-
-    if hasattr(app.state, 'modules') and app.state.modules:
-        for module in app.state.modules:
-            click.echo(f"  • {module.name}")
-            click.echo(f"    POST /{module.name}")
+    if system:
+        runner_main(port=port, host=host, logs_dir=logs_dir, ui=ui)
+        return
+    
+    target_python = None
+    if python:
+        target_python = Path(python)
+        
+        # Validate it's actually a Python interpreter
+        if not target_python.is_file():
+            click.echo(click.style(f"Error: Not a valid Python executable: {target_python}", fg="red"), err=True)
+            sys.exit(1)
+        
+        # On Unix, check if executable
+        if sys.platform != "win32" and not os.access(target_python, os.X_OK):
+            click.echo(click.style(f"Error: Python interpreter is not executable: {target_python}", fg="red"), err=True)
+            sys.exit(1)
+        
+        # Validate Python version
+        is_valid, version = validate_python_version(target_python, min_version=(3, 9))
+        if not is_valid:
+            if version:
+                click.echo(click.style(f"Error: Python {version} is too old. Minimum required: Python 3.9", fg="red"), err=True)
+            else:
+                click.echo(click.style(f"Error: Could not determine Python version for: {target_python}", fg="red"), err=True)
+            sys.exit(1)
+    elif not is_in_project_venv():
+        target_python = detect_venv_python()
+        if not target_python:
+            show_venv_warning()
+    
+    if target_python:
+        import dspy_cli
+        
+        has_cli, local_version = has_package(target_python, "dspy_cli")
+        
+        if not has_cli:
+            global_version = dspy_cli.__version__
+            show_install_instructions(target_python, global_version)
+            sys.exit(1)
+        
+        if local_version:
+            global_version = dspy_cli.__version__
+            local_major = local_version.split('.')[0]
+            global_major = global_version.split('.')[0]
+            
+            if local_major != global_major:
+                click.echo(click.style(
+                    f"⚠ Version mismatch: local dspy-cli {local_version} vs global {global_version}",
+                    fg="yellow"
+                ))
+                click.echo(f"Consider upgrading: {shlex.quote(str(target_python))} -m uv add 'dspy-cli=={global_version}'")
+                click.echo()
+        
+        args = ["-m", "dspy_cli.server.runner", "--port", str(port), "--host", host]
+        if logs_dir:
+            args.extend(["--logs-dir", logs_dir])
+        if ui:
+            args.append("--ui")
+        
+        _exec_clean(target_python, args)
     else:
-        click.echo(click.style("  No programs discovered", fg="yellow"))
-        click.echo()
-        click.echo("Make sure your DSPy modules:")
-        click.echo("  1. Are in src/<package>/modules/")
-        click.echo("  2. Subclass dspy.Module")
-        click.echo("  3. Are not named with a leading underscore")
-
-    click.echo()
-    click.echo(click.style("Additional Endpoints:", fg="cyan", bold=True))
-    click.echo()
-    click.echo("  GET /programs - List all programs and their schemas")
-    if ui:
-        click.echo("  GET / - Web UI for interactive testing")
-    click.echo()
-
-    # Print server information
-    click.echo(click.style("=" * 60, fg="cyan"))
-    click.echo(click.style(f"Server starting on http://{host}:{port}", fg="green", bold=True))
-    click.echo(click.style("=" * 60, fg="cyan"))
-    click.echo()
-    click.echo("Press Ctrl+C to stop the server")
-    click.echo()
-
-    # Start uvicorn server
-    try:
-        uvicorn.run(
-            app,
-            host=host,
-            port=port,
-            log_level="info",
-            access_log=True
-        )
-    except KeyboardInterrupt:
-        click.echo()
-        click.echo(click.style("Server stopped", fg="yellow"))
-        sys.exit(0)
-    except Exception as e:
-        click.echo()
-        click.echo(click.style(f"Server error: {e}", fg="red"))
-        sys.exit(1)
+        runner_main(port=port, host=host, logs_dir=logs_dir, ui=ui)

src/dspy_cli/commands/serve.py

@@ -122,6 +122,17 @@ def discover_modules(
                     )
                 )
 
+        except ModuleNotFoundError as e:
+            logger.error(f"Error loading module {py_file}: {e}")
+            logger.warning(
+                f"\n⚠  Missing dependency detected while importing {py_file.name}\n"
+                f"   This might be because you are using a global dspy-cli install rather than a local one.\n\n"
+                f"   To fix this:\n"
+                f"   1. Install dependencies: uv sync (or pip install -e .)\n"
+                f"   2. Run from within the venv: source .venv/bin/activate && dspy-cli serve\n"
+                f"   3. Or use a task runner: uv run dspy-cli serve\n"
+            )
+            continue
         except Exception as e:
             logger.error(f"Error loading module {py_file}: {e}", exc_info=True)
             continue