Skip to content

FISCFED9/CLI / .agents/skills/plugins/antigravity-awesome-skills-claude/skills/dbos-python

dbos-python

Verified

Guide for building reliable, fault-tolerant Python applications with DBOS durable workflows. Use when adding DBOS to existing Python code, creating workflows and steps, or using queues for concurrency control.

FileKindSize
AGENTS.mdmarkdown2.7 KB
CLAUDE.mdmarkdown2.7 KB
SKILL.mdskill md2.6 KB
references/_sections.mdmarkdown1.4 KB
references/advanced-async.mdmarkdown2.5 KB
references/advanced-patching.mdmarkdown1.5 KB
references/advanced-versioning.mdmarkdown1.6 KB
references/client-enqueue.mdmarkdown1.4 KB
references/client-setup.mdmarkdown1.6 KB
references/comm-events.mdmarkdown1.5 KB
references/comm-messages.mdmarkdown1.5 KB
references/comm-streaming.mdmarkdown1.5 KB
references/lifecycle-config.mdmarkdown1.5 KB
references/lifecycle-fastapi.mdmarkdown1.5 KB
references/pattern-classes.mdmarkdown1.6 KB
references/pattern-debouncing.mdmarkdown1.6 KB
references/pattern-idempotency.mdmarkdown1.5 KB
references/pattern-scheduled.mdmarkdown1.5 KB
references/pattern-sleep.mdmarkdown1.3 KB
references/queue-basics.mdmarkdown1.3 KB
references/queue-concurrency.mdmarkdown1.3 KB
references/queue-deduplication.mdmarkdown1.6 KB
references/queue-listening.mdmarkdown1.6 KB
references/queue-partitioning.mdmarkdown1.8 KB
references/queue-priority.mdmarkdown1.5 KB
references/queue-rate-limiting.mdmarkdown1.3 KB
references/step-basics.mdmarkdown1.3 KB
references/step-retries.mdmarkdown1.4 KB
references/step-transactions.mdmarkdown1.7 KB
references/test-fixtures.mdmarkdown1.4 KB
references/workflow-background.mdmarkdown1.3 KB
references/workflow-constraints.mdmarkdown1.6 KB
references/workflow-control.mdmarkdown2.0 KB
references/workflow-determinism.mdmarkdown1.3 KB
references/workflow-introspection.mdmarkdown1.8 KB
references/workflow-timeout.mdmarkdown1.4 KB

references/client-setup.md

View on GitHub
---
title: Initialize DBOSClient for External Access
impact: HIGH
impactDescription: Enables external applications to interact with DBOS
tags: client, setup, initialization, external
---

## Initialize DBOSClient for External Access

Use `DBOSClient` to interact with DBOS from external applications (API servers, CLI tools, etc.).

**Incorrect (no cleanup):**

```python
from dbos import DBOSClient

client = DBOSClient(system_database_url=db_url)
handle = client.enqueue(options, data)
# Connection leaked - no destroy()!
```

**Correct (with cleanup):**

```python
import os
from dbos import DBOSClient

client = DBOSClient(
    system_database_url=os.environ["DBOS_SYSTEM_DATABASE_URL"]
)

try:
    handle = client.enqueue(options, data)
    result = handle.get_result()
finally:
    client.destroy()
```

Constructor parameters:
- `system_database_url`: Connection string to DBOS system database
- `serializer`: Must match the DBOS application's serializer (default: pickle)

## API Reference

Beyond `enqueue`, DBOSClient mirrors the DBOS API. Use the same patterns from other reference files:

| DBOSClient method | Same as DBOS method |
|-------------------|---------------------|
| `client.send()` | `DBOS.send()` - add `idempotency_key` for exactly-once |
| `client.get_event()` | `DBOS.get_event()` |
| `client.read_stream()` | `DBOS.read_stream()` |
| `client.list_workflows()` | `DBOS.list_workflows()` |
| `client.cancel_workflow()` | `DBOS.cancel_workflow()` |
| `client.resume_workflow()` | `DBOS.resume_workflow()` |
| `client.retrieve_workflow()` | `DBOS.retrieve_workflow()` |

Reference: [DBOSClient](https://docs.dbos.dev/python/reference/client)
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 318kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 318kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 318kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 318kUpdated Claude CodeCodexVerifiedInstall