droidrun 0.1.0__py3-none-any.whl

droidrun/cli/main.py

@@ -0,0 +1,265 @@
+"""
+DroidRun CLI - Command line interface for controlling Android devices through LLM agents.
+"""
+
+import asyncio
+import click
+import os
+from rich.console import Console
+from rich import print as rprint
+from droidrun.tools import DeviceManager
+from droidrun.agent import run_agent
+from functools import wraps
+
+# Import the install_app function directly for the setup command
+from droidrun.tools.actions import install_app
+
+console = Console()
+device_manager = DeviceManager()
+
+def coro(f):
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        return asyncio.run(f(*args, **kwargs))
+    return wrapper
+
+# Define the run command as a standalone function to be used as both a command and default
+@coro
+async def run_command(command: str, device: str | None, provider: str, model: str, steps: int, vision: bool):
+    """Run a command on your Android device using natural language."""
+    console.print(f"[bold blue]Executing command:[/] {command}")
+    
+    # Auto-detect Gemini if model starts with "gemini-"
+    if model and model.startswith("gemini-"):
+        provider = "gemini"
+    
+    # Print vision status
+    if vision:
+        console.print("[blue]Vision capabilities are enabled.[/]")
+    else:
+        console.print("[blue]Vision capabilities are disabled.[/]")
+    
+    # Get API keys from environment variables
+    api_key = None
+    if provider.lower() == 'openai':
+        api_key = os.environ.get('OPENAI_API_KEY')
+        if not api_key:
+            console.print("[bold red]Error:[/] OPENAI_API_KEY environment variable not set")
+            return
+        if not model:
+            model = "gpt-4o-mini"
+    elif provider.lower() == 'anthropic':
+        api_key = os.environ.get('ANTHROPIC_API_KEY')
+        if not api_key:
+            console.print("[bold red]Error:[/] ANTHROPIC_API_KEY environment variable not set")
+            return
+        if not model:
+            model = "claude-3-sonnet-20240229"
+    elif provider.lower() == 'gemini':
+        api_key = os.environ.get('GEMINI_API_KEY')
+        if not api_key:
+            console.print("[bold red]Error:[/] GEMINI_API_KEY environment variable not set")
+            return
+        if not model:
+            model = "gemini-2.0-flash"
+    else:
+        console.print(f"[bold red]Error:[/] Unsupported provider: {provider}")
+        return
+    
+    try:
+        # Try to find a device if none specified
+        if not device:
+            devices = await device_manager.list_devices()
+            if not devices:
+                console.print("[yellow]No devices connected.[/]")
+                return
+            
+            device = devices[0].serial
+            console.print(f"[blue]Using device:[/] {device}")
+        
+        # Set the device serial in the environment variable
+        os.environ["DROIDRUN_DEVICE_SERIAL"] = device
+        console.print(f"[blue]Set DROIDRUN_DEVICE_SERIAL to:[/] {device}")
+        
+        # Run the agent
+        console.print("[bold blue]Running ReAct agent...[/]")
+        console.print("[yellow]Press Ctrl+C to stop execution[/]")
+        
+        try:
+            steps = await run_agent(
+                task=command,
+                device_serial=device,  # Still pass for backward compatibility
+                llm_provider=provider,
+                model_name=model,
+                api_key=api_key,
+                vision=vision
+            )
+            
+            # Final message
+            console.print(f"[bold green]Execution completed with {len(steps)} steps[/]")
+        except ValueError as e:
+            if "does not support vision" in str(e):
+                console.print(f"[bold red]Vision Error:[/] {e}")
+                console.print("[yellow]Please specify a vision-capable model with the --model flag.[/]")
+                console.print("[blue]Recommended models:[/]")
+                console.print("  - OpenAI: gpt-4o or gpt-4-vision")
+                console.print("  - Anthropic: claude-3-opus-20240229 or claude-3-sonnet-20240229")
+                console.print("  - Gemini: gemini-pro-vision")
+                return
+            else:
+                raise  # Re-raise other ValueError exceptions
+        
+    except Exception as e:
+        console.print(f"[bold red]Error:[/] {e}")
+
+# Custom Click multi-command class to handle both subcommands and default behavior
+class DroidRunCLI(click.Group):
+    def parse_args(self, ctx, args):
+        # Check if the first argument might be a task rather than a command
+        if args and not args[0].startswith('-') and args[0] not in self.commands:
+            # Insert the 'run' command before the first argument if it's not a known command
+            args.insert(0, 'run')
+        return super().parse_args(ctx, args)
+
+@click.group(cls=DroidRunCLI)
+def cli():
+    """DroidRun - Control your Android device through LLM agents."""
+    pass
+
+@cli.command()
+@click.argument('command', type=str)
+@click.option('--device', '-d', help='Device serial number or IP address', default=None)
+@click.option('--provider', '-p', help='LLM provider (openai, anthropic, or gemini)', default='openai')
+@click.option('--model', '-m', help='LLM model name', default=None)
+@click.option('--steps', type=int, help='Maximum number of steps', default=15)
+@click.option('--vision', is_flag=True, help='Enable vision capabilities')
+def run(command: str, device: str | None, provider: str, model: str, steps: int, vision: bool):
+    """Run a command on your Android device using natural language."""
+    # Call our standalone function
+    return run_command(command, device, provider, model, steps, vision)
+
+@cli.command()
+@coro
+async def devices():
+    """List connected Android devices."""
+    try:
+        devices = await device_manager.list_devices()
+        if not devices:
+            console.print("[yellow]No devices connected.[/]")
+            return
+
+        console.print(f"[green]Found {len(devices)} connected device(s):[/]")
+        for device in devices:
+            console.print(f"  • [bold]{device.serial}[/]")
+    except Exception as e:
+        console.print(f"[red]Error listing devices: {e}[/]")
+
+@cli.command()
+@click.argument('ip_address')
+@click.option('--port', '-p', default=5555, help='ADB port (default: 5555)')
+@coro
+async def connect(ip_address: str, port: int):
+    """Connect to a device over TCP/IP."""
+    try:
+        device = await device_manager.connect(ip_address, port)
+        if device:
+            console.print(f"[green]Successfully connected to {ip_address}:{port}[/]")
+        else:
+            console.print(f"[red]Failed to connect to {ip_address}:{port}[/]")
+    except Exception as e:
+        console.print(f"[red]Error connecting to device: {e}[/]")
+
+@cli.command()
+@click.argument('serial')
+@coro
+async def disconnect(serial: str):
+    """Disconnect from a device."""
+    try:
+        success = await device_manager.disconnect(serial)
+        if success:
+            console.print(f"[green]Successfully disconnected from {serial}[/]")
+        else:
+            console.print(f"[yellow]Device {serial} was not connected[/]")
+    except Exception as e:
+        console.print(f"[red]Error disconnecting from device: {e}[/]")
+
+@cli.command()
+@click.option('--path', required=True, help='Path to the APK file to install')
+@click.option('--device', '-d', help='Device serial number or IP address', default=None)
+@coro
+async def setup(path: str, device: str | None):
+    """Install an APK file and enable it as an accessibility service."""
+    try:
+        # Check if APK file exists
+        if not os.path.exists(path):
+            console.print(f"[bold red]Error:[/] APK file not found at {path}")
+            return
+            
+        # Try to find a device if none specified
+        if not device:
+            devices = await device_manager.list_devices()
+            if not devices:
+                console.print("[yellow]No devices connected.[/]")
+                return
+            
+            device = devices[0].serial
+            console.print(f"[blue]Using device:[/] {device}")
+        
+        # Set the device serial in the environment variable
+        os.environ["DROIDRUN_DEVICE_SERIAL"] = device
+        console.print(f"[blue]Set DROIDRUN_DEVICE_SERIAL to:[/] {device}")
+        
+        # Get a device object for ADB commands
+        device_obj = await device_manager.get_device(device)
+        if not device_obj:
+            console.print(f"[bold red]Error:[/] Could not get device object for {device}")
+            return
+        
+        # Step 1: Install the APK file
+        console.print(f"[bold blue]Step 1/2: Installing APK:[/] {path}")
+        result = await install_app(path, False, True, device)
+        
+        if "Error" in result:
+            console.print(f"[bold red]Installation failed:[/] {result}")
+            return
+        else:
+            console.print(f"[bold green]Installation successful![/]")
+        
+        # Step 2: Enable the accessibility service with the specific command
+        console.print(f"[bold blue]Step 2/2: Enabling accessibility service[/]")
+        
+        # Package name for reference in error message
+        package = "com.droidrun.portal"
+        
+        try:
+            # Use the exact command provided
+            await device_obj._adb.shell(device, "settings put secure enabled_accessibility_services com.droidrun.portal/com.droidrun.portal.DroidrunPortalService")
+            
+            # Also enable accessibility services globally
+            await device_obj._adb.shell(device, "settings put secure accessibility_enabled 1")
+            
+            console.print("[green]Accessibility service enabled successfully![/]")
+            console.print("\n[bold green]Setup complete![/] The DroidRun Portal is now installed and ready to use.")
+            
+        except Exception as e:
+            console.print(f"[yellow]Could not automatically enable accessibility service: {e}[/]")
+            console.print("[yellow]Opening accessibility settings for manual configuration...[/]")
+            
+            # Fallback: Open the accessibility settings page
+            await device_obj._adb.shell(device, "am start -a android.settings.ACCESSIBILITY_SETTINGS")
+            
+            console.print("\n[yellow]Please complete the following steps on your device:[/]")
+            console.print(f"1. Find [bold]{package}[/] in the accessibility services list")
+            console.print("2. Tap on the service name")
+            console.print("3. Toggle the switch to [bold]ON[/] to enable the service")
+            console.print("4. Accept any permission dialogs that appear")
+            
+            console.print("\n[bold green]APK installation complete![/] Please manually enable the accessibility service using the steps above.")
+            
+    except Exception as e:
+        console.print(f"[bold red]Error:[/] {e}")
+        import traceback
+        traceback.print_exc()
+
+if __name__ == '__main__':
+    cli() 

droidrun/llm/__init__.py

@@ -0,0 +1,24 @@
+"""
+DroidRun LLM Module.
+
+This module provides LLM providers for the Agent to use for reasoning.
+"""
+
+from droidrun.agent.llm_reasoning import LLMReasoner as BaseLLM
+
+# Alias OpenAILLM and AnthropicLLM for backward compatibility
+class OpenAILLM(BaseLLM):
+    """
+    OpenAI-based LLM provider.
+    """
+    def __init__(self, model="gpt-4o", **kwargs):
+        super().__init__(provider="openai", model=model, **kwargs)
+
+class AnthropicLLM(BaseLLM):
+    """
+    Anthropic-based LLM provider.
+    """
+    def __init__(self, model="claude-3-opus-20240229", **kwargs):
+        super().__init__(provider="anthropic", model=model, **kwargs)
+
+__all__ = ["BaseLLM", "OpenAILLM", "AnthropicLLM"] 

droidrun/tools/__init__.py

@@ -0,0 +1,35 @@
+"""
+DroidRun Tools - Core functionality for Android device control.
+"""
+
+from .device import DeviceManager
+from .actions import (
+    tap,
+    swipe,
+    input_text,
+    press_key,
+    start_app,
+    install_app,
+    uninstall_app,
+    take_screenshot,
+    list_packages,
+    get_clickables,
+    complete,
+    extract,
+)
+
+__all__ = [
+    'DeviceManager',
+    'tap',
+    'swipe',
+    'input_text',
+    'press_key',
+    'start_app',
+    'install_app',
+    'uninstall_app',
+    'take_screenshot',
+    'list_packages',
+    'get_clickables',
+    'complete',
+    'extract',
+]