Skip to main content

Ultra-lightweight durable execution in Python

Project description

DBOS Transact: Ultra-Lightweight Durable Execution

Documentation   •   Examples   •   Github   •   Discord


DBOS Transact is a Python library providing ultra-lightweight durable execution. For example:

@DBOS.step()
def step_one():
    ...

@DBOS.step()
def step_two():
    ...

@DBOS.workflow()
def workflow()
    step_one()
    step_two()

Durable execution means your program is resilient to any failure. If it is ever interrupted or crashes, all your workflows will automatically resume from the last completed step. If you want to see durable execution in action, check out this demo app (source code here). No matter how many times you try to crash it, it always resumes from exactly where it left off!

Under the hood, DBOS Transact works by storing your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database. So all you need to use it is a Postgres database to connect to—there's no need for a "workflow server." This approach is also incredibly fast, for example 25x faster than AWS Step Functions.

Some more cool features include:

  • Scheduled jobs—run your workflows exactly-once per time interval.
  • Exactly-once event processing—use workflows to process incoming events (for example, from a Kafka topic) exactly-once.
  • Observability—all workflows automatically emit OpenTelemetry traces.

Getting Started

Install and configure with:

pip install dbos
dbos init --config

Then, try it out with this simple program (requires Postgres):

from fastapi import FastAPI
from dbos import DBOS

app = FastAPI()
DBOS(fastapi=app)

@DBOS.step()
def step_one():
    print("Step one completed!")

@DBOS.step()
def step_two():
    print("Step two completed!")

@DBOS.workflow()
def dbos_workflow():
    step_one()
    for _ in range(5):
        print("Press Control + \ to stop the app...")
        DBOS.sleep(1)
    step_two()

@app.get("/")
def fastapi_endpoint():
    dbos_workflow()

Save the program into main.py, edit dbos-config.yaml to configure your Postgres connection settings, and start it with fastapi run. Visit localhost:8000 in your browser to start the workflow. When prompted, press Control + \ to force quit your application. It should crash midway through the workflow, having completed step one but not step two. Then, restart your app with fastapi run. It should resume the workflow from where it left off, completing step two without re-executing step one.

To learn how to build more complex workflows, see our programming guide or examples.

Documentation

https://docs.dbos.dev

Examples

  • AI-Powered Slackbot — A Slackbot that answers questions about previous Slack conversations, using DBOS to durably orchestrate its RAG pipeline.
  • Widget Store — An online storefront that uses DBOS durable workflows to be resilient to any failure.
  • Earthquake Tracker — A real-time earthquake dashboard that uses DBOS to stream data from the USGS into Postgres, then visualizes it with Streamlit.

More examples here!

Community

If you're interested in building with us, please star our repository and join our community on Discord! If you see a bug or have a feature request, don't hesitate to open an issue here on GitHub. If you're interested in contributing, check out our contributions guide.

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

dbos-0.12.0.tar.gz (104.4 kB view details)

Uploaded Source

Built Distribution

dbos-0.12.0-py3-none-any.whl (83.3 kB view details)

Uploaded Python 3

File details

Details for the file dbos-0.12.0.tar.gz.

File metadata

  • Download URL: dbos-0.12.0.tar.gz
  • Upload date:
  • Size: 104.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dbos-0.12.0.tar.gz
Algorithm Hash digest
SHA256 706a06c503bfc91c85d74a4601b2f234bdf21d82cbbab40e3fd7b3e4c72dbaa9
MD5 745125910846f20aad50663d24608337
BLAKE2b-256 799dd6780911069a9e854c29be3608d8c8cdf2c5d9940f60b4d716d8a84fb68a

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbos-0.12.0.tar.gz:

Publisher: publish.yml on dbos-inc/dbos-transact-py

Attestations:

File details

Details for the file dbos-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: dbos-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 83.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dbos-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc51c9ba6cec967981e855ced7a9c4a6da2af73bd70a8e17d53e6e6de4907c22
MD5 8719c2c2f083fb25107a4dbce6870d93
BLAKE2b-256 b48f97255ba7a0741e81d32cb6e0bc8574f354a67de27f77506336f4cf81e16c

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbos-0.12.0-py3-none-any.whl:

Publisher: publish.yml on dbos-inc/dbos-transact-py

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page