dbos 0.6.0a0__tar.gz → 0.6.0a4__tar.gz

{dbos-0.6.0a0 → dbos-0.6.0a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 0.6.0a0
+Version: 0.6.0a4
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT
@@ -21,20 +21,17 @@ Requires-Dist: psutil>=6.0.0
 Requires-Dist: tomlkit>=0.13.2
 Description-Content-Type: text/markdown
 
-## 🚀 DBOS Transact - Ultra-Lightweight Durable Execution in Python 🚀
 
----
+<div align="center">
 
-📚 **Documentation**: Under Construction 🚧
+# DBOS Transact: Ultra-Lightweight Durable Execution
 
-💬 **Join the Discussion**: [Discord Community](https://discord.gg/fMwQjeW5zg)
+#### [Documentation](https://docs.dbos.dev/) &nbsp;&nbsp;•&nbsp;&nbsp;  [Examples](https://docs.dbos.dev/examples) &nbsp;&nbsp;•&nbsp;&nbsp; [Github](https://github.com/dbos-inc) &nbsp;&nbsp;•&nbsp;&nbsp; [Discord](https://discord.com/invite/jsmC6pXGgX)
+</div>
 
 ---
 
-
-**DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
-
-DBOS Transact is a **Python library** providing ultra-lightweight durable execution.
+DBOS Transact is a Python library providing **ultra-lightweight durable execution**.
 For example:
 
 ```python
@@ -69,14 +66,14 @@ Some more cool features include:
 
 ## Getting Started
 
-To try out the latest pre-release version, install and configure with:
+Install and configure with:
 
 ```shell
-pip install --pre dbos
+pip install dbos
 dbos init --config
 ```
 
-Try it out with this simple program (requires Postgres):
+Then, try it out with this simple program (requires Postgres):
 
 ```python
 from fastapi import FastAPI
@@ -106,22 +103,27 @@ def endpoint():
     workflow()
 ```
 
-Save the program into `main.py`, tell it your local Postgres password via `export PGPASSWORD=<your password>` and start it with `fastapi run`.
-Visit `localhost:8000` in your browser (or curl it) to start the 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 examples, see our programming guide (coming soon).
+To learn how to build more complex workflows, see our [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
 
 ## Documentation
 
-Coming soon! 🚧
+[https://docs.dbos.dev](https://docs.dbos.dev)
 
 ## Examples
 
-Check out some cool demo apps here: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
+
+- [**AI-Powered Slackbot**](https://docs.dbos.dev/python/examples/rag-slackbot) &mdash; A Slackbot that answers questions about previous Slack conversations, using DBOS to durably orchestrate its RAG pipeline.
+- [**Widget Store**](https://docs.dbos.dev/python/examples/widget-store) &mdash; An online storefront that uses DBOS durable workflows to be resilient to any failure.
+- [**Earthquake Tracker**](https://docs.dbos.dev/python/examples/earthquake-tracker) &mdash; A real-time earthquake dashboard that uses DBOS to stream data from the USGS into Postgres, then visualizes it with Streamlit.
+
+More examples [here](https://docs.dbos.dev/examples)!
 
 ## Community
 

{dbos-0.6.0a0 → dbos-0.6.0a4}/README.md

@@ -1,17 +1,14 @@
-## 🚀 DBOS Transact - Ultra-Lightweight Durable Execution in Python 🚀
 
----
+<div align="center">
 
-📚 **Documentation**: Under Construction 🚧
+# DBOS Transact: Ultra-Lightweight Durable Execution
 
-💬 **Join the Discussion**: [Discord Community](https://discord.gg/fMwQjeW5zg)
+#### [Documentation](https://docs.dbos.dev/) &nbsp;&nbsp;•&nbsp;&nbsp;  [Examples](https://docs.dbos.dev/examples) &nbsp;&nbsp;•&nbsp;&nbsp; [Github](https://github.com/dbos-inc) &nbsp;&nbsp;•&nbsp;&nbsp; [Discord](https://discord.com/invite/jsmC6pXGgX)
+</div>
 
 ---
 
-
-**DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
-
-DBOS Transact is a **Python library** providing ultra-lightweight durable execution.
+DBOS Transact is a Python library providing **ultra-lightweight durable execution**.
 For example:
 
 ```python
@@ -46,14 +43,14 @@ Some more cool features include:
 
 ## Getting Started
 
-To try out the latest pre-release version, install and configure with:
+Install and configure with:
 
 ```shell
-pip install --pre dbos
+pip install dbos
 dbos init --config
 ```
 
-Try it out with this simple program (requires Postgres):
+Then, try it out with this simple program (requires Postgres):
 
 ```python
 from fastapi import FastAPI
@@ -83,22 +80,27 @@ def endpoint():
     workflow()
 ```
 
-Save the program into `main.py`, tell it your local Postgres password via `export PGPASSWORD=<your password>` and start it with `fastapi run`.
-Visit `localhost:8000` in your browser (or curl it) to start the 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 examples, see our programming guide (coming soon).
+To learn how to build more complex workflows, see our [programming guide](https://docs.dbos.dev/python/programming-guide) or [examples](https://docs.dbos.dev/examples).
 
 ## Documentation
 
-Coming soon! 🚧
+[https://docs.dbos.dev](https://docs.dbos.dev)
 
 ## Examples
 
-Check out some cool demo apps here: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
+
+- [**AI-Powered Slackbot**](https://docs.dbos.dev/python/examples/rag-slackbot) &mdash; A Slackbot that answers questions about previous Slack conversations, using DBOS to durably orchestrate its RAG pipeline.
+- [**Widget Store**](https://docs.dbos.dev/python/examples/widget-store) &mdash; An online storefront that uses DBOS durable workflows to be resilient to any failure.
+- [**Earthquake Tracker**](https://docs.dbos.dev/python/examples/earthquake-tracker) &mdash; A real-time earthquake dashboard that uses DBOS to stream data from the USGS into Postgres, then visualizes it with Streamlit.
+
+More examples [here](https://docs.dbos.dev/examples)!
 
 ## Community
 

{dbos-0.6.0a0 → dbos-0.6.0a4}/dbos/dbos.py

@@ -714,6 +714,12 @@ class DBOS:
         ctx = assert_current_dbos_context()
         return ctx.authenticated_roles
 
+    @classproperty
+    def assumed_role(cls) -> Optional[str]:
+        """Return the role currently assumed by the authenticated user, if any, associated with the current context."""
+        ctx = assert_current_dbos_context()
+        return ctx.assumed_role
+
     @classmethod
     def set_authentication(
         cls, authenticated_user: Optional[str], authenticated_roles: Optional[List[str]]
@@ -800,13 +806,9 @@ class DBOSConfiguredInstance:
 
     """
 
-    def __init__(self, config_name: str, dbos: Optional[DBOS] = None) -> None:
+    def __init__(self, config_name: str) -> None:
         self.config_name = config_name
-        if dbos is not None:
-            assert isinstance(dbos, DBOS)
-            dbos._registry.register_instance(self)
-        else:
-            DBOS.register_instance(self)
+        DBOS.register_instance(self)
 
 
 # Apps that import DBOS probably don't exit.  If they do, let's see if

{dbos-0.6.0a0 → dbos-0.6.0a4}/dbos/dbos_config.py

@@ -2,7 +2,7 @@ import json
 import os
 import re
 from importlib import resources
-from typing import Dict, List, Optional, TypedDict
+from typing import Any, Dict, List, Optional, TypedDict
 
 import yaml
 from jsonschema import ValidationError, validate
@@ -69,6 +69,7 @@ class ConfigFile(TypedDict, total=False):
     database: DatabaseConfig
     telemetry: Optional[TelemetryConfig]
     env: Dict[str, str]
+    application: Dict[str, Any]
 
 
 def substitute_env_vars(content: str) -> str:

{dbos-0.6.0a0 → dbos-0.6.0a4}/dbos/templates/hello/__package/main.py

@@ -2,13 +2,12 @@
 
 # This is a sample app built with DBOS and FastAPI.
 # It displays greetings to visitors and keeps track of how
-# many times each visitor has been greeted.
+# many times visitors have been greeted.
 
 # First, let's do imports, create a FastAPI app, and initialize DBOS.
 
 from fastapi import FastAPI
 from fastapi.responses import HTMLResponse
-from sqlalchemy.dialects.postgresql import insert
 
 from dbos import DBOS
 
@@ -19,33 +18,26 @@ DBOS(fastapi=app)
 
 # Next, let's write a function that greets visitors.
 # To make it more interesting, we'll keep track of how
-# many times each visitor has been greeted and store
+# many times visitors have been greeted and store
 # the count in the database.
 
-# We annotate this function with @DBOS.transaction to
-# access to an automatically-configured database client,
-# (DBOS.sql_sesion) then implement the database operations
-# using SQLAlchemy. We serve this function from a FastAPI endpoint.
+# We implement the database operations using SQLAlchemy
+# and serve the function from a FastAPI endpoint.
+# We annotate it with @DBOS.transaction() to access
+# an automatically-configured database client.
 
 
 @app.get("/greeting/{name}")
 @DBOS.transaction()
 def example_transaction(name: str) -> str:
-    query = (
-        insert(dbos_hello)
-        .values(name="dbos", greet_count=1)
-        .on_conflict_do_update(
-            index_elements=["name"], set_={"greet_count": dbos_hello.c.greet_count + 1}
-        )
-        .returning(dbos_hello.c.greet_count)
-    )
+    query = dbos_hello.insert().values(name=name).returning(dbos_hello.c.greet_count)
     greet_count = DBOS.sql_session.execute(query).scalar_one()
     greeting = f"Greetings, {name}! You have been greeted {greet_count} times."
     DBOS.logger.info(greeting)
     return greeting
 
 
-# Finally, let's use FastAPI to serve a simple HTML readme
+# Finally, let's use FastAPI to serve an HTML + CSS readme
 # from the root path.
 
 
@@ -74,13 +66,14 @@ def readme() -> HTMLResponse:
     return HTMLResponse(readme)
 
 
-# To run this app locally:
-# - Make sure you have a Postgres database to connect
-# - "dbos migrate" to set up your database tables
-# - "dbos start" to start the app
-# - Visit localhost:8000 to see your app!
-
 # To deploy this app to DBOS Cloud:
 # - "npm i -g @dbos-inc/dbos-cloud@latest" to install the Cloud CLI (requires Node)
 # - "dbos-cloud app deploy" to deploy your app
 # - Deploy outputs a URL--visit it to see your app!
+
+
+# To run this app locally:
+# - Make sure you have a Postgres database to connect to
+# - "dbos migrate" to set up your database tables
+# - "dbos start" to start the app
+# - Visit localhost:8000 to see your app!

{dbos-0.6.0a0 → dbos-0.6.0a4}/dbos/templates/hello/__package/schema.py

@@ -5,6 +5,6 @@ metadata = MetaData()
 dbos_hello = Table(
     "dbos_hello",
     metadata,
-    Column("name", String, primary_key=True),
-    Column("greet_count", Integer, default=0),
+    Column("greet_count", Integer, primary_key=True, autoincrement=True),
+    Column("name", String, nullable=False),
 )

{dbos-0.6.0a0 → dbos-0.6.0a4}/dbos/templates/hello/migrations/versions/2024_07_31_180642_init.py

@@ -22,9 +22,9 @@ def upgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
     op.create_table(
         "dbos_hello",
+        sa.Column("greet_count", sa.Integer(), autoincrement=True, nullable=False),
         sa.Column("name", sa.String(), nullable=False),
-        sa.Column("greet_count", sa.Integer(), nullable=True),
-        sa.PrimaryKeyConstraint("name"),
+        sa.PrimaryKeyConstraint("greet_count"),
     )
     # ### end Alembic commands ###
 

{dbos-0.6.0a0 → dbos-0.6.0a4}/pyproject.toml

@@ -23,7 +23,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.6.0a0"
+version = "0.6.0a4"
 
 [project.license]
 text = "MIT"

{dbos-0.6.0a0 → dbos-0.6.0a4}/tests/classdefs.py

@@ -61,7 +61,7 @@ class DBOSTestClass(DBOSConfiguredInstance):
     @DBOS.workflow()
     @DBOS.required_roles(["admin"])
     def test_func_admin(self, var: str) -> str:
-        assert assert_current_dbos_context().assumed_role == "admin"
+        assert DBOS.assumed_role == "admin"
         return self.config_name + ":" + var
 
 

{dbos-0.6.0a0 → dbos-0.6.0a4}/tests/test_classdecorators.py

@@ -49,7 +49,7 @@ def test_required_roles_class(dbos: DBOS) -> None:
     @DBOS.default_required_roles(["user"])
     class DBOSTestClassRR(DBOSConfiguredInstance):
         def __init__(self) -> None:
-            super().__init__("myconfig", dbos)
+            super().__init__("myconfig")
 
         @DBOS.workflow()
         def test_func_user(self, var: str) -> str:
@@ -279,7 +279,7 @@ def test_simple_workflow_inst(dbos: DBOS) -> None:
     @DBOS.dbos_class()
     class DBOSTestClassInst(DBOSConfiguredInstance):
         def __init__(self) -> None:
-            super().__init__("bob", dbos)
+            super().__init__("bob")
             self.txn_counter: int = 0
             self.wf_counter: int = 0
             self.step_counter: int = 0
@@ -327,7 +327,7 @@ def test_simple_workflow_inst(dbos: DBOS) -> None:
 def test_forgotten_decorator(dbos: DBOS) -> None:
     class DBOSTestRegErr(DBOSConfiguredInstance):
         def __init__(self) -> None:
-            super().__init__("bob", dbos)
+            super().__init__("bob")
             self.txn_counter: int = 0
             self.wf_counter: int = 0
             self.step_counter: int = 0
@@ -362,7 +362,7 @@ def test_duplicate_reg(dbos: DBOS) -> None:
     @DBOS.dbos_class()
     class DBOSTestRegDup(DBOSConfiguredInstance):
         def __init__(self) -> None:
-            super().__init__("bob", dbos)
+            super().__init__("bob")
 
     # Duplicate class registration
     with pytest.raises(Exception) as exc_info:
@@ -370,7 +370,7 @@ def test_duplicate_reg(dbos: DBOS) -> None:
         @DBOS.dbos_class()
         class DBOSTestRegDup(DBOSConfiguredInstance):  # type: ignore
             def __init__(self) -> None:
-                super().__init__("bob", dbos)
+                super().__init__("bob")
 
     assert "Duplicate type registration for class 'DBOSTestRegDup'" == str(
         exc_info.value
@@ -419,7 +419,7 @@ def test_inst_recovery(dbos: DBOS) -> None:
     @DBOS.dbos_class()
     class DBOSTestInstRec(DBOSConfiguredInstance):
         def __init__(self) -> None:
-            super().__init__("bob", dbos)
+            super().__init__("bob")
 
         @DBOS.workflow()
         def check_inst(self, arg1: str) -> str:

{dbos-0.6.0a0 → dbos-0.6.0a4}/tests/test_singleton.py

@@ -146,6 +146,12 @@ database:
 runtimeConfig:
   start:
     - python3 main.py
+application:
+  service_url: 'https://service.org'
+  service_config:
+    port: 80
+    user: "user"
+    password: "password"
 """
 
 
@@ -164,6 +170,12 @@ def test_config_before_singleton(cleanup_test_databases: None) -> None:
 
         x = DBOS.config.get("language")
         assert x == "python"
+        y = DBOS.config["language"]
+        assert y == "python"
+        url = DBOS.config["application"]["service_url"]
+        assert url == "https://service.org"
+        port = DBOS.config["application"]["service_config"]["port"]
+        assert port == 80
 
         # This is OK, it meant load_config anyway
         dbos: DBOS = DBOS()