dbos 0.5.0a11__tar.gz → 0.5.0a12__tar.gz

dbos-0.5.0a12/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: dbos
+Version: 0.5.0a12
+Summary: Ultra-lightweight durable execution in Python
+Author-Email: "DBOS, Inc." <contact@dbos.dev>
+License: MIT
+Requires-Python: >=3.9
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: jsonschema>=4.23.0
+Requires-Dist: alembic>=1.13.2
+Requires-Dist: psycopg2-binary>=2.9.9
+Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
+Requires-Dist: typer>=0.12.3
+Requires-Dist: jsonpickle>=3.2.2
+Requires-Dist: opentelemetry-api>=1.26.0
+Requires-Dist: opentelemetry-sdk>=1.26.0
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.26.0
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: fastapi[standard]>=0.112.1
+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 🚀
+
+---
+
+📚 **Documentation**: Under Construction 🚧
+
+💬 **Join the Discussion**: [Discord Community](https://discord.gg/fMwQjeW5zg)
+
+---
+
+
+**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.
+For example:
+
+```python
+@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](https://demo-widget-store.cloud.dbos.dev/) (source code [here](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python/widget-store)).
+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&mdash;there's no need for a "workflow server."
+This approach is also incredibly fast, for example [25x faster than AWS Step Functions](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark).
+
+Some more cool features include:
+
+- Scheduled jobs&mdash;run your workflows exactly-once per time interval.
+- Exactly-once event processing&mdash;use workflows to process incoming events (for example, from a Kafka topic) exactly-once.
+- Observability&mdash;all workflows automatically emit [OpenTelemetry](https://opentelemetry.io/) traces.
+
+## Getting Started
+
+To try out the latest pre-release version, install and configure with:
+
+```shell
+pip install --pre dbos
+dbos init --config
+```
+
+Try it out with this simple program (requires Postgres):
+
+```python
+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 workflow():
+    step_one()
+    for _ in range(5):
+        print("Press Control + \ to stop the app...")
+        DBOS.sleep(1)
+    step_two()
+
+@app.get("/")
+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.
+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).
+
+## Documentation
+
+Coming soon! 🚧
+
+## 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)
+
+## Community
+
+If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
+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](./CONTRIBUTING.md).

dbos-0.5.0a12/README.md

@@ -0,0 +1,107 @@
+## 🚀 DBOS Transact - Ultra-Lightweight Durable Execution in Python 🚀
+
+---
+
+📚 **Documentation**: Under Construction 🚧
+
+💬 **Join the Discussion**: [Discord Community](https://discord.gg/fMwQjeW5zg)
+
+---
+
+
+**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.
+For example:
+
+```python
+@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](https://demo-widget-store.cloud.dbos.dev/) (source code [here](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python/widget-store)).
+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](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark).
+
+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](https://opentelemetry.io/) traces.
+
+## Getting Started
+
+To try out the latest pre-release version, install and configure with:
+
+```shell
+pip install --pre dbos
+dbos init --config
+```
+
+Try it out with this simple program (requires Postgres):
+
+```python
+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 workflow():
+    step_one()
+    for _ in range(5):
+        print("Press Control + \ to stop the app...")
+        DBOS.sleep(1)
+    step_two()
+
+@app.get("/")
+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.
+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).
+
+## Documentation
+
+Coming soon! 🚧
+
+## 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)
+
+## Community
+
+If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
+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](./CONTRIBUTING.md).

{dbos-0.5.0a11 → dbos-0.5.0a12}/dbos/admin_sever.py

@@ -28,11 +28,11 @@ class AdminServer:
         self.server_thread = threading.Thread(target=self.server.serve_forever)
         self.server_thread.daemon = True
 
-        dbos_logger.info("Starting DBOS admin server on port %d", self.port)
+        dbos_logger.debug("Starting DBOS admin server on port %d", self.port)
         self.server_thread.start()
 
     def stop(self) -> None:
-        dbos_logger.info("Stopping DBOS admin server")
+        dbos_logger.debug("Stopping DBOS admin server")
         self.server.shutdown()
         self.server.server_close()
         self.server_thread.join()

{dbos-0.5.0a11 → dbos-0.5.0a12}/dbos/cli.py

@@ -119,7 +119,7 @@ def copy_template_dir(src_dir: str, dst_dir: str, ctx: dict[str, str]) -> None:
                 shutil.copy(src, dst)
 
 
-def copy_template(src_dir: str, project_name: str) -> None:
+def copy_template(src_dir: str, project_name: str, config_mode: bool) -> None:
 
     dst_dir = path.abspath(".")
 
@@ -131,10 +131,17 @@ def copy_template(src_dir: str, project_name: str) -> None:
         "db_name": db_name,
     }
 
-    copy_template_dir(src_dir, dst_dir, ctx)
-    copy_template_dir(
-        path.join(src_dir, "__package"), path.join(dst_dir, package_name), ctx
-    )
+    if config_mode:
+        copy_dbos_template(
+            os.path.join(src_dir, "dbos-config.yaml.dbos"),
+            os.path.join(dst_dir, "dbos-config.yaml"),
+            ctx,
+        )
+    else:
+        copy_template_dir(src_dir, dst_dir, ctx)
+        copy_template_dir(
+            path.join(src_dir, "__package"), path.join(dst_dir, package_name), ctx
+        )
 
 
 def get_project_name() -> typing.Union[str, None]:
@@ -173,6 +180,10 @@ def init(
         typing.Optional[str],
         typer.Option("--template", "-t", help="Specify template to use"),
     ] = None,
+    config: Annotated[
+        bool,
+        typer.Option("--config", "-c", help="Only add dbos-config.yaml"),
+    ] = False,
 ) -> None:
     try:
         if project_name is None:
@@ -199,7 +210,9 @@ def init(
             if template not in templates:
                 raise Exception(f"template {template} not found in {templates_dir}")
 
-        copy_template(path.join(templates_dir, template), project_name)
+        copy_template(
+            path.join(templates_dir, template), project_name, config_mode=config
+        )
     except Exception as e:
         print(f"[red]{e}[/red]")
 

{dbos-0.5.0a11 → dbos-0.5.0a12}/dbos/system_database.py

@@ -230,7 +230,7 @@ class SystemDatabase:
     def wait_for_buffer_flush(self) -> None:
         # Wait until the buffers are flushed.
         while self._is_flushing_status_buffer or not self._is_buffers_empty:
-            dbos_logger.info("Waiting for system buffers to be exported")
+            dbos_logger.debug("Waiting for system buffers to be exported")
             time.sleep(1)
 
     def update_workflow_status(

{dbos-0.5.0a11 → dbos-0.5.0a12}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "dbos"
 dynamic = []
-description = "A Python framework for backends that scale"
+description = "Ultra-lightweight durable execution in Python"
 authors = [
     { name = "DBOS, Inc.", email = "contact@dbos.dev" },
 ]
@@ -23,7 +23,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.5.0a11"
+version = "0.5.0a12"
 
 [project.license]
 text = "MIT"

dbos-0.5.0a11/PKG-INFO

@@ -1,78 +0,0 @@
-Metadata-Version: 2.1
-Name: dbos
-Version: 0.5.0a11
-Summary: A Python framework for backends that scale
-Author-Email: "DBOS, Inc." <contact@dbos.dev>
-License: MIT
-Requires-Python: >=3.9
-Requires-Dist: pyyaml>=6.0.2
-Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: alembic>=1.13.2
-Requires-Dist: psycopg2-binary>=2.9.9
-Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
-Requires-Dist: typer>=0.12.3
-Requires-Dist: jsonpickle>=3.2.2
-Requires-Dist: opentelemetry-api>=1.26.0
-Requires-Dist: opentelemetry-sdk>=1.26.0
-Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.26.0
-Requires-Dist: python-dateutil>=2.9.0.post0
-Requires-Dist: fastapi[standard]>=0.112.1
-Requires-Dist: psutil>=6.0.0
-Requires-Dist: tomlkit>=0.13.2
-Description-Content-Type: text/markdown
-
-# DBOS Transact Python
-
-**DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
-
-DBOS Transact is a **Python library** for building durable and scalable applications.
-
-You want to use DBOS Transact in your application because you need:
-
-- **Resilience to any failure**.  If your app is interrupted for any reason, it automatically resumes from where it left off.  Reliable message delivery is built in. Idempotency is built in.
-- **Reliable event processing**. Need to consume Kafka events exactly-once? Just add one line of code to your app. Need to run a task exactly once per hour, day, or month? Just one more line of code.
-- **Built-in observability**. Automatically emit [OpenTelemetry](https://opentelemetry.io/)-compatible logs and traces from any application. Query your app's history from the command line or with SQL.
-- **Blazing-fast, developer-friendly serverless**.  Develop your project locally and run it anywhere. When you're ready, [deploy it for free to DBOS Cloud](https://docs.dbos.dev/getting-started/quickstart#deploying-to-dbos-cloud) and we'll host it for you, [25x faster](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark) and [15x cheaper](https://www.dbos.dev/blog/dbos-vs-lambda-cost) than AWS Lambda.
-
-## Getting Started
-
-To try out the latest pre-release version, install with:
-
-```shell
-pip install --pre dbos
-```
-
-## Documentation
-
-Coming soon! 🚧
-
-But we have some cool demo apps for you to check out: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
-
-## Main Features
-
-Here are some of the core features of DBOS Transact:
-
-| Feature                                                                       | Description
-| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| [Transactions](https://www.dbos.dev/dbos-transact-python)                                      | Easily and safely query your application database using [SQLAlchemy](https://www.sqlalchemy.org/) or raw SQL.
-| [Workflows](https://www.dbos.dev/dbos-transact-python)                                         | Reliable workflow orchestration&#8212;resume your program after any failure.
-| [Idempotency](https://www.dbos.dev/dbos-transact-python)                                       | Automatically make any request idempotent, so your requests happen exactly once.
-| [Authentication and Authorization](https://www.dbos.dev/dbos-transact-python)                  | Secure your HTTP endpoints so only authorized users can access them.
-| [Kafka Integration](https://www.dbos.dev/dbos-transact-python)                                 | Consume Kafka messages exactly-once with transactions or workflows.
-| [Scheduled Workflows](https://www.dbos.dev/dbos-transact-python)                               | Schedule your workflows to run exactly-once per time interval with cron-like syntax.
-| [Self-Hosting](https://www.dbos.dev/dbos-transact-python)                                      | Host your applications anywhere, as long as they have a Postgres database to connect to.
-
-And DBOS Cloud:
-
-| Feature                                                                       | Description
-| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| [Serverless App Deployment](https://docs.dbos.dev/cloud-tutorials/application-management)      | Deploy apps to DBOS Cloud in minutes.
-| [Interactive Time Travel](https://docs.dbos.dev/cloud-tutorials/interactive-timetravel)        | Query your application database as of any past point in time.
-| [Cloud Database Management](https://docs.dbos.dev/cloud-tutorials/database-management)         | Provision cloud Postgres instances for your applications. Alternatively, [bring your own database](https://docs.dbos.dev/cloud-tutorials/byod-management).
-| [Built-in Observability](https://docs.dbos.dev/cloud-tutorials/monitoring-dashboard)           | Built-in log capture, request tracing, and dashboards.
-
-## Community
-
-If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
-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](./CONTRIBUTING.md).

dbos-0.5.0a11/README.md

@@ -1,55 +0,0 @@
-# DBOS Transact Python
-
-**DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
-
-DBOS Transact is a **Python library** for building durable and scalable applications.
-
-You want to use DBOS Transact in your application because you need:
-
-- **Resilience to any failure**.  If your app is interrupted for any reason, it automatically resumes from where it left off.  Reliable message delivery is built in. Idempotency is built in.
-- **Reliable event processing**. Need to consume Kafka events exactly-once? Just add one line of code to your app. Need to run a task exactly once per hour, day, or month? Just one more line of code.
-- **Built-in observability**. Automatically emit [OpenTelemetry](https://opentelemetry.io/)-compatible logs and traces from any application. Query your app's history from the command line or with SQL.
-- **Blazing-fast, developer-friendly serverless**.  Develop your project locally and run it anywhere. When you're ready, [deploy it for free to DBOS Cloud](https://docs.dbos.dev/getting-started/quickstart#deploying-to-dbos-cloud) and we'll host it for you, [25x faster](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark) and [15x cheaper](https://www.dbos.dev/blog/dbos-vs-lambda-cost) than AWS Lambda.
-
-## Getting Started
-
-To try out the latest pre-release version, install with:
-
-```shell
-pip install --pre dbos
-```
-
-## Documentation
-
-Coming soon! 🚧
-
-But we have some cool demo apps for you to check out: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
-
-## Main Features
-
-Here are some of the core features of DBOS Transact:
-
-| Feature                                                                       | Description
-| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| [Transactions](https://www.dbos.dev/dbos-transact-python)                                      | Easily and safely query your application database using [SQLAlchemy](https://www.sqlalchemy.org/) or raw SQL.
-| [Workflows](https://www.dbos.dev/dbos-transact-python)                                         | Reliable workflow orchestration—resume your program after any failure.
-| [Idempotency](https://www.dbos.dev/dbos-transact-python)                                       | Automatically make any request idempotent, so your requests happen exactly once.
-| [Authentication and Authorization](https://www.dbos.dev/dbos-transact-python)                  | Secure your HTTP endpoints so only authorized users can access them.
-| [Kafka Integration](https://www.dbos.dev/dbos-transact-python)                                 | Consume Kafka messages exactly-once with transactions or workflows.
-| [Scheduled Workflows](https://www.dbos.dev/dbos-transact-python)                               | Schedule your workflows to run exactly-once per time interval with cron-like syntax.
-| [Self-Hosting](https://www.dbos.dev/dbos-transact-python)                                      | Host your applications anywhere, as long as they have a Postgres database to connect to.
-
-And DBOS Cloud:
-
-| Feature                                                                       | Description
-| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| [Serverless App Deployment](https://docs.dbos.dev/cloud-tutorials/application-management)      | Deploy apps to DBOS Cloud in minutes.
-| [Interactive Time Travel](https://docs.dbos.dev/cloud-tutorials/interactive-timetravel)        | Query your application database as of any past point in time.
-| [Cloud Database Management](https://docs.dbos.dev/cloud-tutorials/database-management)         | Provision cloud Postgres instances for your applications. Alternatively, [bring your own database](https://docs.dbos.dev/cloud-tutorials/byod-management).
-| [Built-in Observability](https://docs.dbos.dev/cloud-tutorials/monitoring-dashboard)           | Built-in log capture, request tracing, and dashboards.
-
-## Community
-
-If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
-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](./CONTRIBUTING.md).