pybroswer 0.3.1__tar.gz

pybroswer-0.3.1/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: pybroswer
+Version: 0.3.1
+Summary: Python browser for PyDroid. Works on phone without Chromium or a PC host.
+Author: Hacker78
+License: MIT
+Project-URL: Homepage, https://github.com/prateeknishad305/Pybrowser
+Keywords: playwright,chromium,browser,pydroid,remote,automation
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+Provides-Extra: chromium
+Requires-Dist: playwright>=1.40; extra == "chromium"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+# pybroswer
+
+Python browser for **PyDroid**. No Chromium, Playwright, or PC host is required on the phone.
+
+`Browser.launch()` fetches pages with httpx and parses HTML. The same API also works with remote Chromium.
+
+## Install (PyDroid)
+
+```bash
+pip install httpx
+pip install https://github.com/prateeknishad305/Pybrowser/archive/refs/heads/master.zip
+```
+
+If that fails, install httpx first, then:
+
+```bash
+pip install git+https://github.com/prateeknishad305/Pybrowser.git
+```
+
+Import name:
+
+```python
+from pybroswer import Browser
+```
+
+`from pybrowser import Browser` also works.
+
+Check:
+
+```python
+import pybroswer
+print(pybroswer.__version__, pybroswer.__file__)
+```
+
+## PyDroid usage
+
+```python
+from pybroswer import Browser
+
+with Browser.launch() as browser:
+    shot = browser.browse("https://example.com")
+    print(shot.title, shot.url, shot.text)
+
+    with browser.create_session(device="mobile") as page:
+        page.goto("https://example.com")
+        print(page.evaluate("document.title"))
+        page.click("a")
+        page.type("hello", selector="input[name=q]")
+        page.press("Enter")
+        print(page.html()[:500])
+```
+
+`Browser()` with no URL also starts the local HTTP engine.
+
+## Optional: PC Chromium
+
+If you want real Chromium on a PC:
+
+```bash
+pip install "pybroswer[chromium]"
+playwright install chromium
+python -m pybroswer serve --port 5173
+```
+
+From PyDroid:
+
+```python
+from pybroswer import Browser
+with Browser.connect("http://192.168.1.10:5173") as browser:
+    ...
+```
+
+In-process on PC: `Browser.launch(engine="chromium")`.
+
+## Limits (phone HTTP engine)
+
+- JS-heavy SPAs are not rendered (you get the HTML the server sent)
+- Screenshot is a 1x1 placeholder PNG
+- `evaluate` only supports simple `document.title` / `querySelector` expressions
+- Iframe contents are not fetched separately
+- Click coordinates (`x, y`) require Chromium
+
+Forms, links, type/press/select, cookies, and redirects work.
+
+## API
+
+| Method | |
+|--------|--|
+| `Browser.launch()` | local HTTP engine (PyDroid default) |
+| `Browser.launch(engine="chromium")` | Playwright Chromium (PC) |
+| `Browser.connect(url)` | remote REST |
+| `browser.browse(url)` | one-shot open |
+| `page.goto` / `click` / `type` / `press` / `select` | session actions |
+| `page.evaluate("document.title")` | read page |
+| `page.html()` / `page.inspect(selector)` | DOM |

pybroswer-0.3.1/README.md

@@ -0,0 +1,95 @@
+# pybroswer
+
+Python browser for **PyDroid**. No Chromium, Playwright, or PC host is required on the phone.
+
+`Browser.launch()` fetches pages with httpx and parses HTML. The same API also works with remote Chromium.
+
+## Install (PyDroid)
+
+```bash
+pip install httpx
+pip install https://github.com/prateeknishad305/Pybrowser/archive/refs/heads/master.zip
+```
+
+If that fails, install httpx first, then:
+
+```bash
+pip install git+https://github.com/prateeknishad305/Pybrowser.git
+```
+
+Import name:
+
+```python
+from pybroswer import Browser
+```
+
+`from pybrowser import Browser` also works.
+
+Check:
+
+```python
+import pybroswer
+print(pybroswer.__version__, pybroswer.__file__)
+```
+
+## PyDroid usage
+
+```python
+from pybroswer import Browser
+
+with Browser.launch() as browser:
+    shot = browser.browse("https://example.com")
+    print(shot.title, shot.url, shot.text)
+
+    with browser.create_session(device="mobile") as page:
+        page.goto("https://example.com")
+        print(page.evaluate("document.title"))
+        page.click("a")
+        page.type("hello", selector="input[name=q]")
+        page.press("Enter")
+        print(page.html()[:500])
+```
+
+`Browser()` with no URL also starts the local HTTP engine.
+
+## Optional: PC Chromium
+
+If you want real Chromium on a PC:
+
+```bash
+pip install "pybroswer[chromium]"
+playwright install chromium
+python -m pybroswer serve --port 5173
+```
+
+From PyDroid:
+
+```python
+from pybroswer import Browser
+with Browser.connect("http://192.168.1.10:5173") as browser:
+    ...
+```
+
+In-process on PC: `Browser.launch(engine="chromium")`.
+
+## Limits (phone HTTP engine)
+
+- JS-heavy SPAs are not rendered (you get the HTML the server sent)
+- Screenshot is a 1x1 placeholder PNG
+- `evaluate` only supports simple `document.title` / `querySelector` expressions
+- Iframe contents are not fetched separately
+- Click coordinates (`x, y`) require Chromium
+
+Forms, links, type/press/select, cookies, and redirects work.
+
+## API
+
+| Method | |
+|--------|--|
+| `Browser.launch()` | local HTTP engine (PyDroid default) |
+| `Browser.launch(engine="chromium")` | Playwright Chromium (PC) |
+| `Browser.connect(url)` | remote REST |
+| `browser.browse(url)` | one-shot open |
+| `page.goto` / `click` / `type` / `press` / `select` | session actions |
+| `page.evaluate("document.title")` | read page |
+| `page.html()` / `page.inspect(selector)` | DOM |

pybroswer-0.3.1/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pybroswer"
+version = "0.3.1"
+description = "Python browser for PyDroid. Works on phone without Chromium or a PC host."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "Hacker78" }]
+keywords = ["playwright", "chromium", "browser", "pydroid", "remote", "automation"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27",
+]
+
+[project.optional-dependencies]
+chromium = [
+    "playwright>=1.40",
+]
+dev = [
+    "pytest>=8.0",
+]
+
+[project.scripts]
+pybroswer = "pybroswer.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/prateeknishad305/Pybrowser"
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

pybroswer-0.3.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pybroswer-0.3.1/src/pybroswer/__init__.py

@@ -0,0 +1,40 @@
+"""Python browser for PyDroid. HTTP engine in-app; optional remote Chromium."""
+
+from pybroswer.client import Browser
+from pybroswer.exceptions import ActionFailed, ApiError, EngineError, PyBroswerError, SessionNotFound
+from pybroswer.models import (
+    DevicePreset,
+    FrameInfo,
+    FrameTarget,
+    Health,
+    InspectResult,
+    LogEntry,
+    SessionInfo,
+    Snapshot,
+    UploadFile,
+    Viewport,
+)
+from pybroswer.session import Session
+
+__all__ = [
+    "ActionFailed",
+    "ApiError",
+    "Browser",
+    "DevicePreset",
+    "EngineError",
+    "FrameInfo",
+    "FrameTarget",
+    "Health",
+    "InspectResult",
+    "LogEntry",
+    "PyBroswerError",
+    "Session",
+    "SessionInfo",
+    "SessionNotFound",
+    "Snapshot",
+    "UploadFile",
+    "Viewport",
+    "__version__",
+]
+
+__version__ = "0.3.1"

pybroswer-0.3.1/src/pybroswer/__main__.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+import argparse
+
+from pybroswer.server import serve
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(prog="pybroswer", description="Local Chromium REST for PyDroid")
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    serve_p = sub.add_parser("serve", help="Start Chromium on this PC and expose REST for phones")
+    serve_p.add_argument("--host", default="0.0.0.0")
+    serve_p.add_argument("--port", type=int, default=5173)
+    serve_p.add_argument("--headed", action="store_true", help="Show the browser window")
+
+    args = parser.parse_args()
+    if args.cmd == "serve":
+        serve(host=args.host, port=args.port, headless=not args.headed)
+
+
+if __name__ == "__main__":
+    main()

pybroswer-0.3.1/src/pybroswer/_http.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+from typing import Any, Protocol
+
+import httpx
+
+from pybroswer.exceptions import ActionFailed, ApiError, SessionNotFound
+
+
+class Transport(Protocol):
+    base_url: str
+
+    def close(self) -> None: ...
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        expect_json: bool = True,
+    ) -> Any: ...
+
+
+class HttpTransport:
+    def __init__(
+        self,
+        base_url: str,
+        *,
+        timeout: float = 60.0,
+        headers: dict[str, str] | None = None,
+        client: httpx.Client | None = None,
+    ) -> None:
+        self.base_url = base_url.rstrip("/")
+        self._owns = client is None
+        self._client = client or httpx.Client(
+            base_url=self.base_url,
+            timeout=timeout,
+            headers={"Accept": "application/json", **(headers or {})},
+            follow_redirects=True,
+        )
+
+    def close(self) -> None:
+        if self._owns:
+            self._client.close()
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        expect_json: bool = True,
+    ) -> Any:
+        response = self._client.request(method, path, json=json, params=params)
+        if response.status_code == 404:
+            payload = _safe_json(response)
+            message = _error_message(payload, response)
+            if "session" in message.lower():
+                raise SessionNotFound(message, status_code=404, payload=payload)
+            raise ApiError(message, status_code=404, payload=payload)
+        if response.status_code >= 400:
+            payload = _safe_json(response)
+            raise ApiError(_error_message(payload, response), status_code=response.status_code, payload=payload)
+        if not expect_json:
+            return response.content
+        if not response.content:
+            return {}
+        ctype = response.headers.get("content-type", "")
+        if "application/json" not in ctype:
+            return response.content
+        data = response.json()
+        if isinstance(data, dict) and data.get("ok") is False and data.get("error"):
+            raise ActionFailed(str(data["error"]), status_code=response.status_code, payload=data)
+        return data
+
+
+def _safe_json(response: httpx.Response) -> dict[str, Any]:
+    try:
+        data = response.json()
+    except Exception:
+        return {"error": response.text}
+    return data if isinstance(data, dict) else {"error": data}
+
+
+def _error_message(payload: dict[str, Any], response: httpx.Response) -> str:
+    return str(payload.get("error") or response.reason_phrase or f"HTTP {response.status_code}")

pybroswer-0.3.1/src/pybroswer/client.py

@@ -0,0 +1,155 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pybroswer._http import HttpTransport, Transport
+from pybroswer.models import (
+    DeviceName,
+    DevicePreset,
+    Health,
+    SessionInfo,
+    Snapshot,
+    presets_from,
+    session_info_from,
+    snapshot_from,
+)
+from pybroswer.session import Session
+
+
+class Browser:
+    def __init__(
+        self,
+        base_url: str | None = None,
+        *,
+        timeout: float = 60.0,
+        headers: dict[str, str] | None = None,
+        transport: Transport | None = None,
+        engine: Any | None = None,
+    ) -> None:
+        if transport is not None:
+            self._http: Transport = transport
+        elif engine is not None:
+            from pybroswer.engine import EngineTransport
+
+            self._http = EngineTransport(engine, owns=False)
+        elif base_url:
+            self._http = HttpTransport(base_url, timeout=timeout, headers=headers)
+        else:
+            self._http = _http_engine_transport(max_sessions=5, idle_ms=10 * 60 * 1000, timeout=timeout)
+
+    @classmethod
+    def launch(
+        cls,
+        *,
+        engine: str = "http",
+        headless: bool = True,
+        max_sessions: int = 5,
+        idle_ms: int = 10 * 60 * 1000,
+        timeout: float = 30.0,
+        executable_path: str | None = None,
+        channel: str | None = None,
+    ) -> Browser:
+        from pybroswer.engine import EngineTransport
+
+        if engine in {"chromium", "playwright"}:
+            from pybroswer.engine import ChromiumEngine
+
+            chromium = ChromiumEngine(
+                headless=headless,
+                max_sessions=max_sessions,
+                idle_ms=idle_ms,
+                executable_path=executable_path,
+                channel=channel,
+            )
+            chromium.start()
+            return cls(transport=EngineTransport(chromium, owns=True))
+        return cls(transport=_http_engine_transport(max_sessions=max_sessions, idle_ms=idle_ms, timeout=timeout))
+
+    @classmethod
+    def connect(
+        cls,
+        url: str = "http://127.0.0.1:5173",
+        *,
+        timeout: float = 60.0,
+        headers: dict[str, str] | None = None,
+    ) -> Browser:
+        return cls(url, timeout=timeout, headers=headers)
+
+    def close(self) -> None:
+        self._http.close()
+
+    def health(self) -> Health:
+        data = self._http.request("GET", "/api/v1/health")
+        return Health(
+            ok=bool(data.get("ok")),
+            service=data.get("service"),
+            engine=data.get("engine"),
+            sessions=int(data.get("sessions") or 0),
+            max_sessions=int(data.get("maxSessions") or 0),
+            error=data.get("error"),
+        )
+
+    def ua_presets(self) -> list[DevicePreset]:
+        data = self._http.request("GET", "/api/v1/ua")
+        return presets_from(data.get("presets"))
+
+    def sessions(self) -> list[SessionInfo]:
+        data = self._http.request("GET", "/api/v1/sessions")
+        return [session_info_from(item) for item in data.get("sessions") or []]
+
+    def create_session(
+        self,
+        *,
+        device: DeviceName | str = "mobile",
+        url: str | None = None,
+        user_agent: str | None = None,
+        width: int | None = None,
+        height: int | None = None,
+    ) -> Session:
+        body: dict[str, Any] = {"device": device}
+        if url:
+            body["url"] = url
+        if user_agent:
+            body["userAgent"] = user_agent
+        if width is not None:
+            body["width"] = width
+        if height is not None:
+            body["height"] = height
+        data = self._http.request("POST", "/api/v1/sessions", json=body)
+        return Session(self._http, str(data["id"]))
+
+    def session(self, session_id: str) -> Session:
+        return Session(self._http, session_id)
+
+    def browse(
+        self,
+        url: str,
+        *,
+        device: DeviceName | str = "desktop",
+        user_agent: str | None = None,
+        width: int | None = None,
+        height: int | None = None,
+    ) -> Snapshot:
+        body: dict[str, Any] = {"url": url, "device": device}
+        if user_agent:
+            body["userAgent"] = user_agent
+        if width is not None:
+            body["width"] = width
+        if height is not None:
+            body["height"] = height
+        return snapshot_from(self._http.request("POST", "/api/v1/browse", json=body))
+
+    def __enter__(self) -> Browser:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+
+def _http_engine_transport(*, max_sessions: int, idle_ms: int, timeout: float) -> Any:
+    from pybroswer.engine import EngineTransport
+    from pybroswer.http_engine import HttpEngine
+
+    engine = HttpEngine(max_sessions=max_sessions, idle_ms=idle_ms, timeout=timeout)
+    engine.start()
+    return EngineTransport(engine, owns=True)