Python client for FlowWatch — connect to a running FlowWatch sidecar
Project description
flowwatch-client (Python)
Python client for FlowWatch — connects to a running FlowWatch sidecar over HTTP.
Install
pip install flowwatch-client
Usage
Start the FlowWatch sidecar in your Node.js app:
import { createFlowwatch, startSidecar } from "@pranshulsoni/flowwatch"
const fw = await createFlowwatch({ ... })
startSidecar(fw, { port: 9400, token: process.env.SIDECAR_TOKEN })
Then use the Python client:
from flowwatch import FlowwatchClient
fw = FlowwatchClient(base_url="http://localhost:9400", token="your-token")
# Feature flag
enabled = fw.flag("new-checkout", context={"userId": "u_123", "plan": "pro"})
# Trigger a workflow
result = fw.trigger("send-welcome-email", input={"userId": "u_123"})
# Record a trace span
fw.trace_span(name="db.query", type="db", duration_ms=42)
# Capture an error
fw.capture_error(message="Something broke", source="api", name="ValueError")
# Health check
status = fw.health() # {"status": "ok", "sidecar": "flowwatch"}
fw.close()
Use as a context manager:
with FlowwatchClient("http://localhost:9400", token="your-token") as fw:
enabled = fw.flag("dark-mode")
API
| Method | Description |
|---|---|
flag(key, context?) |
Evaluate a feature flag → bool |
trigger(name, input?) |
Trigger a workflow → dict |
trace_span(name, type, duration_ms, metadata?, status?) |
Record a trace span |
capture_error(message, source, name?, stack?) |
Capture an error |
health() |
Sidecar health check → dict |
close() |
Close the HTTP connection |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pranshulsoni_flowwatch-3.1.4.tar.gz.
File metadata
- Download URL: pranshulsoni_flowwatch-3.1.4.tar.gz
- Upload date:
- Size: 2.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2ee1c70528a98c52df991efc0074e5e2fc242284a3eb41967228c65ecc4cc88e
|
|
| MD5 |
2dd756946631d953cc4b5deb56c66957
|
|
| BLAKE2b-256 |
2da1fe8893a3398cd1658f7655e789074a95daff5a7fc7e20456c5bc98732d3c
|
File details
Details for the file pranshulsoni_flowwatch-3.1.4-py3-none-any.whl.
File metadata
- Download URL: pranshulsoni_flowwatch-3.1.4-py3-none-any.whl
- Upload date:
- Size: 2.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
939cecc45e6ec845bed26abff3259d2adae2bee9d90a64b941722e61b701b410
|
|
| MD5 |
de178c4d7a1720ee15144dc6cf20fc2c
|
|
| BLAKE2b-256 |
b6bb68374c0be9f4361cbdb6c9f2391c13a41223c8906daeaccf5fa8e868e7a7
|