mobilerun 0.6.0__py3-none-any.whl

mobilerun/__init__.py

@@ -0,0 +1,102 @@
+"""
+Mobilerun - A framework for controlling Android devices through LLM agents.
+"""
+
+import logging
+from importlib.metadata import version
+
+__version__ = version("mobilerun")
+
+# Attach a default CLILogHandler so that every consumer (CLI, TUI, SDK,
+# tools-only) gets visible output without explicit setup.  CLI and TUI
+# replace this with their own handler via ``configure_logging()``.
+from mobilerun.log_handlers import CLILogHandler
+
+_logger = logging.getLogger("mobilerun")
+_logger.addHandler(CLILogHandler())
+_logger.setLevel(logging.INFO)
+_logger.propagate = False
+
+# Import main classes for easier access
+from mobilerun.agent import ResultEvent  # noqa: E402
+from mobilerun.agent.droid import MobileAgent  # noqa: E402
+from mobilerun.agent.utils.llm_picker import load_llm  # noqa: E402
+
+# Import configuration classes
+from mobilerun.config_manager import (  # noqa: E402
+    # Agent configs
+    AgentConfig,
+    AppCardConfig,
+    CredentialsConfig,
+    # Feature configs
+    DeviceConfig,
+    ExecutorConfig,
+    FastAgentConfig,
+    LLMProfile,
+    LoggingConfig,
+    ManagerConfig,
+    MobileConfig,
+    TelemetryConfig,
+    ToolsConfig,
+    TracingConfig,
+)
+
+# Import macro functionality
+from mobilerun.macro import (  # noqa: E402
+    MacroPlayer,
+    replay_macro_file,
+    replay_macro_folder,
+)
+from mobilerun.tools import AndroidDriver, DeviceDriver, RecordingDriver  # noqa: E402
+
+# Make main components available at package level
+__all__ = [
+    # Agent
+    "MobileAgent",
+    "load_llm",
+    "ResultEvent",
+    # Tools / Drivers
+    "DeviceDriver",
+    "AndroidDriver",
+    "RecordingDriver",
+    # Macro
+    "MacroPlayer",
+    "replay_macro_file",
+    "replay_macro_folder",
+    # Configuration
+    "MobileConfig",
+    "AgentConfig",
+    "FastAgentConfig",
+    "ManagerConfig",
+    "ExecutorConfig",
+    "AppCardConfig",
+    "DeviceConfig",
+    "LoggingConfig",
+    "TracingConfig",
+    "TelemetryConfig",
+    "ToolsConfig",
+    "CredentialsConfig",
+    "LLMProfile",
+]
+
+# Legacy aliases — deprecated, will be removed in v0.8.0
+_LEGACY_ALIASES = {
+    "DroidAgent": "MobileAgent",
+    "DroidAgentState": "MobileAgentState",
+    "DroidConfig": "MobileConfig",
+}
+
+
+def __getattr__(name):
+    if name in _LEGACY_ALIASES:
+        import warnings
+
+        new_name = _LEGACY_ALIASES[name]
+        warnings.warn(
+            f"{name} has been renamed to {new_name}. "
+            f"Update your code to use {new_name}.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return globals()[new_name]
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

mobilerun/__main__.py

@@ -0,0 +1,8 @@
+"""
+Mobilerun main entry point
+"""
+
+from mobilerun.cli.main import cli
+
+if __name__ == "__main__":
+    cli()

mobilerun/agent/__init__.py

@@ -0,0 +1,3 @@
+from mobilerun.agent.droid.events import ResultEvent
+
+__all__ = ["ResultEvent"]

mobilerun/agent/action_context.py

@@ -0,0 +1,41 @@
+"""ActionContext — composed bag of dependencies for action functions.
+
+Replaces the ``tools=tools_instance`` parameter that action functions
+previously received.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Optional
+
+if TYPE_CHECKING:
+    from mobilerun.agent.droid.state import MobileAgentState
+    from mobilerun.credential_manager import CredentialManager
+    from mobilerun.macro.recorder import MacroRecorder
+    from mobilerun.tools.driver.base import DeviceDriver
+    from mobilerun.tools.ui.provider import StateProvider
+    from mobilerun.tools.ui.state import UIState
+
+
+class ActionContext:
+    """Everything an action function needs to interact with the device."""
+
+    def __init__(
+        self,
+        driver: "DeviceDriver",
+        ui: "Optional[UIState]",
+        shared_state: "MobileAgentState",
+        state_provider: "StateProvider",
+        app_opener_llm=None,
+        credential_manager: "Optional[CredentialManager]" = None,
+        streaming: bool = False,
+        macro_recorder: "Optional[MacroRecorder]" = None,
+    ) -> None:
+        self.driver = driver
+        self.ui = ui  # refreshed each step before tool execution
+        self.shared_state = shared_state
+        self.state_provider = state_provider
+        self.app_opener_llm = app_opener_llm
+        self.credential_manager = credential_manager
+        self.streaming = streaming
+        self.macro_recorder = macro_recorder

mobilerun/agent/action_result.py

@@ -0,0 +1,16 @@
+"""ActionResult — structured return type from action functions."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass
+class ActionResult:
+    """What the agent sees after an action runs."""
+
+    success: bool
+    summary: str
+
+    def __str__(self) -> str:
+        return self.summary

mobilerun/agent/common/constants.py

@@ -0,0 +1,3 @@
+"""Max number of recent conversation steps to include in LLM prompt"""
+
+LLM_HISTORY_LIMIT = 100

mobilerun/agent/common/events.py

@@ -0,0 +1,20 @@
+from typing import Any, Dict
+
+from llama_index.core.workflow import Event
+
+
+class ScreenshotEvent(Event):
+    screenshot: bytes
+
+
+class RecordUIStateEvent(Event):
+    ui_state: list[Dict[str, Any]]
+
+
+class ToolExecutionEvent(Event):
+    """Emitted after every tool call dispatched through ToolRegistry."""
+
+    tool_name: str
+    tool_args: Dict[str, Any]
+    success: bool
+    summary: str

mobilerun/agent/droid/__init__.py

@@ -0,0 +1,30 @@
+"""
+Mobilerun Agent Module.
+
+This module provides a ReAct agent for automating Android devices using reasoning and acting.
+"""
+
+from mobilerun.agent.droid.droid_agent import MobileAgent
+from mobilerun.agent.droid.state import MobileAgentState
+
+# Legacy aliases for backward compatibility
+_LEGACY_ALIASES = {
+    "DroidAgent": MobileAgent,
+    "DroidAgentState": MobileAgentState,
+}
+
+
+def __getattr__(name):
+    if name in _LEGACY_ALIASES:
+        import warnings
+
+        warnings.warn(
+            f"{name} has been renamed. Update your imports.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return _LEGACY_ALIASES[name]
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = ["MobileAgent", "MobileAgentState", "DroidAgent", "DroidAgentState"]