pyworkflow-engine 0.3.7__tar.gz → 0.4.0__tar.gz

{pyworkflow_engine-0.3.7 → pyworkflow_engine-0.4.0}/DISTRIBUTED.md

@@ -87,17 +87,20 @@ celery -A pyworkflow.celery.app beat --loglevel=info
 ```python
 from pyworkflow import workflow, step, start, sleep
 
+
 @step()
 async def process_item(item_id: int):
     # This runs on any available worker
     return f"Processed {item_id}"
 
+
 @workflow
 async def my_workflow(item_id: int):
     result = await process_item(item_id)
     await sleep("5m")  # Automatically resumes after 5 minutes!
     return result
 
+
 # Start workflow - executes across workers
 run_id = start(my_workflow, item_id=123)
 ```
@@ -233,7 +236,7 @@ from pyworkflow.celery import create_celery_app
 app = create_celery_app(
     broker_url="redis://redis-cluster:6379/0",
     result_backend="redis://redis-cluster:6379/1",
-    app_name="my_workflows"
+    app_name="my_workflows",
 )
 
 # Additional configuration

{pyworkflow_engine-0.3.7 → pyworkflow_engine-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyworkflow-engine
-Version: 0.3.7
+Version: 0.4.0
 Summary: A Python implementation of durable, event-sourced workflows inspired by Vercel Workflow
 Author: PyWorkflow Contributors
 License: MIT
@@ -26,50 +26,50 @@ Requires-Dist: celery<6.0.0,>=5.3.0
 Requires-Dist: cloudpickle>=3.0.0
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: loguru>=0.7.0
-Requires-Dist: click>=8.4.1
+Requires-Dist: click>=8.4.2
 Requires-Dist: inquirerpy>=0.3.4; python_version < "4.0"
 Requires-Dist: httpx>=0.25.0
 Requires-Dist: python-dateutil>=2.8.0
-Requires-Dist: filelock>=3.29.3
+Requires-Dist: filelock>=3.32.4
 Requires-Dist: pyyaml>=6.0.0
-Requires-Dist: croniter>=2.0.0
+Requires-Dist: croniter>=6.2.4
 Provides-Extra: redis
-Requires-Dist: redis>=5.0.0; extra == "redis"
+Requires-Dist: redis>=8.1.0; extra == "redis"
 Provides-Extra: sqlite
 Requires-Dist: aiosqlite>=0.19.0; extra == "sqlite"
 Provides-Extra: postgres
 Requires-Dist: asyncpg>=0.29.0; extra == "postgres"
 Provides-Extra: aws
-Requires-Dist: aws-durable-execution-sdk-python>=0.1.0; extra == "aws"
+Requires-Dist: aws-durable-execution-sdk-python>=1.6.0; extra == "aws"
 Provides-Extra: dynamodb
-Requires-Dist: aiobotocore>=3.7.0; extra == "dynamodb"
+Requires-Dist: aiobotocore>=3.9.0; extra == "dynamodb"
 Provides-Extra: cassandra
-Requires-Dist: cassandra-driver>=3.29.0; extra == "cassandra"
+Requires-Dist: cassandra-driver>=3.30.1; extra == "cassandra"
 Provides-Extra: mysql
 Requires-Dist: aiomysql>=0.2.0; extra == "mysql"
 Provides-Extra: all
-Requires-Dist: redis>=5.0.0; extra == "all"
+Requires-Dist: redis>=8.1.0; extra == "all"
 Requires-Dist: aiosqlite>=0.19.0; extra == "all"
 Requires-Dist: asyncpg>=0.29.0; extra == "all"
 Requires-Dist: aiomysql>=0.2.0; extra == "all"
-Requires-Dist: aws-durable-execution-sdk-python>=0.1.0; extra == "all"
-Requires-Dist: cassandra-driver>=3.29.0; extra == "all"
+Requires-Dist: aws-durable-execution-sdk-python>=1.6.0; extra == "all"
+Requires-Dist: cassandra-driver>=3.30.1; extra == "all"
 Provides-Extra: dev
-Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest>=9.1.1; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
 Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
 Requires-Dist: pytest-celery>=0.0.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
-Requires-Dist: moto[dynamodb]>=5.2.2; extra == "dev"
+Requires-Dist: moto[dynamodb]>=5.2.3; extra == "dev"
 Requires-Dist: black>=26.5.1; extra == "dev"
-Requires-Dist: ruff>=0.15.17; extra == "dev"
-Requires-Dist: mypy>=2.1.0; extra == "dev"
-Requires-Dist: pre-commit>=4.6.0; extra == "dev"
+Requires-Dist: ruff>=0.16.4; extra == "dev"
+Requires-Dist: mypy>=2.3.1; extra == "dev"
+Requires-Dist: pre-commit>=4.6.2; extra == "dev"
 Requires-Dist: types-redis>=4.6.0; extra == "dev"
-Requires-Dist: types-python-dateutil>=2.8.0; extra == "dev"
-Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
-Requires-Dist: flower>=2.0.0; extra == "dev"
-Requires-Dist: redis>=5.0.0; extra == "dev"
+Requires-Dist: types-python-dateutil>=2.9.0.20260807; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20260815; extra == "dev"
+Requires-Dist: flower>=2.1.0; extra == "dev"
+Requires-Dist: redis>=8.1.0; extra == "dev"
 Requires-Dist: aiosqlite>=0.19.0; extra == "dev"
 Requires-Dist: asyncpg>=0.29.0; extra == "dev"
 Dynamic: license-file
@@ -172,17 +172,20 @@ See [DISTRIBUTED.md](DISTRIBUTED.md) for complete deployment guide.
 ```python
 from pyworkflow import workflow, step, start, sleep
 
+
 @step()
 async def send_welcome_email(user_id: str):
     # This runs on any available Celery worker
     print(f"Sending welcome email to user {user_id}")
     return f"Email sent to {user_id}"
 
+
 @step()
 async def send_tips_email(user_id: str):
     print(f"Sending tips email to user {user_id}")
     return f"Tips sent to {user_id}"
 
+
 @workflow()
 async def onboarding_workflow(user_id: str):
     # Send welcome email immediately
@@ -196,6 +199,7 @@ async def onboarding_workflow(user_id: str):
 
     return "Onboarding complete"
 
+
 # Start workflow - executes across Celery workers
 run_id = start(onboarding_workflow, user_id="user_123")
 print(f"Workflow started: {run_id}")
@@ -221,6 +225,7 @@ Workflows are the top-level orchestration functions. They coordinate steps, hand
 ```python
 from pyworkflow import workflow, start
 
+
 @workflow(name="process_order", max_duration="1h")
 async def process_order(order_id: str):
     """
@@ -239,6 +244,7 @@ async def process_order(order_id: str):
 
     return {"order_id": order_id, "status": "completed"}
 
+
 # Start the workflow
 run_id = start(process_order, order_id="ORD-123")
 ```
@@ -250,6 +256,7 @@ Steps are the building blocks of workflows. Each step is an isolated, retryable
 ```python
 from pyworkflow import step, RetryableError, FatalError
 
+
 @step(max_retries=5, retry_delay="exponential")
 async def call_external_api(url: str):
     """
@@ -281,11 +288,13 @@ By default, steps in a Celery runtime are dispatched to worker processes via the
 ```python
 from pyworkflow import step
 
+
 @step(force_local=True)
 async def quick_transform(data: dict):
     """Runs inline even when runtime is Celery."""
     return {k: v.upper() for k, v in data.items()}
 
+
 @step()
 async def heavy_computation(data: dict):
     """Dispatched to a Celery worker as usual."""
@@ -311,6 +320,7 @@ Workflows can sleep for any duration. During sleep, the workflow suspends and co
 ```python
 from pyworkflow import workflow, sleep
 
+
 @workflow()
 async def scheduled_reminder(user_id: str):
     # Send immediate reminder
@@ -407,35 +417,33 @@ Use Python's native `asyncio.gather()` for parallel step execution:
 import asyncio
 from pyworkflow import workflow, step
 
+
 @step()
 async def fetch_user(user_id: str):
     # Fetch user data
     return {"id": user_id, "name": "Alice"}
 
+
 @step()
 async def fetch_orders(user_id: str):
     # Fetch user orders
     return [{"id": "ORD-1"}, {"id": "ORD-2"}]
 
+
 @step()
 async def fetch_recommendations(user_id: str):
     # Fetch recommendations
     return ["Product A", "Product B"]
 
+
 @workflow()
 async def dashboard_data(user_id: str):
     # Fetch all data in parallel
     user, orders, recommendations = await asyncio.gather(
-        fetch_user(user_id),
-        fetch_orders(user_id),
-        fetch_recommendations(user_id)
+        fetch_user(user_id), fetch_orders(user_id), fetch_recommendations(user_id)
     )
 
-    return {
-        "user": user,
-        "orders": orders,
-        "recommendations": recommendations
-    }
+    return {"user": user, "orders": orders, "recommendations": recommendations}
 ```
 
 ### Error Handling
@@ -445,6 +453,7 @@ PyWorkflow distinguishes between retriable and fatal errors:
 ```python
 from pyworkflow import FatalError, RetryableError, step
 
+
 @step(max_retries=3, retry_delay="exponential")
 async def process_payment(amount: float):
     try:
@@ -474,14 +483,15 @@ Workflows automatically recover from worker crashes:
 ```python
 from pyworkflow import workflow, step, sleep
 
+
 @workflow(
-    recover_on_worker_loss=True,    # Enable recovery (default for durable)
-    max_recovery_attempts=5,         # Max recovery attempts
+    recover_on_worker_loss=True,  # Enable recovery (default for durable)
+    max_recovery_attempts=5,  # Max recovery attempts
 )
 async def resilient_workflow(data_id: str):
-    data = await fetch_data(data_id)    # Completed steps are skipped on recovery
-    await sleep("10m")                   # Sleep state is preserved
-    return await process_data(data)      # Continues from here after crash
+    data = await fetch_data(data_id)  # Completed steps are skipped on recovery
+    await sleep("10m")  # Sleep state is preserved
+    return await process_data(data)  # Continues from here after crash
 ```
 
 **What happens on worker crash:**
@@ -516,18 +526,10 @@ Prevent duplicate workflow executions with idempotency keys:
 from pyworkflow import start
 
 # Same idempotency key = same workflow
-run_id_1 = start(
-    process_order,
-    order_id="ORD-123",
-    idempotency_key="order-ORD-123"
-)
+run_id_1 = start(process_order, order_id="ORD-123", idempotency_key="order-ORD-123")
 
 # This will return the same run_id, not start a new workflow
-run_id_2 = start(
-    process_order,
-    order_id="ORD-123",
-    idempotency_key="order-ORD-123"
-)
+run_id_2 = start(process_order, order_id="ORD-123", idempotency_key="order-ORD-123")
 
 assert run_id_1 == run_id_2  # True!
 ```
@@ -544,7 +546,7 @@ configure_logging(
     level="INFO",
     log_file="workflow.log",
     json_logs=True,  # JSON format for production
-    show_context=True  # Include run_id, step_id, etc.
+    show_context=True,  # Include run_id, step_id, etc.
 )
 
 # Logs automatically include:
@@ -565,15 +567,18 @@ import pytest
 from pyworkflow import workflow, step, start, configure, reset_config
 from pyworkflow.storage.memory import InMemoryStorageBackend
 
+
 @step()
 async def my_step(x: int):
     return x * 2
 
+
 @workflow()
 async def my_workflow(x: int):
     result = await my_step(x)
     return result + 1
 
+
 @pytest.fixture(autouse=True)
 def setup_storage():
     reset_config()
@@ -582,6 +587,7 @@ def setup_storage():
     yield storage
     reset_config()
 
+
 @pytest.mark.asyncio
 async def test_my_workflow(setup_storage):
     storage = setup_storage

{pyworkflow_engine-0.3.7 → pyworkflow_engine-0.4.0}/README.md

@@ -96,17 +96,20 @@ See [DISTRIBUTED.md](DISTRIBUTED.md) for complete deployment guide.
 ```python
 from pyworkflow import workflow, step, start, sleep
 
+
 @step()
 async def send_welcome_email(user_id: str):
     # This runs on any available Celery worker
     print(f"Sending welcome email to user {user_id}")
     return f"Email sent to {user_id}"
 
+
 @step()
 async def send_tips_email(user_id: str):
     print(f"Sending tips email to user {user_id}")
     return f"Tips sent to {user_id}"
 
+
 @workflow()
 async def onboarding_workflow(user_id: str):
     # Send welcome email immediately
@@ -120,6 +123,7 @@ async def onboarding_workflow(user_id: str):
 
     return "Onboarding complete"
 
+
 # Start workflow - executes across Celery workers
 run_id = start(onboarding_workflow, user_id="user_123")
 print(f"Workflow started: {run_id}")
@@ -145,6 +149,7 @@ Workflows are the top-level orchestration functions. They coordinate steps, hand
 ```python
 from pyworkflow import workflow, start
 
+
 @workflow(name="process_order", max_duration="1h")
 async def process_order(order_id: str):
     """
@@ -163,6 +168,7 @@ async def process_order(order_id: str):
 
     return {"order_id": order_id, "status": "completed"}
 
+
 # Start the workflow
 run_id = start(process_order, order_id="ORD-123")
 ```
@@ -174,6 +180,7 @@ Steps are the building blocks of workflows. Each step is an isolated, retryable
 ```python
 from pyworkflow import step, RetryableError, FatalError
 
+
 @step(max_retries=5, retry_delay="exponential")
 async def call_external_api(url: str):
     """
@@ -205,11 +212,13 @@ By default, steps in a Celery runtime are dispatched to worker processes via the
 ```python
 from pyworkflow import step
 
+
 @step(force_local=True)
 async def quick_transform(data: dict):
     """Runs inline even when runtime is Celery."""
     return {k: v.upper() for k, v in data.items()}
 
+
 @step()
 async def heavy_computation(data: dict):
     """Dispatched to a Celery worker as usual."""
@@ -235,6 +244,7 @@ Workflows can sleep for any duration. During sleep, the workflow suspends and co
 ```python
 from pyworkflow import workflow, sleep
 
+
 @workflow()
 async def scheduled_reminder(user_id: str):
     # Send immediate reminder
@@ -331,35 +341,33 @@ Use Python's native `asyncio.gather()` for parallel step execution:
 import asyncio
 from pyworkflow import workflow, step
 
+
 @step()
 async def fetch_user(user_id: str):
     # Fetch user data
     return {"id": user_id, "name": "Alice"}
 
+
 @step()
 async def fetch_orders(user_id: str):
     # Fetch user orders
     return [{"id": "ORD-1"}, {"id": "ORD-2"}]
 
+
 @step()
 async def fetch_recommendations(user_id: str):
     # Fetch recommendations
     return ["Product A", "Product B"]
 
+
 @workflow()
 async def dashboard_data(user_id: str):
     # Fetch all data in parallel
     user, orders, recommendations = await asyncio.gather(
-        fetch_user(user_id),
-        fetch_orders(user_id),
-        fetch_recommendations(user_id)
+        fetch_user(user_id), fetch_orders(user_id), fetch_recommendations(user_id)
     )
 
-    return {
-        "user": user,
-        "orders": orders,
-        "recommendations": recommendations
-    }
+    return {"user": user, "orders": orders, "recommendations": recommendations}
 ```
 
 ### Error Handling
@@ -369,6 +377,7 @@ PyWorkflow distinguishes between retriable and fatal errors:
 ```python
 from pyworkflow import FatalError, RetryableError, step
 
+
 @step(max_retries=3, retry_delay="exponential")
 async def process_payment(amount: float):
     try:
@@ -398,14 +407,15 @@ Workflows automatically recover from worker crashes:
 ```python
 from pyworkflow import workflow, step, sleep
 
+
 @workflow(
-    recover_on_worker_loss=True,    # Enable recovery (default for durable)
-    max_recovery_attempts=5,         # Max recovery attempts
+    recover_on_worker_loss=True,  # Enable recovery (default for durable)
+    max_recovery_attempts=5,  # Max recovery attempts
 )
 async def resilient_workflow(data_id: str):
-    data = await fetch_data(data_id)    # Completed steps are skipped on recovery
-    await sleep("10m")                   # Sleep state is preserved
-    return await process_data(data)      # Continues from here after crash
+    data = await fetch_data(data_id)  # Completed steps are skipped on recovery
+    await sleep("10m")  # Sleep state is preserved
+    return await process_data(data)  # Continues from here after crash
 ```
 
 **What happens on worker crash:**
@@ -440,18 +450,10 @@ Prevent duplicate workflow executions with idempotency keys:
 from pyworkflow import start
 
 # Same idempotency key = same workflow
-run_id_1 = start(
-    process_order,
-    order_id="ORD-123",
-    idempotency_key="order-ORD-123"
-)
+run_id_1 = start(process_order, order_id="ORD-123", idempotency_key="order-ORD-123")
 
 # This will return the same run_id, not start a new workflow
-run_id_2 = start(
-    process_order,
-    order_id="ORD-123",
-    idempotency_key="order-ORD-123"
-)
+run_id_2 = start(process_order, order_id="ORD-123", idempotency_key="order-ORD-123")
 
 assert run_id_1 == run_id_2  # True!
 ```
@@ -468,7 +470,7 @@ configure_logging(
     level="INFO",
     log_file="workflow.log",
     json_logs=True,  # JSON format for production
-    show_context=True  # Include run_id, step_id, etc.
+    show_context=True,  # Include run_id, step_id, etc.
 )
 
 # Logs automatically include:
@@ -489,15 +491,18 @@ import pytest
 from pyworkflow import workflow, step, start, configure, reset_config
 from pyworkflow.storage.memory import InMemoryStorageBackend
 
+
 @step()
 async def my_step(x: int):
     return x * 2
 
+
 @workflow()
 async def my_workflow(x: int):
     result = await my_step(x)
     return result + 1
 
+
 @pytest.fixture(autouse=True)
 def setup_storage():
     reset_config()
@@ -506,6 +511,7 @@ def setup_storage():
     yield storage
     reset_config()
 
+
 @pytest.mark.asyncio
 async def test_my_workflow(setup_storage):
     storage = setup_storage