-
Notifications
You must be signed in to change notification settings - Fork 4
Runnable Examples
These Python clients demonstrate multi-step operator tasks. Run commands from the repository root with Python 3. The programs use its standard library. Their parsing and analysis tests run in CI without a lab. A complete live run requires the services described in the capture harness.
| Program | What it does | Live prerequisites |
|---|---|---|
| leg_correlate.py | Joins proxy dialogs and relay streams; refuses to treat one instance as two witnesses | Two sipnab REST endpoints |
| mcp_probe.py | Queries both capture nodes over MCP and compares their identities | Two HTTP MCP endpoints |
| vcon_view.py | Lists stored vCons, renders one and extracts WAV audio | The harness conserver backend |
Inspect each program's options before a live run:
python3 clients/python/leg_correlate.py --helppython3 clients/python/mcp_probe.py --helppython3 clients/python/vcon_view.py --help
Run the local regression suite:
# Run all of these, in order.
python3 -m venv .venv-client-tests
. .venv-client-tests/bin/activate
python3 -m pip install --require-hashes -r clients/python/requirements-test.txt
python3 -m compileall -q clients/python
python3 -m pytest clients/python/tests -qFor Rust, see the library API and its executable rustdoc examples. For individual CLI commands, use the cookbook. Go, JavaScript, C and C++ lifecycle examples remain gaps. Snippets in reference pages do not establish runnable client coverage for those languages.
Website · Repository · Issues · Generated from docs/ — edit there, not here.
Getting started
- Installation
- Cookbook
- Runnable Examples
- Real World Captures
- Troubleshooting
- Tuning Capture
- Encapsulations
- Rtpengine Relays
- Backers
Using the TUI
CLI & automation
- CLI Reference
- Filter DSL
- Output Formats
- SIP Response Codes
- SIP Methods
- SIP Header Fields
- SIP Parameters
- SIP Lint Rules
- MOS and Codecs
Configuration
Integrations (API & MCP)
- REST API
- Prometheus Metrics
- Authentication
- MCP
- MCP Deployment
- MCP Across an Estate
- MCP Tools
- MCP Protocol
- Uprobe Walkthrough
- Capture SIP over TLS
- WASM Plugins
- vCon Export
- vCon Capture Stack
Development & internals
- Internals Index
- Internals Subsystem Guide
- Internals Invariants
- Internals Testing
- Internals Walkthroughs
- Internals Build CI Release
- Internals Profiling
- Internals Domain Primer
- Library API
- Benchmarks
- Fault Model
- Architecture
- Internals Threading
- Internals TUI Testing
- Internals Zero Copy Payloads
- Internals Uprobe Capture
- Internals Rtpengine Control Plane
- Internals Relay Control Decoding
- Internals vCon Exporter