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.6.tar.gz (33.1 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.6-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: threadify_sdk-0.2.6.tar.gz
  • Upload date:
  • Size: 33.1 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.6.tar.gz
Algorithm Hash digest
SHA256 b47eb318f8259f9aca191a6fa7f095ff4662037ee0898e327b7dd47f9c5c09c7
MD5 8f7801af66d7e269b0f40a11df1df11e
BLAKE2b-256 ea06da2704fb67983d8bc3396f3ce4160e14558db0cee475e88ffe5b45881194

See more details on using hashes here.

File details

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

File metadata

  • Download URL: threadify_sdk-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 27.2 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8b43f36d7294c1604ba68e5b63314946e06a9a8cd386443ce5aacc182e0ca77b
MD5 0949d629762ab8014a2b89ebb1231973
BLAKE2b-256 b952d9043a262f832df1209f9dce61514e4086c114a4cc4911fc530f05774e92

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