webtap-tool 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

{webtap_tool-0.1.1.dist-info → webtap_tool-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webtap-tool
-Version: 0.1.1
+Version: 0.1.2
 Summary: Terminal-based web page inspector for AI debugging sessions
 Author-email: Fredrik Angelsen <fredrikangelsen@gmail.com>
 Classifier: Development Status :: 3 - Alpha
@@ -25,69 +25,148 @@ Requires-Dist: websocket-client>=1.8.0
 Requires-Dist: websockets>=15.0.1
 Description-Content-Type: text/markdown
 
-# WebTap
+# webtap
 
 Browser debugging via Chrome DevTools Protocol with native event storage and dynamic querying.
 
-## Overview
+## ✨ Features
 
-WebTap connects to Chrome's debugging protocol and stores CDP events as-is in DuckDB, enabling powerful SQL queries and dynamic field discovery without complex transformations.
+- 🔍 **Native CDP Storage** - Events stored exactly as received in DuckDB
+- 🎯 **Dynamic Field Discovery** - Automatically indexes all field paths from events
+- 🚫 **Smart Filtering** - Built-in filters for ads, tracking, analytics noise
+- 📊 **SQL Querying** - Direct DuckDB access for complex analysis
+- 🔌 **MCP Ready** - Tools and resources for Claude/LLMs
+- 🎨 **Rich Display** - Tables, alerts, and formatted output
+- 🐍 **Python Inspection** - Full Python environment for data exploration
 
-## Key Features
+## 📋 Prerequisites
 
-- **Native CDP Storage** - Events stored exactly as received in DuckDB
-- **Dynamic Field Discovery** - Automatically indexes all field paths from events
-- **Smart Filtering** - Built-in filters for ads, tracking, analytics noise
-- **SQL Querying** - Direct DuckDB access for complex analysis
-- **Chrome Extension** - Visual page selector and connection management
-- **Python Inspection** - Full Python environment for data exploration
-
-## Installation
+Required system dependencies:
+- **google-chrome-stable** or **chromium** - Browser with DevTools Protocol support
 
 ```bash
-# Install with uv
-uv tool install webtap
+# macOS
+brew install --cask google-chrome
+
+# Ubuntu/Debian
+wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
+sudo apt update
+sudo apt install google-chrome-stable
 
-# Or from source
-cd packages/webtap
-uv sync
+# Arch Linux
+yay -S google-chrome  # or google-chrome-stable from AUR
+
+# Fedora
+sudo dnf install google-chrome-stable
 ```
 
-## Quick Start
+## 📦 Installation
 
-1. **Start Chrome with debugging**
 ```bash
-# macOS
-/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
+# Install via uv tool (recommended)
+uv tool install webtap-tool
 
-# Linux  
-google-chrome --remote-debugging-port=9222
+# Or with pipx
+pipx install webtap-tool
 
-# Windows
-chrome.exe --remote-debugging-port=9222
+# Update to latest
+uv tool upgrade webtap-tool
+
+# Uninstall
+uv tool uninstall webtap-tool
 ```
 
-2. **Launch WebTap**
+## 🚀 Quick Start
+
 ```bash
+# 1. Install webtap
+uv tool install webtap-tool
+
+# 2. Optional: Setup helpers (first time only)
+webtap --cli setup-filters       # Download default filter configurations
+webtap --cli setup-extension     # Download Chrome extension files
+webtap --cli setup-chrome        # Install Chrome wrapper for debugging
+
+# 3. Launch Chrome with debugging
+webtap --cli run-chrome          # Or manually: google-chrome-stable --remote-debugging-port=9222
+
+# 4. Start webtap REPL
 webtap
 
-# You'll see:
-================================================================================
-                     WebTap - Chrome DevTools Protocol REPL
---------------------------------------------------------------------------------
-Type help() for available commands
->>>
+# 5. Connect and explore
+>>> pages()                          # List available Chrome pages
+>>> connect(0)                       # Connect to first page
+>>> network()                        # View network requests (filtered)
+>>> console()                        # View console messages
+>>> events({"url": "*api*"})         # Query any CDP field dynamically
 ```
 
-3. **Connect and explore**
+## 🔌 MCP Setup for Claude
+
+```bash
+# Quick setup with Claude CLI
+claude mcp add webtap -- webtap --mcp
+```
+
+Or manually configure Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+```json
+{
+  "mcpServers": {
+    "webtap": {
+      "command": "webtap",
+      "args": ["--mcp"]
+    }
+  }
+}
+```
+
+## 🎮 Usage
+
+### Interactive REPL
+```bash
+webtap                     # Start REPL
+webtap --mcp               # Start as MCP server
+```
+
+### CLI Commands
+```bash
+webtap --cli setup-filters      # Download filter configurations
+webtap --cli setup-extension    # Download Chrome extension
+webtap --cli setup-chrome       # Install Chrome wrapper script
+webtap --cli run-chrome         # Launch Chrome with debugging
+webtap --cli --help            # Show all CLI commands
+```
+
+### Commands
 ```python
 >>> pages()                          # List available Chrome pages
 >>> connect(0)                       # Connect to first page
 >>> network()                        # View network requests (filtered)
 >>> console()                        # View console messages
 >>> events({"url": "*api*"})         # Query any CDP field dynamically
+>>> body(50)                         # Get response body
+>>> inspect(49)                      # View event details
+>>> js("document.title")             # Execute JavaScript
 ```
 
+### Command Reference
+
+| Command | Description |
+|---------|------------|
+| `pages()` | List available Chrome pages |
+| `connect(page=0)` | Connect to page by index |
+| `disconnect()` | Disconnect from current page |
+| `navigate(url)` | Navigate to URL |
+| `network(no_filters=False)` | View network requests |
+| `console()` | View console messages |
+| `events(filters)` | Query events dynamically |
+| `inspect(rowid, expr=None)` | Inspect event details |
+| `body(response_id, expr=None)` | Get response body |
+| `js(code, wait_return=True)` | Execute JavaScript |
+| `filters(action="list")` | Manage noise filters |
+| `clear(events=True)` | Clear events/console/cache |
+
 ## Core Commands
 
 ### Connection & Navigation
@@ -392,20 +471,41 @@ WebTap includes aggressive default filters to reduce noise. Customize in `.webta
 - Python 3.12+
 - Dependencies: websocket-client, duckdb, replkit2, fastapi, uvicorn, beautifulsoup4
 
-## Development
+## 🏗️ Architecture
+
+Built on [ReplKit2](https://github.com/angelsen/replkit2) for dual REPL/MCP functionality.
+
+**Key Design:**
+- **Store AS-IS** - No transformation of CDP events
+- **Query On-Demand** - Extract only what's needed
+- **Dynamic Discovery** - No predefined schemas
+- **SQL-First** - Leverage DuckDB's JSON capabilities
+- **Minimal Memory** - Store only CDP data
+
+## 📚 Documentation
+
+- [Architecture](ARCHITECTURE.md) - System design
+- [Vision](src/webtap/VISION.md) - Design philosophy
+- [Services](src/webtap/services/) - Service layer implementations
+- [Commands](src/webtap/commands/) - Command implementations
+
+## 🛠️ Development
 
 ```bash
-# Run from source
-cd packages/webtap
-uv run webtap
+# Clone repository
+git clone https://github.com/angelsen/tap-tools
+cd tap-tools
+
+# Install for development
+uv sync --package webtap
 
-# API server starts automatically on port 8765
-# Chrome extension connects to http://localhost:8765
+# Run development version
+uv run --package webtap webtap
 
-# Type checking and linting
-basedpyright packages/webtap/src/webtap
-ruff check --fix packages/webtap/src/webtap
-ruff format packages/webtap/src/webtap
+# Run tests and checks
+make check-webtap   # Check build
+make format         # Format code
+make lint           # Fix linting
 ```
 
 ## API Server
@@ -422,6 +522,6 @@ WebTap automatically starts a FastAPI server on port 8765 for Chrome extension i
 
 The API server runs in a background thread and doesn't block the REPL.
 
-## License
+## 📄 License
 
-MIT - See [LICENSE](../../LICENSE) for details.
+MIT - see [LICENSE](../../LICENSE) for details.

{webtap_tool-0.1.1.dist-info → webtap_tool-0.1.2.dist-info}/RECORD

@@ -37,7 +37,7 @@ webtap/services/fetch.py,sha256=hKrhFda1x65GmLHO0XMkxbclMtkWt0uEv7Rp9Ui2na0,1362
 webtap/services/main.py,sha256=HcXdPuI7hzsxsNvfN0npGhj_M7HObc83Lr3fuy7BMeE,5673
 webtap/services/network.py,sha256=EJZIlaE98v113xypPIiiTE-LiG-eCXGNXoJjzDYebhU,3480
 webtap/services/setup.py,sha256=DF2471WsY5pJ5gEn64EMGRW5t9mUyuTQoCTejOJeQxg,7594
-webtap_tool-0.1.1.dist-info/METADATA,sha256=QYQTlMAdoYseHUo742JZfunjHy6KjKlO89YvKZJDBSE,14277
-webtap_tool-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-webtap_tool-0.1.1.dist-info/entry_points.txt,sha256=iFe575I0CIb1MbfPt0oX2VYyY5gSU_dA551PKVR83TU,39
-webtap_tool-0.1.1.dist-info/RECORD,,
+webtap_tool-0.1.2.dist-info/METADATA,sha256=IZzOzUP2iPmmNVcjgBNLkAqy3lmF0aEpMLVb5DaV-pE,17457
+webtap_tool-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+webtap_tool-0.1.2.dist-info/entry_points.txt,sha256=iFe575I0CIb1MbfPt0oX2VYyY5gSU_dA551PKVR83TU,39
+webtap_tool-0.1.2.dist-info/RECORD,,