Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pranshulsoni_flowwatch-3.1.2.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pranshulsoni_flowwatch-3.1.2-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file pranshulsoni_flowwatch-3.1.2.tar.gz.

File metadata

  • Download URL: pranshulsoni_flowwatch-3.1.2.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

Hashes for pranshulsoni_flowwatch-3.1.2.tar.gz
Algorithm Hash digest
SHA256 497cfc4006a77ad24cb37646144ff71f9961aa245d2a583fc54339fbc4b1658d
MD5 3cd3913a8e1bbf58c2ad27a2bf92c69e
BLAKE2b-256 07b0d526831035ba4c7daeff3cfcc734123f17c5d1fdb957219be422282108a6

See more details on using hashes here.

File details

Details for the file pranshulsoni_flowwatch-3.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pranshulsoni_flowwatch-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b21cca8d41b28b0eebba176d30dbff7b7705ad8d632118ad21e47a8ba7a37c6a
MD5 2718e73101b6f9b8ac7a4c77ff72b37a
BLAKE2b-256 a812e6e4e52cf74f4ee3ba425f8c59a83cc27cb49b380c58ed14588b2e37728b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page