soothe-client-python 1.0.22__tar.gz

soothe_client_python-1.0.22/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+.soothe/

soothe_client_python-1.0.22/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mirasoth-AI
+
+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.

soothe_client_python-1.0.22/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: soothe-client-python
+Version: 1.0.22
+Summary: WebSocket client + appkit for soothe-daemon (Python)
+Project-URL: Homepage, https://github.com/mirasoth/soothe-client-python
+Project-URL: Documentation, https://soothe.readthedocs.io
+Project-URL: Repository, https://github.com/mirasoth/soothe-client-python
+License: MIT
+License-File: LICENSE
+Keywords: agents,ai,client,soothe,websocket
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.15,>=3.11
+Requires-Dist: pillow<12.0.0,>=10.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: soothe-sdk<2.0.0,>=1.0.9
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.12.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# soothe-client-python
+
+Talk to a running **soothe-daemon** over WebSocket — send prompts, stream agent
+turns, run jobs.
+
+```bash
+pip install soothe-client-python
+```
+
+Requires a local daemon (default `ws://127.0.0.1:8765`).
+
+## Quick start
+
+```python
+import asyncio
+from soothe_client.appkit import DaemonSession
+
+async def main() -> None:
+    session = DaemonSession("ws://127.0.0.1:8765")
+    await session.connect()
+    await session.send_turn("Summarize this in one sentence: agents need tools.")
+    async for _namespace, mode, data in session.iter_turn_chunks():
+        if mode == "custom" and isinstance(data, dict):
+            text = data.get("content") or data.get("text")
+            if text:
+                print(text, end="", flush=True)
+    print()
+    await session.close()
+
+asyncio.run(main())
+```
+
+More patterns: [`examples/`](examples/) (hello → streaming → multi-turn → pool → jobs).
+
+## What you get
+
+| Need | Use |
+|------|-----|
+| One conversation, stream replies | `DaemonSession` (`soothe_client.appkit`) |
+| Jobs / cron (async) | `AsyncCommandClient` |
+| Jobs / cron (scripts / sync) | `CommandClient` |
+| Raw WebSocket / custom RPCs | `WebSocketClient` |
+| Many users / HTTP backend | `ConnectionPool` + `TurnRunner` |
+
+Wire request param models: `soothe_client.protocol_params`.
+
+## Develop
+
+```bash
+make sync-dev
+make check                 # lint + unit tests
+make test-examples-offline # offline appkit examples
+make test-examples         # live 01–06 (needs soothed)
+make test-integration      # live integration suite (needs soothed)
+```

soothe_client_python-1.0.22/README.md

@@ -0,0 +1,55 @@
+# soothe-client-python
+
+Talk to a running **soothe-daemon** over WebSocket — send prompts, stream agent
+turns, run jobs.
+
+```bash
+pip install soothe-client-python
+```
+
+Requires a local daemon (default `ws://127.0.0.1:8765`).
+
+## Quick start
+
+```python
+import asyncio
+from soothe_client.appkit import DaemonSession
+
+async def main() -> None:
+    session = DaemonSession("ws://127.0.0.1:8765")
+    await session.connect()
+    await session.send_turn("Summarize this in one sentence: agents need tools.")
+    async for _namespace, mode, data in session.iter_turn_chunks():
+        if mode == "custom" and isinstance(data, dict):
+            text = data.get("content") or data.get("text")
+            if text:
+                print(text, end="", flush=True)
+    print()
+    await session.close()
+
+asyncio.run(main())
+```
+
+More patterns: [`examples/`](examples/) (hello → streaming → multi-turn → pool → jobs).
+
+## What you get
+
+| Need | Use |
+|------|-----|
+| One conversation, stream replies | `DaemonSession` (`soothe_client.appkit`) |
+| Jobs / cron (async) | `AsyncCommandClient` |
+| Jobs / cron (scripts / sync) | `CommandClient` |
+| Raw WebSocket / custom RPCs | `WebSocketClient` |
+| Many users / HTTP backend | `ConnectionPool` + `TurnRunner` |
+
+Wire request param models: `soothe_client.protocol_params`.
+
+## Develop
+
+```bash
+make sync-dev
+make check                 # lint + unit tests
+make test-examples-offline # offline appkit examples
+make test-examples         # live 01–06 (needs soothed)
+make test-integration      # live integration suite (needs soothed)
+```

soothe_client_python-1.0.22/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "soothe-client-python"
+dynamic = ["version"]
+description = "WebSocket client + appkit for soothe-daemon (Python)"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.11,<3.15"
+keywords = ["soothe", "client", "websocket", "agents", "ai"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "soothe-sdk>=1.0.9,<2.0.0",
+    "pydantic>=2.0.0,<3.0.0",
+    "websockets>=12.0",
+    "pillow>=10.0.0,<12.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=1.3.0",
+    "pytest-cov",
+    "ruff>=0.12.0",
+    "mypy>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/mirasoth/soothe-client-python"
+Documentation = "https://soothe.readthedocs.io"
+Repository = "https://github.com/mirasoth/soothe-client-python"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/soothe_client"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/soothe_client/"]
+exclude = [
+    "**/__pycache__",
+    "**/*.pyc",
+    "**/*.pyo",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.hatch.version]
+path = "VERSION"
+pattern = "^(?P<version>[0-9]+\\.[0-9]+\\.[0-9]+)$"
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+packages = ["soothe_client"]
+mypy_path = "src"
+
+[[tool.mypy.overrides]]
+module = ["soothe_sdk", "soothe_sdk.*"]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests/unit", "examples/appkit"]
+addopts = "--import-mode=importlib"
+markers = [
+    "integration: live soothe-daemon tests (skipped when unreachable)",
+]

soothe_client_python-1.0.22/src/soothe_client/__init__.py

@@ -0,0 +1,99 @@
+"""Soothe WebSocket client for talking to a running soothe-daemon.
+
+Public surface::
+
+    from soothe_client import WebSocketClient, is_daemon_live
+    from soothe_client import AsyncCommandClient, CommandClient
+    from soothe_client.appkit import DaemonSession
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+
+from soothe_sdk.wire.codec import ProtocolError
+
+from soothe_client.command_client import (
+    AsyncCommandClient,
+    CommandClient,
+    async_command_client_from_config,
+    command_client_from_config,
+)
+from soothe_client.errors import (
+    DaemonError,
+    DisconnectCause,
+    ReconnectError,
+    StaleLoopError,
+    disconnect_cause_name,
+)
+from soothe_client.helpers import (
+    check_daemon_status,
+    connected_websocket,
+    fetch_config_section,
+    fetch_execution_state,
+    fetch_loop_history,
+    fetch_loop_messages,
+    fetch_skills_catalog,
+    is_daemon_live,
+    protocol1_rpc,
+    request_daemon_config_reload,
+    request_daemon_shutdown,
+    websocket_url_from_config,
+)
+from soothe_client.intent_hints import (
+    DEFAULT_DELIVERABLE_PHASES,
+    EMBED,
+    IMAGE_TO_TEXT,
+    OCR,
+    TEXT_COMPLETION,
+)
+from soothe_client.session import (
+    bootstrap_loop_session,
+    connect_websocket_with_retries,
+)
+from soothe_client.websocket import WebSocketClient
+
+try:
+    __version__ = importlib.metadata.version("soothe-client-python")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "__version__",
+    # Transport
+    "WebSocketClient",
+    "ProtocolError",
+    # Errors
+    "DaemonError",
+    "DisconnectCause",
+    "ReconnectError",
+    "StaleLoopError",
+    "disconnect_cause_name",
+    # Command clients
+    "AsyncCommandClient",
+    "CommandClient",
+    "command_client_from_config",
+    "async_command_client_from_config",
+    # Session bootstrap
+    "bootstrap_loop_session",
+    "connect_websocket_with_retries",
+    # Helpers
+    "websocket_url_from_config",
+    "connected_websocket",
+    "protocol1_rpc",
+    "check_daemon_status",
+    "is_daemon_live",
+    "request_daemon_config_reload",
+    "request_daemon_shutdown",
+    "fetch_skills_catalog",
+    "fetch_config_section",
+    "fetch_execution_state",
+    "fetch_loop_history",
+    "fetch_loop_messages",
+    # Intent hints
+    "TEXT_COMPLETION",
+    "IMAGE_TO_TEXT",
+    "OCR",
+    "EMBED",
+    "DEFAULT_DELIVERABLE_PHASES",
+]

soothe_client_python-1.0.22/src/soothe_client/appkit/__init__.py

@@ -0,0 +1,113 @@
+"""Application helpers built on WebSocketClient.
+
+Building blocks for agent UIs and backends: `DaemonSession`,
+`ConnectionPool` / `TurnRunner`, `QueryGate`, `EventClassifier`,
+`SSEBroadcaster`, `LoopSessionStore`.
+"""
+
+from __future__ import annotations
+
+from soothe_client.appkit.attachments import (
+    CompactImageOptions,
+    compact_attachments,
+    compact_image_attachment,
+)
+from soothe_client.appkit.broadcaster import SSEBroadcaster, SSEEvent
+from soothe_client.appkit.card_projection import CardProjection, parse_card_custom_payload
+from soothe_client.appkit.classifier import (
+    EVENT_FINAL_REPORT,
+    ChatEventResult,
+    ChatEventTerminal,
+    ClassifierConfig,
+    EventClassifier,
+)
+from soothe_client.appkit.daemon_session import DaemonSession
+from soothe_client.appkit.loop_session_store import (
+    LoopSessionEntry,
+    LoopSessionStore,
+    SessionMessage,
+)
+from soothe_client.appkit.pool import (
+    ConnectionPool,
+    ErrPoolExhausted,
+    PoolConfig,
+    PooledConn,
+    default_pool_config,
+)
+from soothe_client.appkit.query_gate import ErrQueryBusy, QueryGate
+from soothe_client.appkit.thinking_step import (
+    DEFAULT_THINKING_STEP_EVENTS,
+    extract_thinking_step,
+)
+from soothe_client.appkit.turn_boundary import (
+    TURN_END_IDLE,
+    TURN_END_STOPPED,
+    TURN_END_STREAM_END,
+    TurnBoundary,
+    TurnLifecycleGate,
+    is_daemon_turn_end_event,
+)
+from soothe_client.appkit.turn_runner import (
+    STREAM_CLOSE_FAIL,
+    STREAM_CLOSE_SOFT_COMPLETE,
+    Attachment,
+    ErrIdleTimeout,
+    ErrQueryTimeout,
+    InputOpts,
+    OnComplete,
+    OnError,
+    StreamClosePolicy,
+    TimeoutPolicy,
+    TurnConfig,
+    TurnRunner,
+    idle_timeout_for_turn,
+    input_message_for_loop,
+)
+
+__all__ = [
+    "DEFAULT_THINKING_STEP_EVENTS",
+    "STREAM_CLOSE_FAIL",
+    "STREAM_CLOSE_SOFT_COMPLETE",
+    "Attachment",
+    "CardProjection",
+    "ChatEventResult",
+    "ChatEventTerminal",
+    "ClassifierConfig",
+    "CompactImageOptions",
+    "ConnectionPool",
+    "DaemonSession",
+    "EVENT_FINAL_REPORT",
+    "ErrIdleTimeout",
+    "ErrPoolExhausted",
+    "ErrQueryBusy",
+    "ErrQueryTimeout",
+    "EventClassifier",
+    "InputOpts",
+    "LoopSessionEntry",
+    "LoopSessionStore",
+    "OnComplete",
+    "OnError",
+    "PoolConfig",
+    "PooledConn",
+    "QueryGate",
+    "SSEBroadcaster",
+    "SSEEvent",
+    "SessionMessage",
+    "StreamClosePolicy",
+    "TURN_END_IDLE",
+    "TURN_END_STOPPED",
+    "TURN_END_STREAM_END",
+    "TimeoutPolicy",
+    "TurnBoundary",
+    "TurnConfig",
+    "TurnLifecycleGate",
+    "TurnRunner",
+    "compact_attachments",
+    "is_daemon_turn_end_event",
+    "compact_image_attachment",
+    "default_pool_config",
+    "extract_thinking_step",
+    "idle_timeout_for_turn",
+    "input_message_for_loop",
+    "parse_card_custom_payload",
+]