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("Order-123")
        
        # 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.2.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.2-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: threadify_sdk-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4a1ffa4f76afe81d5d9ad04859e6d0679c452e30ff354a89570e6f19fc403e2f
MD5 164403a711189b2857fa53a956a20ac3
BLAKE2b-256 d074329d08ae84e491b9ab01c629a7df5cdaebf0d1af8bdf43fd76013a286db8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: threadify_sdk-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 91698eb14800695773aea9fcc5afee4582af525015206f25add93925c4fdc36c
MD5 798cc85292c330e4c9f421fbe287c683
BLAKE2b-256 9f8f8f725a3db27e7270734336cc77f9b876e6432f1c81321562ec796474e8f9

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