modcdp 0.0.2__tar.gz → 0.0.4__tar.gz

modcdp-0.0.4/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: modcdp
+Version: 0.0.4
+Summary: Python client for ModCDP.
+Project-URL: Repository, https://github.com/pirate/ModCDP
+Requires-Python: >=3.10
+Requires-Dist: websocket-client>=1.8.0
+Description-Content-Type: text/markdown
+
+# ModCDP
+
+ModCDP is a small Chrome DevTools Protocol client and extension bridge. It connects to Chrome over CDP, discovers or injects the ModCDP extension service worker, and routes normal CDP commands, custom commands, and custom events through the same client API.
+
+This package contains the Python client. It mirrors the JavaScript and Go clients so SDKs can use the same option names and behavior across languages.
+
+## Install
+
+```sh
+pip install modcdp
+```
+
+## Basic Usage
+
+```python
+from modcdp import ModCDPClient
+
+cdp = ModCDPClient().connect()
+version = cdp.send("Browser.getVersion")
+print(version)
+cdp.close()
+```
+
+When no `cdp_url` is provided, the client can launch a local browser and load the bundled ModCDP extension. The package includes the extension zip used for automatic injection.
+
+## Options
+
+The Python constructor mirrors the JavaScript and Go clients:
+
+- `cdp_url`: upstream CDP HTTP or websocket URL.
+- `extension_path`: extension directory or zip. Defaults to the bundled extension zip.
+- `routes`: client-side route map such as `{ "Mod.*": "service_worker", "*.*": "direct_cdp" }`.
+- `server`: service-worker server config, including `loopback_cdp_url` and `routes`.
+- `custom_commands`: custom commands registered during connect.
+- `custom_events`: custom events registered during connect.
+- `custom_middlewares`: custom request/response/event middleware registered during connect.
+- `service_worker_url_includes` and `service_worker_url_suffixes`: service-worker discovery filters.
+- `scan_for_existing_localhost_9222`: attach to localhost Chrome before launching a new browser.
+- `mirror_upstream_events`: mirror upstream CDP events through the ModCDP service worker.
+- `*_timeout_ms` and `*_interval_ms`: override CDP send, websocket connect, service-worker probe, event wait, and polling timings.
+
+## Custom Commands And Events
+
+```python
+from modcdp import ModCDPClient
+
+cdp = ModCDPClient(
+    custom_commands=[
+        {
+            "name": "Custom.echo",
+            "expression": "(params) => ({ value: params.value })",
+        }
+    ],
+    custom_events=[
+        {
+            "name": "Custom.ready",
+        }
+    ],
+).connect()
+
+print(cdp.send("Custom.echo", {"value": "hello"}))
+cdp.close()
+```
+
+## Repository
+
+Source, examples, JavaScript client, Go client, and extension implementation live at:
+
+https://github.com/pirate/ModCDP

modcdp-0.0.4/README.md

@@ -0,0 +1,69 @@
+# ModCDP
+
+ModCDP is a small Chrome DevTools Protocol client and extension bridge. It connects to Chrome over CDP, discovers or injects the ModCDP extension service worker, and routes normal CDP commands, custom commands, and custom events through the same client API.
+
+This package contains the Python client. It mirrors the JavaScript and Go clients so SDKs can use the same option names and behavior across languages.
+
+## Install
+
+```sh
+pip install modcdp
+```
+
+## Basic Usage
+
+```python
+from modcdp import ModCDPClient
+
+cdp = ModCDPClient().connect()
+version = cdp.send("Browser.getVersion")
+print(version)
+cdp.close()
+```
+
+When no `cdp_url` is provided, the client can launch a local browser and load the bundled ModCDP extension. The package includes the extension zip used for automatic injection.
+
+## Options
+
+The Python constructor mirrors the JavaScript and Go clients:
+
+- `cdp_url`: upstream CDP HTTP or websocket URL.
+- `extension_path`: extension directory or zip. Defaults to the bundled extension zip.
+- `routes`: client-side route map such as `{ "Mod.*": "service_worker", "*.*": "direct_cdp" }`.
+- `server`: service-worker server config, including `loopback_cdp_url` and `routes`.
+- `custom_commands`: custom commands registered during connect.
+- `custom_events`: custom events registered during connect.
+- `custom_middlewares`: custom request/response/event middleware registered during connect.
+- `service_worker_url_includes` and `service_worker_url_suffixes`: service-worker discovery filters.
+- `scan_for_existing_localhost_9222`: attach to localhost Chrome before launching a new browser.
+- `mirror_upstream_events`: mirror upstream CDP events through the ModCDP service worker.
+- `*_timeout_ms` and `*_interval_ms`: override CDP send, websocket connect, service-worker probe, event wait, and polling timings.
+
+## Custom Commands And Events
+
+```python
+from modcdp import ModCDPClient
+
+cdp = ModCDPClient(
+    custom_commands=[
+        {
+            "name": "Custom.echo",
+            "expression": "(params) => ({ value: params.value })",
+        }
+    ],
+    custom_events=[
+        {
+            "name": "Custom.ready",
+        }
+    ],
+).connect()
+
+print(cdp.send("Custom.echo", {"value": "hello"}))
+cdp.close()
+```
+
+## Repository
+
+Source, examples, JavaScript client, Go client, and extension implementation live at:
+
+https://github.com/pirate/ModCDP

{modcdp-0.0.2 → modcdp-0.0.4}/modcdp/ModCDPClient.py

@@ -165,6 +165,11 @@ def _json_object(value: JsonValue | None) -> ProtocolResult:
     return value if isinstance(value, dict) else {}
 
 
+def default_extension_path() -> str | None:
+    bundled_extension = Path(__file__).resolve().parent / "extension.zip"
+    return str(bundled_extension) if bundled_extension.exists() else None
+
+
 def modcdp_server_path(extension_path: str) -> Path:
     candidates = [Path(extension_path) / "ModCDPServer.js"]
     for parent in Path(__file__).resolve().parents:
@@ -224,7 +229,7 @@ class ModCDPClient:
         launch_options: LaunchOptions | None = None,
     ) -> None:
         self.cdp_url: str | None = cdp_url
-        self.extension_path: str | None = extension_path
+        self.extension_path: str | None = extension_path or default_extension_path()
         self.routes: ModCDPRoutes = {**DEFAULT_CLIENT_ROUTES, **dict(routes or {})}
         if server is DEFAULT_SERVER:
             self.server: ModCDPServerConfig | None = {}

{modcdp-0.0.2 → modcdp-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "modcdp"
-version = "0.0.2"
+version = "0.0.4"
 description = "Python client for ModCDP."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -15,6 +15,10 @@ Repository = "https://github.com/pirate/ModCDP"
 
 [tool.hatch.build.targets.wheel]
 packages = ["modcdp"]
+artifacts = ["modcdp/extension.zip"]
+
+[tool.hatch.build.targets.sdist]
+artifacts = ["modcdp/extension.zip"]
 
 [dependency-groups]
 dev = [

{modcdp-0.0.2 → modcdp-0.0.4}/uv.lock

@@ -4,7 +4,7 @@ requires-python = ">=3.10"
 
 [[package]]
 name = "modcdp"
-version = "0.0.2"
+version = "0.0.4"
 source = { editable = "." }
 dependencies = [
     { name = "websocket-client" },

modcdp-0.0.2/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.4
-Name: modcdp
-Version: 0.0.2
-Summary: Python client for ModCDP.
-Project-URL: Repository, https://github.com/pirate/ModCDP
-Requires-Python: >=3.10
-Requires-Dist: websocket-client>=1.8.0
-Description-Content-Type: text/markdown
-
-# ModCDP Python Client
-
-Python client for ModCDP.

modcdp-0.0.2/README.md

@@ -1,3 +0,0 @@
-# ModCDP Python Client
-
-Python client for ModCDP.