mobilerun-viewer 0.1.0__tar.gz

mobilerun_viewer-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,73 @@
+name: Publish 📦 to PyPI
+on: push
+
+jobs:
+  version-check:
+    name: Check version matches tag
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Compare tag to pyproject version
+      run: |
+        TAG="${GITHUB_REF#refs/tags/v}"
+        VERSION=$(sed -n 's/^version = "\(.*\)"/\1/p' pyproject.toml)
+        if [ "$TAG" != "$VERSION" ]; then
+          echo "::error::Tag v$TAG does not match pyproject.toml version $VERSION"
+          exit 1
+        fi
+        echo "Version check passed: v$VERSION"
+
+  build:
+    name: Build distribution 📦
+    needs:
+    - version-check
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: python3 -m pip install build --user
+    - name: Build
+      run: python3 -m build
+    - name: Verify the bundled viewer HTML is in the wheel
+      run: |
+        python3 - <<'PY'
+        import glob, zipfile, sys
+        whl = glob.glob("dist/mobilerun_viewer-*.whl")[0]
+        names = zipfile.ZipFile(whl).namelist()
+        assert any(n.endswith("static/index.html") for n in names), \
+            f"static/index.html missing from {whl}: {names}"
+        print(f"OK: {whl} contains the viewer HTML")
+        PY
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs:
+    - build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mobilerun-viewer
+    permissions:
+      id-token: write  # OIDC for PyPI Trusted Publishing — no token needed.
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

mobilerun_viewer-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.pyc
+.venv/
+.python-version
+dist/
+build/
+*.egg-info/
+.ruff_cache/
+.mypy_cache/
+.DS_Store

mobilerun_viewer-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: mobilerun-viewer
+Version: 0.1.0
+Summary: Native desktop viewer for Mobilerun cloud devices — live WebRTC stream, system nav buttons, and an action event panel.
+Project-URL: Homepage, https://github.com/droidrun/mobilerun-viewer
+Project-URL: Issues, https://github.com/droidrun/mobilerun-viewer/issues
+Author: Mobilerun
+License: MIT
+Keywords: android,automation,mobilerun,viewer,webrtc
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: MacOS X :: Cocoa
+Classifier: Environment :: X11 Applications
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: <3.14,>=3.11
+Requires-Dist: click>=8.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: pywebview>=5.0
+Requires-Dist: websockets>=14
+Description-Content-Type: text/markdown
+
+# mobilerun-viewer
+
+Native desktop viewer for [Mobilerun](https://mobilerun.ai) cloud devices.
+Renders the live WebRTC stream of a cloud-hosted phone in a desktop window
+with system nav buttons (BACK / HOME / RECENTS) and a side panel that
+shows every tool call (tap, swipe, press, …) in real time.
+
+Reuses the same credential as the `mobilerun` CLI — read from
+`MOBILERUN_API_KEY` or the file `mobilerun login` writes — so authenticating
+in either command works for both.
+
+## Install
+
+```bash
+uv tool install mobilerun-viewer
+# or:
+pip install mobilerun-viewer
+```
+
+## Use
+
+```bash
+# Discover your devices via the main CLI:
+mobilerun devices --cloud
+
+# Open the viewer:
+mobilerun-viewer -d <device-id>
+
+# Against a non-default API base (dev / staging):
+mobilerun-viewer -d <device-id> --base-url https://dev-api.mobilerun.ai/v1
+
+# Track an agent's task trajectory in the events panel:
+mobilerun-viewer -d <device-id> --task-id <task-id>
+```
+
+If the main `mobilerun` CLI is installed alongside this package, the same
+viewer is also reachable as `mobilerun stream …`.
+
+## Flags
+
+- `-d, --device-id` (required) — cloud device id.
+- `--base-url` — Mobilerun API base; default `https://api.mobilerun.ai/v1`.
+- `--task-id` — task whose trajectory feeds the events panel. Defaults to
+  the device's `activeTaskId` if one is running.
+- `--no-window` — don't open a desktop window; just print the local
+  viewer URL (useful for debugging).

mobilerun_viewer-0.1.0/README.md

@@ -0,0 +1,46 @@
+# mobilerun-viewer
+
+Native desktop viewer for [Mobilerun](https://mobilerun.ai) cloud devices.
+Renders the live WebRTC stream of a cloud-hosted phone in a desktop window
+with system nav buttons (BACK / HOME / RECENTS) and a side panel that
+shows every tool call (tap, swipe, press, …) in real time.
+
+Reuses the same credential as the `mobilerun` CLI — read from
+`MOBILERUN_API_KEY` or the file `mobilerun login` writes — so authenticating
+in either command works for both.
+
+## Install
+
+```bash
+uv tool install mobilerun-viewer
+# or:
+pip install mobilerun-viewer
+```
+
+## Use
+
+```bash
+# Discover your devices via the main CLI:
+mobilerun devices --cloud
+
+# Open the viewer:
+mobilerun-viewer -d <device-id>
+
+# Against a non-default API base (dev / staging):
+mobilerun-viewer -d <device-id> --base-url https://dev-api.mobilerun.ai/v1
+
+# Track an agent's task trajectory in the events panel:
+mobilerun-viewer -d <device-id> --task-id <task-id>
+```
+
+If the main `mobilerun` CLI is installed alongside this package, the same
+viewer is also reachable as `mobilerun stream …`.
+
+## Flags
+
+- `-d, --device-id` (required) — cloud device id.
+- `--base-url` — Mobilerun API base; default `https://api.mobilerun.ai/v1`.
+- `--task-id` — task whose trajectory feeds the events panel. Defaults to
+  the device's `activeTaskId` if one is running.
+- `--no-window` — don't open a desktop window; just print the local
+  viewer URL (useful for debugging).

mobilerun_viewer-0.1.0/mobilerun_viewer/__init__.py

@@ -0,0 +1,3 @@
+"""Native desktop viewer for Mobilerun cloud devices."""
+
+__version__ = "0.1.0"

mobilerun_viewer-0.1.0/mobilerun_viewer/cli.py

@@ -0,0 +1,144 @@
+"""``mobilerun-viewer`` — open a desktop window with a live cloud device."""
+
+from __future__ import annotations
+
+import sys
+from typing import Optional
+
+import click
+import httpx
+
+from mobilerun_viewer.creds import (
+    CLOUD_API_KEY_ENV,
+    DEFAULT_CLOUD_BASE_URL,
+    resolve_cloud_api_key,
+)
+from mobilerun_viewer.server import StreamServer
+
+APP_NAME = "Mobilerun Viewer"
+
+
+def _active_task_id(api_base: str, api_key: str, device_id: str) -> Optional[str]:
+    """Best-effort: read the device's currently-running task id, if any."""
+    try:
+        resp = httpx.get(
+            f"{api_base.rstrip('/')}/devices/{device_id}",
+            headers={
+                "Authorization": f"Bearer {api_key}",
+                "Accept": "application/json",
+            },
+            timeout=10.0,
+        )
+        if resp.status_code >= 400:
+            return None
+        data = resp.json()
+        return data.get("activeTaskId") or data.get("active_task_id")
+    except Exception:
+        return None
+
+
+def _set_macos_app_name(name: str) -> None:
+    """Make the Dock + menu bar show *name* instead of "python3.13".
+
+    pywebview's Cocoa backend reads ``CFBundleName`` from the main bundle's
+    info dict, so injecting it before ``webview.start()`` takes effect for
+    every menu label. Best-effort: silently no-op if PyObjC is missing or
+    we're not on macOS.
+    """
+    if sys.platform != "darwin":
+        return
+    try:
+        from Foundation import NSBundle  # type: ignore
+
+        bundle = NSBundle.mainBundle()
+        info = bundle.localizedInfoDictionary() or bundle.infoDictionary()
+        if info is not None:
+            info["CFBundleName"] = name
+            info["CFBundleDisplayName"] = name
+    except Exception:
+        pass
+    try:
+        sys.argv[0] = name
+    except Exception:
+        pass
+
+
+@click.command()
+@click.option(
+    "--device-id", "-d", "device_id", required=True, help="Cloud device id to stream"
+)
+@click.option(
+    "--base-url",
+    "base_url",
+    default=None,
+    help=f"Cloud API base URL (default {DEFAULT_CLOUD_BASE_URL})",
+)
+@click.option(
+    "--task-id",
+    "task_id",
+    default=None,
+    help="Task id whose actions to show in the events panel (default: device's active task)",
+)
+@click.option(
+    "--no-window",
+    is_flag=True,
+    default=False,
+    help="Don't open a window; print the local viewer URL",
+)
+def stream(
+    device_id: str,
+    base_url: Optional[str],
+    task_id: Optional[str],
+    no_window: bool,
+):
+    """Open a live view of a Mobilerun cloud device."""
+    api_key = resolve_cloud_api_key()
+    if not api_key:
+        raise click.ClickException(
+            f"No cloud API key found. Set {CLOUD_API_KEY_ENV} or run `mobilerun login`."
+        )
+    api_base = base_url or DEFAULT_CLOUD_BASE_URL
+
+    if not task_id:
+        task_id = _active_task_id(api_base, api_key, device_id)
+
+    server = StreamServer(
+        api_base_url=api_base,
+        api_key=api_key,
+        device_id=device_id,
+        task_id=task_id,
+    )
+    server.start()
+    try:
+        if no_window:
+            click.echo(server.url)
+            click.echo("Press Ctrl+C to stop.")
+            try:
+                import time
+
+                while True:
+                    time.sleep(1)
+            except KeyboardInterrupt:
+                pass
+            return
+
+        try:
+            import webview  # type: ignore
+        except ImportError:
+            raise click.ClickException(
+                "pywebview is missing. Reinstall mobilerun-viewer.\n"
+                "Or use --no-window."
+            )
+
+        # Rename the Dock + menu bar before webview.start() spins up NSApp.
+        _set_macos_app_name(APP_NAME)
+
+        webview.create_window(
+            f"{APP_NAME} • {device_id[:8]}",
+            server.url,
+            width=800,
+            height=920,
+        )
+        webview.start()  # blocks until the window is closed
+    finally:
+        server.stop()

mobilerun_viewer-0.1.0/mobilerun_viewer/creds.py

@@ -0,0 +1,45 @@
+"""Resolve the Mobilerun cloud API credential.
+
+Standalone: no dependency on the ``mobilerun`` framework. Reads the same
+file ``mobilerun login`` writes, so a single login authenticates both
+tools.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+from typing import Optional
+
+import platformdirs
+
+# Defaults shared with the mobilerun framework.
+CLOUD_API_KEY_ENV = "MOBILERUN_API_KEY"
+DEFAULT_CLOUD_BASE_URL = "https://api.mobilerun.ai/v1"
+
+# Same APP_NAME the mobilerun framework uses — they share one credentials dir.
+_APP_NAME = "droidrun"
+
+
+def _credential_file() -> Path:
+    return (
+        Path(platformdirs.user_config_dir(_APP_NAME))
+        / "credentials"
+        / "mobilerun-cloud.json"
+    )
+
+
+def resolve_cloud_api_key() -> Optional[str]:
+    """``MOBILERUN_API_KEY`` env var → saved login file → None."""
+    env_key = os.environ.get(CLOUD_API_KEY_ENV)
+    if env_key:
+        return env_key
+    try:
+        path = _credential_file()
+        if path.exists():
+            data = json.loads(path.read_text())
+            return data.get("api_key") or data.get("access_token") or None
+    except Exception:
+        pass
+    return None