novastack-workflows 0.1.0__tar.gz

novastack_workflows-0.1.0/.gitignore

@@ -0,0 +1,85 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+#IDE
+.DS_Store
+.idea
+.vscode
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Mkdocs documentation
+docs/_build/
+docs/api_reference/site/
+
+# Ruff
+.ruff_cache/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

novastack_workflows-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

novastack_workflows-0.1.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: novastack-workflows
+Version: 0.1.0
+Summary: A workflow engine to run AI applications with event-driven, stepwise control.
+Project-URL: Repository, https://github.com/novastack-project/novastack/tree/main/novastack-workflows
+Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: AI,LLM,QA,RAG,data,retrieval,semantic-search,workflows
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.14,>=3.11
+Requires-Dist: novastack-instrumentation<0.2.0,>=0.1.0
+Requires-Dist: novastack-utils<0.2.0,>=0.1.0
+Requires-Dist: pydantic<3.0.0,>=2.12.5
+Provides-Extra: dev
+Requires-Dist: httpx<1,>=0.28.1; extra == 'dev'
+Requires-Dist: pyright<1.2.0,>=1.1.409; extra == 'dev'
+Requires-Dist: pytest-asyncio<2.0.0,>=1.3.0; extra == 'dev'
+Requires-Dist: pytest<10.0.0,>=9.0.3; extra == 'dev'
+Requires-Dist: ruff<1.0.0,>=0.15.8; extra == 'dev'
+Provides-Extra: server
+Requires-Dist: fastapi<1,>=0.136.3; extra == 'server'
+Requires-Dist: uvicorn[standard]<1,>=0.49.0; extra == 'server'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img alt="Novastack workflows Logo" src=".github/images/logo-light.png" width="65%">
+</div>
+
+<div align="center">
+  <h3>A powerful and flexible event-driven workflow engine for Python, designed to build complex asynchronous workflows with ease.</h3>
+</div>
+
+<div align="center">
+  <img src="https://img.shields.io/pypi/v/novastack-workflows" alt="PyPI - Version">
+  <img src="https://github.com/novastack-project/novastack-workflows/actions/workflows/test.yml/badge.svg" alt="Testing">
+  <img
+    src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"
+    alt="Ruff">
+  <img src="https://img.shields.io/pepy/dt/novastack-workflows" alt="Pepy Total Downloads">
+  <img src="https://img.shields.io/pypi/l/novastack-workflows" alt="PyPI - License">
+</div>
+
+## Installation
+
+```bash
+pip install novastack-workflows
+```
+
+## Quick Start
+
+Here's a simple example to get you started with Novastack Workflows:
+
+```python
+from novastack_workflows import Workflow, Context, step
+from novastack_workflows.events import Event, StartEvent, StopEvent
+
+
+class MessageEvent(Event):
+    message: str
+
+class MyWorkflow(Workflow):
+
+    @step(when=StartEvent)
+    async def start(self, ctx: Context, ev: StartEvent) -> MessageEvent:
+        
+        input_msg = ev.get("message", "")
+        return MessageEvent(message=f"Processed: {input_msg}")
+
+    @step(when=MessageEvent)
+    async def process(self, ctx: Context, ev: MessageEvent) -> StopEvent:
+        return StopEvent(result=ev.message)
+
+
+async def main():
+    workflow = MyWorkflow()
+    result = await workflow.run(input_msg="Hello, World!")
+
+    print(result)
+```
+
+## Core Concepts
+
+### Workflow
+
+A workflow is a class that inherits from `Workflow` and contains one or more steps. It orchestrates the execution of steps based on events.
+
+### Steps
+
+Steps are asynchronous methods decorated with `@step(when=EventType)` that define what happens when a specific event is received.
+
+- Steps receive a `Context` and an `Event`.
+- Steps can return new events to trigger subsequent steps.
+
+### Events
+
+Events are the building blocks of workflows. They carry data between steps and trigger step execution.
+
+- **StartEvent**: Automatically triggered when a workflow starts
+- **StopEvent**: Signals the end of a workflow and carries the final result
+- **Custom Events**: Define your own events by inheriting from `Event`
+
+### Context
+
+The `Context` object provides access to workflow state and allows steps to share data throughout the workflow execution.
+
+```python
+# Read-only access
+current_value = ctx.state.count
+
+# Edit state
+async with ctx.store.edit_state() as state:
+    state.count = current_counter + 1
+
+# Send events
+ctx.send_event(MyEvent(...))
+```
+
+## Features
+
+| Feature                | Novastack Workflows     |
+| ---------------------- | ----------------------- |
+| Event-driven execution | ✅                       |
+| Fan-out (parallelism)  | ✅                       |
+| Async execution        | ✅                       |
+| Shared state           | ✅                       |
+| Event joins            | ✅                       |
+| Internal buffer        | ✅                       |
+| Declarative API        | ✅                       |
+| Observability          | ✅                       |
+
+## License
+
+Apache License 2.0

novastack_workflows-0.1.0/README.md

@@ -0,0 +1,109 @@
+<div align="center">
+  <img alt="Novastack workflows Logo" src=".github/images/logo-light.png" width="65%">
+</div>
+
+<div align="center">
+  <h3>A powerful and flexible event-driven workflow engine for Python, designed to build complex asynchronous workflows with ease.</h3>
+</div>
+
+<div align="center">
+  <img src="https://img.shields.io/pypi/v/novastack-workflows" alt="PyPI - Version">
+  <img src="https://github.com/novastack-project/novastack-workflows/actions/workflows/test.yml/badge.svg" alt="Testing">
+  <img
+    src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"
+    alt="Ruff">
+  <img src="https://img.shields.io/pepy/dt/novastack-workflows" alt="Pepy Total Downloads">
+  <img src="https://img.shields.io/pypi/l/novastack-workflows" alt="PyPI - License">
+</div>
+
+## Installation
+
+```bash
+pip install novastack-workflows
+```
+
+## Quick Start
+
+Here's a simple example to get you started with Novastack Workflows:
+
+```python
+from novastack_workflows import Workflow, Context, step
+from novastack_workflows.events import Event, StartEvent, StopEvent
+
+
+class MessageEvent(Event):
+    message: str
+
+class MyWorkflow(Workflow):
+
+    @step(when=StartEvent)
+    async def start(self, ctx: Context, ev: StartEvent) -> MessageEvent:
+        
+        input_msg = ev.get("message", "")
+        return MessageEvent(message=f"Processed: {input_msg}")
+
+    @step(when=MessageEvent)
+    async def process(self, ctx: Context, ev: MessageEvent) -> StopEvent:
+        return StopEvent(result=ev.message)
+
+
+async def main():
+    workflow = MyWorkflow()
+    result = await workflow.run(input_msg="Hello, World!")
+
+    print(result)
+```
+
+## Core Concepts
+
+### Workflow
+
+A workflow is a class that inherits from `Workflow` and contains one or more steps. It orchestrates the execution of steps based on events.
+
+### Steps
+
+Steps are asynchronous methods decorated with `@step(when=EventType)` that define what happens when a specific event is received.
+
+- Steps receive a `Context` and an `Event`.
+- Steps can return new events to trigger subsequent steps.
+
+### Events
+
+Events are the building blocks of workflows. They carry data between steps and trigger step execution.
+
+- **StartEvent**: Automatically triggered when a workflow starts
+- **StopEvent**: Signals the end of a workflow and carries the final result
+- **Custom Events**: Define your own events by inheriting from `Event`
+
+### Context
+
+The `Context` object provides access to workflow state and allows steps to share data throughout the workflow execution.
+
+```python
+# Read-only access
+current_value = ctx.state.count
+
+# Edit state
+async with ctx.store.edit_state() as state:
+    state.count = current_counter + 1
+
+# Send events
+ctx.send_event(MyEvent(...))
+```
+
+## Features
+
+| Feature                | Novastack Workflows     |
+| ---------------------- | ----------------------- |
+| Event-driven execution | ✅                       |
+| Fan-out (parallelism)  | ✅                       |
+| Async execution        | ✅                       |
+| Shared state           | ✅                       |
+| Event joins            | ✅                       |
+| Internal buffer        | ✅                       |
+| Declarative API        | ✅                       |
+| Observability          | ✅                       |
+
+## License
+
+Apache License 2.0

novastack_workflows-0.1.0/novastack_workflows/__init__.py

@@ -0,0 +1,14 @@
+# Context management
+from novastack_workflows.context import Context
+from novastack_workflows.decorators import step
+from novastack_workflows.events import Event, StartEvent, StopEvent
+from novastack_workflows.workflow import Workflow
+
+__all__ = [
+    "Workflow",
+    "Context",
+    "step",
+    "Event",
+    "StartEvent",
+    "StopEvent",
+]

novastack_workflows-0.1.0/novastack_workflows/context/__init__.py

@@ -0,0 +1,3 @@
+from novastack_workflows.context.context import Context
+
+__all__ = ["Context"]

novastack_workflows-0.1.0/novastack_workflows/context/context.py

@@ -0,0 +1,133 @@
+import asyncio
+from typing import TYPE_CHECKING, Any, Generic, TypeVar
+
+from pydantic import BaseModel, Field
+
+from novastack_workflows.context.state_store import InMemoryStateStore
+
+if TYPE_CHECKING:
+    from novastack_workflows.events import Event
+
+STATE_T = TypeVar("STATE_T", bound=BaseModel)
+
+class SerializedContext(BaseModel):
+
+    version: str = "1.0.0"
+    kind: str = "Context"
+    state: dict = Field(default_factory=dict)
+
+class Context(Generic[STATE_T]):
+    """
+    Workflow execution context with copy-on-write state management.
+
+    Provides robust, immutable state management through 'state_store'.
+
+    State is automatically initialized based on the type annotation.
+    If no type is provided, uses DictState.
+
+    Example:
+        ```python
+        class RunState(BaseModel):
+            counter: int = 0
+            items: list[str] = []
+
+
+        # With typed state - auto-initialized
+        @step
+        async def start(self, ctx: Context[RunState], ev: StartEvent):
+            async with ctx.store.edit_state() as state:
+                state.counter += 1  # RunState auto-initialized
+
+
+        @step
+        async def start(self, ctx: Context, ev: StartEvent):
+            async with ctx.store.edit_state() as state:
+                state.counter = 1
+        ```
+    """
+
+    def __init__(
+        self,
+        workflow: Any,
+        event_queue: asyncio.Queue["Event"] | Any | None = None,
+    ):
+        """
+        Initialize workflow context.
+
+        Each context is isolated and maintains its own state store.
+        State type is inferred from Context[StateType] annotation or defaults to DictState.
+
+        Args:
+            workflow: Workflow instance
+            event_queue: Event queue for emission
+        """
+        self._workflow = workflow
+
+        # Use provided queue or create asyncio.Queue
+        if event_queue is None:
+            self._event_queue: asyncio.Queue[Event] = asyncio.Queue()
+        else:
+            self._event_queue = event_queue
+
+        # Copy-on-write state store with auto-initialization
+        # Infer state type from workflow's _state_type if available
+        state_type = getattr(workflow, "_state_type", None)
+        self._store = InMemoryStateStore(state_type=state_type)
+
+    @property
+    def workflow(self) -> Any:
+        """Get workflow instance."""
+        return self._workflow
+
+    @property
+    def store(self):  # type: ignore[return]
+        """
+        Copy-on-write state store.
+
+        Provides immutability guarantees and thread-safety through
+        explicit edit contexts.
+
+        Example:
+            ```python
+            # Edit state
+            async with ctx.store.edit_state() as state:
+                state.counter += 1
+            ```
+        """
+        return self._store
+
+    @property
+    def state(self) -> BaseModel | None:
+        """
+        Get current state (read-only).
+
+        Convenience property for accessing store state.
+        Equivalent to ctx.store.state.
+
+        Example:
+            ```python
+            # Read-only access
+            current_value = ctx.state.counter
+            ```
+        """
+        return self._store.state
+
+    async def send_event(self, event: "Event") -> None:
+        """
+        Send an event to the workflow queue.
+
+        Args:
+            event(Event): Event to send
+
+        Example:
+            ```python
+            await ctx.send_event(MyEvent(data="processed"))
+            ```
+        """
+        await self._event_queue.put(event)
+
+    def to_dict(self) -> dict[str, Any]:
+        """Serialize context to dictionary."""
+        return SerializedContext(
+            state=self._store.to_dict()
+        ).model_dump()