Skip to main content

Python SDK for the Dominus Orchestrator Platform

Project description

Dominus SDK for Python

Async Python SDK for CareBridge Dominus platform services. Routes calls through the Dominus Gateway with JWT-based authentication, base64 wire encoding, retries, and circuit breaking.

What This Is

  • Server-side, asyncio-first Python SDK (3.9+)
  • Namespace API with root-level shortcuts for common operations
  • Targets production Cloudflare Workers (gateway, JWT, logs) and Cloud Run (orchestrator)
  • Version: 2.12.0

Quick Start

import os
from dominus import dominus

os.environ["DOMINUS_TOKEN"] = "your-psk-token"

# Secrets
value = await dominus.secrets.get("DB_URL")
await dominus.secrets.upsert("API_KEY", "secret_value")

# Database CRUD
users = await dominus.db.query("users", filters={"status": "active"})
await dominus.db.insert("users", {"name": "John", "email": "john@example.com"})

# Redis caching
await dominus.redis.set("session:123", {"user": "john"}, ttl=3600)
value = await dominus.redis.get("session:123")

# File storage
result = await dominus.files.upload(data=buf, filename="report.pdf", category="reports")

# AI agent execution
result = await dominus.ai.run_agent(
    conversation_id="conv-123",
    system_prompt="You are helpful.",
    user_prompt="Hello!"
)

# Streaming AI
async for chunk in dominus.ai.stream_agent(
    conversation_id="conv-123",
    system_prompt="You are helpful.",
    user_prompt="Tell me a story"
):
    print(chunk.get("content", ""), end="", flush=True)

# Workflow execution
result = await dominus.workflow.execute(workflow_id, context={"key": "value"})

Architecture (SDK View)

DOMINUS_TOKEN (PSK) --> Gateway /jwt/mint --> JWT cached (14min TTL)
                                |
                                v
                    Gateway /svc/* (AI, workflow, logs)
                         or
                    Orchestrator /api/* (all other services)
  • JSON requests/responses are base64-encoded for auth-required routes
  • GET requests send no body; parameters go in the path or query string
  • Gateway routing (/api/* -> /svc/*) is used by AI, workflow, and logs namespaces
  • Orchestrator handles secrets, db, auth, ddl, files, redis, portal, courier, open, health, admin

Namespaces

Namespace Service Description
secrets Warden Secrets CRUD
db Scribe Database CRUD with optional secure-table audit
secure / db_secure Scribe Audit-logged data access (requires reason/actor)
redis Whisperer Cache, locks, counters, hashes
files Archivist Object storage with compliance mode
auth Guardian Users, roles, scopes, tenants, clients, pages, nav, subtypes, secure tables (147 methods)
ddl Smith Schema DDL, migrations, tenant provisioning, schema builder
logs Logs Worker Structured logging with callsite capture
portal Portal Login, sessions, profile, preferences, navigation, registration
courier Courier Postmark email delivery
open Scribe Open Raw SQL / DSN retrieval
health Orchestrator Health/ping/warmup
admin Admin Reseed/reset admin category
ai Agent Runtime Agent execution, LLM completions, RAG, artifacts, results, orchestration, STT/TTS
workflow Workflow Manager Workflow CRUD, categories/pipelines, templates, execution
oracle / stt Oracle Real-time streaming STT with VAD (WebSocket, requires oracle extras)
fastapi Local FastAPI route auth decorators (@jwt, @psk, @scopes)

Configuration

Required:

  • DOMINUS_TOKEN -- PSK token for gateway authentication

Optional:

  • DOMINUS_GATEWAY_URL -- Override gateway URL (default: https://gateway.getdominus.app)
  • DOMINUS_JWT_URL -- Override JWT worker URL (default: https://jwt.getdominus.app)
  • DOMINUS_LOGS_URL -- Override logs worker URL (default: https://logs.getdominus.app)
  • DOMINUS_BASE_URL -- Override orchestrator URL (default: production Cloud Run)
  • DOMINUS_HTTP_PROXY / DOMINUS_HTTPS_PROXY -- httpx proxy configuration
  • DOMINUS_CAPTURE_CONSOLE -- Set to "true" to auto-forward print() and logging.* to Logs Worker

Installation

pip install dominus-sdk-python

# With optional extras
pip install dominus-sdk-python[jwt]      # Local JWT verification
pip install dominus-sdk-python[oracle]   # WebSocket STT (websockets, numpy, sounddevice, webrtcvad)
pip install dominus-sdk-python[all]      # Everything

Console Capture

Forward print() and logging.* to the Dominus Logs Worker:

# Automatic (via env var, before importing SDK):
os.environ["DOMINUS_CAPTURE_CONSOLE"] = "true"

# Manual:
dominus.capture_console()     # start capturing
dominus.release_console()     # stop capturing

Documentation

License

Proprietary - CareBridge Systems

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dominus_sdk_python-2.13.0.tar.gz (79.6 kB view details)

Uploaded Source

Built Distribution

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

dominus_sdk_python-2.13.0-py3-none-any.whl (93.7 kB view details)

Uploaded Python 3

File details

Details for the file dominus_sdk_python-2.13.0.tar.gz.

File metadata

  • Download URL: dominus_sdk_python-2.13.0.tar.gz
  • Upload date:
  • Size: 79.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for dominus_sdk_python-2.13.0.tar.gz
Algorithm Hash digest
SHA256 bd610efa03326cfdbedf73d5fdcc7e295fd91b36decd2516019aa52e2591f373
MD5 30285d98af27a435e5aa175f1b4e9a05
BLAKE2b-256 9d877ba169abfe90a2a62c77b3895045198f27af053c0b20e0ee5edadf660136

See more details on using hashes here.

File details

Details for the file dominus_sdk_python-2.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dominus_sdk_python-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c015516954a9261988266c9072a2b5da705941a1d922684fd7be0f828cb83b6e
MD5 4c03064d5298c50bedc303e7833025ae
BLAKE2b-256 b27d43a205cac811814ee3300598c6f21bce7e1a2fdd56f173df9a3af6ed923b

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