https://github.com/yie1d/cdpkit
Chrome DevTools Protocol Toolkit in Python
https://github.com/yie1d/cdpkit
aiohttp chrome-debugging-protocol chrome-devtools-protocol chromium pydantic-v2
Last synced: 6 months ago
JSON representation
Chrome DevTools Protocol Toolkit in Python
- Host: GitHub
- URL: https://github.com/yie1d/cdpkit
- Owner: yie1d
- License: mit
- Created: 2025-04-27T08:30:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-06-24T07:08:47.000Z (6 months ago)
- Last Synced: 2025-06-24T07:38:53.859Z (6 months ago)
- Topics: aiohttp, chrome-debugging-protocol, chrome-devtools-protocol, chromium, pydantic-v2
- Language: Python
- Homepage:
- Size: 1.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## CDPKit: A Python Implementation of the CDP([Chrome DevTools Protocol](https://github.com/ChromeDevTools/devtools-protocol/tree/master/json))Toolkit
English | [中文](doc/README_cn.md)
## Overview
CDPKit is a toolkit for the Chrome DevTools Protocol (CDP). The protocol component of this project is built on [pydantic](https://github.com/pydantic/pydantic), supporting friendly code completion and parameter type checking. It also provides a connection module that enables CDP interactions via the `remote-debugging-port`.
## Key Features
- **Type Safety**: Leverages `pydantic` to automatically implement type checking for command inputs and outputs.
- **Rich Type Hints**: Provides type hints for command results, eliminating the need to consult documentation for return values.
- **Dynamic Code Generation**: Generates protocol code based on the official [CDP JSON](https://github.com/ChromeDevTools/devtools-protocol/tree/master/json) schema, ensuring fast updates.
- **Async Performance**: Offers an asynchronous CDPSessionManager that abstracts communication logic, allowing direct method calls.
## Installation
#### 1. Install by pip
```shell
pip install cdpkits
```
#### 2. Install by [uv](https://github.com/astral-sh/uv)
- 2.1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)(if not currently installed)
```shell
curl -LsSf https://astral.sh/uv/install.sh | sh # macOS and Linux
# on Windows:
# powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
- 2.2. Clone the repository:
```shell
git clone https://github.com/yie1d/cdpkit.git
cd cdpkit
```
- 2.3. Create a new virtual environment and activate it:
```shell
uv venv
source .venv/bin/activate # On Unix/macOS
# Or on Windows:
# .venv\Scripts\activate
```
- 2.4. Install dependencies:
```shell
uv sync
```
## Basic Usage
```python
import asyncio
from cdpkit.connection import CDPSessionManager
from cdpkit.protocol import Target
async def main():
session_manager = CDPSessionManager(ws_endpoint='localhost:9222')
cdp_session = await session_manager.get_session()
target_resp = await cdp_session.execute(Target.GetTargets())
for target_info in target_resp.targetInfos:
print(target_info.model_dump())
asyncio.run(main())
```