Skip to main content

Python SDK for Threadify — service-delivery intelligence. Track every customer request from start to finish across every system, team, and partner. Visit: https://threadify.dev

Project description

Threadify Python SDK

Python SDK for Threadify — service-delivery intelligence that tracks every customer request from start to finish across every system, team, and partner.

Installation

pip install threadify-sdk

For local development:

pip install -e ".[dev]"

Quick Start

import asyncio
import logging
from threadify import Threadify


async def main():
    try:
        conn = await Threadify.connect(
            "your-api-key",
            service_name="orders-service",
        )
    except Exception as e:
        logging.error(f"Failed to connect: {e}")
        return

    try:
        thread = await conn.start(contract_name="order_flow")
        
        # Easy chaining!
        await (
            thread.step("order_received")
            .add_context({"orderId": "ORD-123"})
            .success("Order accepted")
        )
    except Exception as e:
        logging.error(f"Error in thread: {e}")
    finally:
        await conn.close()


if __name__ == "__main__":
    asyncio.run(main())

ws_url defaults to wss://eng.threadify.dev/threads. Override it if you are using a self-hosted or regional endpoint.

Configuration

Connect options

Use keyword arguments with Threadify.connect(...):

  • service_name
  • ws_url (optional, defaults to production)
  • graphql_url
  • debug
  • max_in_flight
  • connect_timeout

Example:

from threadify import Threadify

conn = await Threadify.connect(
    "your-api-key",
    service_name="inventory-service",
    debug=True,
)

Join options

Use Connection.join(...) with keyword arguments:

  • token=...
  • thread_id=... and role=...

Example:

thread = await conn.join(token="jwt-token")

Or:

thread = await conn.join(
    thread_id="thread-123",
    role="supplier",
)

Subscriptions

Preferred API:

  • subscribe(event, step_name, handler)
  • unsubscribe(event, step_name)

Supported event patterns:

  • step.success
  • step.failed
  • step.*
  • rule.passed
  • rule.violated
  • rule.*
  • *

Example:

def handle_notification(notification):
    if notification.is_violated:
        print(notification.message)



conn.subscribe("rule.violated", "payment_step", handle_notification)

Versioning & Releases

This SDK follows Semantic Versioning and Conventional Commits. Releases are automated via GitHub Actions.

  • fix: ... -> Patch bump
  • feat: ... -> Minor bump
  • feat!: ... or BREAKING CHANGE: ... -> Major bump

Testing

To run the SDK tests, execute:

make test

Alternatively, use pytest:

python3 -m pytest

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

threadify_sdk-0.2.1.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

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

threadify_sdk-0.2.1-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file threadify_sdk-0.2.1.tar.gz.

File metadata

  • Download URL: threadify_sdk-0.2.1.tar.gz
  • Upload date:
  • Size: 33.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for threadify_sdk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cbbe2492c2600a8f61aec8d1847ca57b8dab574b21961b9b6a3b2949a6e544a0
MD5 9dc64ec9429d55ede911d7bf3fcab6ad
BLAKE2b-256 f3c6639c20fe46b1972aedc08af6e487f9dfc6a7409d11df79f419a8cb3f3296

See more details on using hashes here.

File details

Details for the file threadify_sdk-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: threadify_sdk-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for threadify_sdk-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2d80a8adb200876667d1e80291d7b68918f73b70ba31bf09ea08c9588bd5a72e
MD5 8193b62290123fb1dafe71f977b6f1ed
BLAKE2b-256 e5ac86351336c1d169672d14f05ce180cb32e3404b431cd32bb886cbd1c6e439

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