threadify-sdk 0.2.0__tar.gz

threadify_sdk-0.2.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [0.2.0](https://github.com/creativeJoe007/ThreadifyEngine/compare/threadify-sdk-python-v0.1.0...threadify-sdk-python-v0.2.0) (2026-02-19)
+
+
+### Features
+
+* Add GitHub Actions CI workflows for Go and Python SDKs and remove unnecessary docstrings from Python test files. ([2a48d71](https://github.com/creativeJoe007/ThreadifyEngine/commit/2a48d71641ca2101b600746e234041aa09951ac8))
+* Configure automated releases for Go and Python SDKs, update Go … ([ac7c46d](https://github.com/creativeJoe007/ThreadifyEngine/commit/ac7c46d658c2bc3b91ceff5d629851d89825d3b9))
+* Configure automated releases for Go and Python SDKs, update Go module import path, and add versioning. ([6dbcf36](https://github.com/creativeJoe007/ThreadifyEngine/commit/6dbcf360eeeb0bf7edeab9db9a26c84bdff3da18))
+* improve Go and Python SDK step method chaining by propagating errors internally rather than returning them directly. ([fa3199b](https://github.com/creativeJoe007/ThreadifyEngine/commit/fa3199b419c9415681126a3c17ded69cd9a69ba0))
+* Introduce basic usage and notification examples for Python and Go SDKs, alongside new thread tests and CI/CD workflow updates. ([755b3e3](https://github.com/creativeJoe007/ThreadifyEngine/commit/755b3e35cd21b0e76457add21d17db90afff344d))
+* python sdk impl ([c3a54a4](https://github.com/creativeJoe007/ThreadifyEngine/commit/c3a54a453631c8fb3e3bef360386578263606b75))

threadify_sdk-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Threadify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

threadify_sdk-0.2.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+include CHANGELOG.md

threadify_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: threadify-sdk
+Version: 0.2.0
+Summary: Python SDK for the Threadify Engine — workflow orchestration via WebSocket and GraphQL
+Author-email: Threadify Team <team@threadify.dev>
+License: MIT
+Keywords: threadify,workflow,orchestration,websocket,graphql
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets>=12.0
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: ruff>=0.3; extra == "dev"
+Dynamic: license-file
+
+# Threadify Python SDK
+
+Python SDK for connecting to the Threadify Engine over WebSocket and querying archived data over GraphQL.
+
+## Installation
+
+```bash
+pip install threadify-sdk
+```
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+import logging
+from threadify import Threadify
+
+
+async def main():
+    try:
+        conn = await Threadify.connect(
+            "your-api-key",
+            service_name="orders-service",
+            ws_url="wss://eng.threadify.dev/threads",
+        )
+    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` is required. The SDK no longer uses a hardcoded default URL.
+
+## Configuration
+
+### Connect options
+
+Use keyword arguments with `Threadify.connect(...)`:
+
+- `service_name`
+- `ws_url` (required)
+- `graphql_url`
+- `debug`
+- `max_in_flight`
+- `connect_timeout`
+
+Example:
+
+```python
+from threadify import Threadify
+
+conn = await Threadify.connect(
+    "your-api-key",
+    service_name="inventory-service",
+    ws_url="wss://eng.threadify.dev/threads",
+    debug=True,
+)
+```
+
+### Join options
+
+Use `Connection.join(...)` with keyword arguments:
+
+- `token=...`
+- `thread_id=...` and `role=...`
+
+Example:
+
+```python
+thread = await conn.join(token="jwt-token")
+```
+
+Or:
+
+```python
+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:
+
+```python
+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](https://semver.org/) and [Conventional Commits](https://www.conventionalcommits.org/). 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:
+
+```bash
+make test
+```
+
+Alternatively, use `pytest`:
+
+```bash
+python3 -m pytest
+```

threadify_sdk-0.2.0/README.md

@@ -0,0 +1,154 @@
+# Threadify Python SDK
+
+Python SDK for connecting to the Threadify Engine over WebSocket and querying archived data over GraphQL.
+
+## Installation
+
+```bash
+pip install threadify-sdk
+```
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+import logging
+from threadify import Threadify
+
+
+async def main():
+    try:
+        conn = await Threadify.connect(
+            "your-api-key",
+            service_name="orders-service",
+            ws_url="wss://eng.threadify.dev/threads",
+        )
+    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` is required. The SDK no longer uses a hardcoded default URL.
+
+## Configuration
+
+### Connect options
+
+Use keyword arguments with `Threadify.connect(...)`:
+
+- `service_name`
+- `ws_url` (required)
+- `graphql_url`
+- `debug`
+- `max_in_flight`
+- `connect_timeout`
+
+Example:
+
+```python
+from threadify import Threadify
+
+conn = await Threadify.connect(
+    "your-api-key",
+    service_name="inventory-service",
+    ws_url="wss://eng.threadify.dev/threads",
+    debug=True,
+)
+```
+
+### Join options
+
+Use `Connection.join(...)` with keyword arguments:
+
+- `token=...`
+- `thread_id=...` and `role=...`
+
+Example:
+
+```python
+thread = await conn.join(token="jwt-token")
+```
+
+Or:
+
+```python
+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:
+
+```python
+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](https://semver.org/) and [Conventional Commits](https://www.conventionalcommits.org/). 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:
+
+```bash
+make test
+```
+
+Alternatively, use `pytest`:
+
+```bash
+python3 -m pytest
+```

threadify_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "threadify-sdk"
+version = "0.2.0"
+description = "Python SDK for the Threadify Engine — workflow orchestration via WebSocket and GraphQL"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+keywords = ["threadify", "workflow", "orchestration", "websocket", "graphql"]
+authors = [
+    {name = "Threadify Team", email = "team@threadify.dev"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+dependencies = [
+    "websockets>=12.0",
+    "httpx>=0.27.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "ruff>=0.3",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "W",    # pycodestyle warnings
+    "F",    # pyflakes
+    "I",    # isort
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "UP",   # pyupgrade
+    "ASYNC",# flake8-async
+]
+ignore = [
+    "E501", # line too long (handled by formatter)
+    "B008", # do not perform function calls in argument defaults
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

threadify_sdk-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

threadify_sdk-0.2.0/tests/test_client.py

@@ -0,0 +1,69 @@
+import json
+from unittest.mock import AsyncMock
+
+import pytest
+
+from threadify.client import Threadify
+from threadify.models import ConnectOptions
+
+
+class TestThreadifyConnect:
+    @pytest.mark.asyncio
+    async def test_requires_ws_url(self, monkeypatch):
+        ws_connect = AsyncMock(
+            side_effect=AssertionError("websockets.connect should not be called")
+        )
+        monkeypatch.setattr("threadify.client.websockets.connect", ws_connect)
+
+        with pytest.raises(ValueError, match="ws_url is required"):
+            await Threadify.connect("test-api-key", "test-service")
+
+    @pytest.mark.asyncio
+    async def test_connect_with_explicit_ws_url(self, monkeypatch):
+        ws = AsyncMock()
+        ws.send = AsyncMock()
+        ws.recv = AsyncMock(return_value=json.dumps({"action": "connect", "status": "success"}))
+        ws.close = AsyncMock()
+
+        ws_connect = AsyncMock(return_value=ws)
+        monkeypatch.setattr("threadify.client.websockets.connect", ws_connect)
+
+        conn = await Threadify.connect(
+            "test-api-key",
+            service_name="test-service",
+            ws_url="wss://example.com/threads",
+        )
+
+        ws_connect.assert_awaited_once_with("wss://example.com/threads")
+        sent = ws.send.call_args.args[0]
+        sent_msg = json.loads(sent)
+        assert sent_msg["action"] == "connect"
+        assert sent_msg["apiKey"] == "test-api-key"
+        assert sent_msg["serviceName"] == "test-service"
+        assert conn.is_connected is True
+
+    @pytest.mark.asyncio
+    async def test_connect_legacy_signature_still_supported(self, monkeypatch):
+        ws = AsyncMock()
+        ws.send = AsyncMock()
+        ws.recv = AsyncMock(return_value=json.dumps({"action": "connect", "status": "success"}))
+        ws.close = AsyncMock()
+
+        ws_connect = AsyncMock(return_value=ws)
+        monkeypatch.setattr("threadify.client.websockets.connect", ws_connect)
+
+        conn = await Threadify.connect(
+            "test-api-key",
+            "legacy-service",
+            ConnectOptions(ws_url="wss://example.com/threads"),
+        )
+
+        sent_msg = json.loads(ws.send.call_args.args[0])
+        assert sent_msg["serviceName"] == "legacy-service"
+        assert conn.is_connected is True
+
+
+class TestThreadifyFactory:
+    def test_create_requires_ws_url(self):
+        with pytest.raises(ValueError, match="ws_url is required"):
+            Threadify.create("test-api-key")