Pharox Toolkit¶
Pharox is the Python toolkit for building serious proxy orchestration systems. It focuses on the business rules—leasing, storage contracts, health orchestration and lifecycle hooks—so you can plug it into any application or service.
Just want to try it?
Head straight to the Quickstart for an end-to-end walkthrough you can run locally in under five minutes.
Why Pharox¶
- Battle-tested leasing logic with concurrency caps, cleanup helpers and lifecycle callbacks ready for observability.
- Storage abstraction that scales: swap the in-memory adapter for your own
datastore through the
IStorageinterface and shared contract tests. - Health orchestration that aligns workers, services and SDKs behind the
same
HealthCheckResultsemantics. - Modern Python ergonomics: Pydantic v2 models, type hints, Ruff formatting, and context managers that reduce boilerplate.
Choose Your Path¶
| If you want to… | Start here | Related reference |
|---|---|---|
| Install, seed data, lease a proxy | Quickstart | ProxyManager |
| Embed Pharox in a worker or script | Embed Pharox in a Worker | pharox.utils.bootstrap |
| Wire Pharox to a SQL datastore | Build a PostgreSQL Adapter | IStorage contract |
| Run protocol health sweeps | Run Health Checks at Scale | Health Toolkit |
Architecture Snapshot¶
The toolkit sits between your code and the storage layer:
- Your automation, service or CLI drives
ProxyManager. ProxyManagerdelegates persistence to anIStorageimplementation.- Health checks use
HealthChecker/HealthCheckOrchestratorto enforce consistent classification. - Callbacks and metrics hooks let you surface events without forking the core.
Community & Support¶
- GitHub issues and discussions: https://github.com/fzaca/pharox
- PyPI releases: https://pypi.org/project/pharox/
- Documentation source: this site, built with MkDocs Material—PRs welcome!