ProxyWhirl DocsDocumentation
Canonical ProxyWhirl documentation for Python, REST, CLI, MCP, TUI, strategies, and operations.
ProxyWhirl Documentation
ProxyWhirl is a drop-in Python proxy rotator: create a rotator, make requests, and let it hydrate an empty pool from every enabled built-in public source on first use. It also includes sync and async clients, validation, circuit breakers, retry policies, caching, a REST API, a CLI, a TUI, and an MCP server.
This Fumadocs site is the canonical documentation path at /docs/. Generated reference pages stay source-grounded through pnpm --dir web run docs:generate.
Start Here
| Surface | Use It For |
|---|---|
| Quickstart | Install ProxyWhirl, auto-fetch proxies, and send the first rotated request. |
| Guides | Learn client setup, caching, retries, deployment, and troubleshooting. |
| Concepts | Understand proxy lifecycle, rotation strategies, circuit breakers, and security. |
| Python API | Browse generated public exports from proxywhirl.__all__. |
| REST/OpenAPI | Review generated FastAPI OpenAPI paths. |
| CLI Reference | Review generated Typer command inventory. |
| Proxy Sources | Inspect generated proxy source metadata. |
| Strategy Matrix | Compare generated rotation strategy classes. |
Documentation Pipeline
The docs build runs in this order:
pnpm --dir web run docs:generatederives generated pages and JSON from repository code and metadata.pnpm --dir web run lintenforces zero ESLint warnings.pnpm --dir web run test:runvalidates docs/UI behavior.pnpm --dir web run buildbuilds the Next.js App Router site with Fumadocs at/docs/.- CI validates the same pipeline before deployment.
Production Assurance
Use Operations for the zero-warning gate matrix and Operations Playbook for source, proxy-list, and CI monitoring checks. The public proxy-list bundle is published under /proxy-lists/ and mirrored from docs/proxy-lists/ into web/public/proxy-lists/ during docs generation.
Python runtime behavior, database schema, and public Python APIs are intentionally unchanged by this documentation site.