perceptic-workflow-sdk 0.50.94__tar.gz

perceptic_workflow_sdk-0.50.94/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: perceptic-workflow-sdk
+Version: 0.50.94
+Summary: Python SDK for Perceptic Workflow definitions - cross-language Temporal workflow types
+Author: Perceptic Technologies Ltd.
+License: Proprietary
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: temporalio>=1.7.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+
+# Perceptic Workflow SDK
+
+Python SDK for Perceptic Workflow definitions. This package provides cross-language Temporal workflow types that are compatible with the Java workflow definitions in perceptic-core-client.
+
+## Installation
+
+```bash
+pip install perceptic-workflow-sdk
+```
+
+## Usage
+
+### Workflow Events
+
+```python
+from perceptic_workflow import (
+    WorkflowEvent,
+    InfoEvent,
+    CheckpointEvent,
+    UserInputEvent,
+    UserInputRequestEvent,
+    WorkflowCheckpointStatus,
+)
+
+# Create events
+info_event = InfoEvent(
+    event_id=1,
+    type="progress",
+    payload={"step": "processing"},
+    timestamp=datetime.now()
+)
+```
+
+### Implementing Workflows
+
+The SDK provides a mixin class for implementing Perceptic-compatible workflows:
+
+```python
+from temporalio import workflow
+from perceptic_workflow import PercepticWorkflowMixin, WorkflowEvent
+
+@workflow.defn
+class MyWorkflow(PercepticWorkflowMixin):
+    def __init__(self):
+        self._events: list[WorkflowEvent] = []
+        self._paused = False
+
+    @workflow.run
+    async def run(self, input: dict) -> dict:
+        # Your workflow logic here
+        pass
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_SUBMIT_USER_INPUT)
+    async def submit_user_input(self, inputs: dict) -> None:
+        self._paused = False
+        # Handle user input
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_INTERRUPT)
+    async def interrupt(self, reason: str) -> None:
+        # Handle interruption
+        pass
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_IS_PAUSED)
+    def is_paused(self) -> bool:
+        return self._paused
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_GET_EVENTS)
+    def get_events(self, after_event_id: int | None = None) -> list[WorkflowEvent]:
+        if after_event_id is None:
+            return self._events
+        return [e for e in self._events if e.event_id > after_event_id]
+```
+
+## Compatibility
+
+This package is designed to be compatible with:
+- perceptic-core-client (Java)
+- perceptic-core-workflow-runtime (Java)
+
+The workflow definitions and event types are generated from the same JSON Schema sources to ensure cross-language compatibility.

perceptic_workflow_sdk-0.50.94/README.md

@@ -0,0 +1,80 @@
+# Perceptic Workflow SDK
+
+Python SDK for Perceptic Workflow definitions. This package provides cross-language Temporal workflow types that are compatible with the Java workflow definitions in perceptic-core-client.
+
+## Installation
+
+```bash
+pip install perceptic-workflow-sdk
+```
+
+## Usage
+
+### Workflow Events
+
+```python
+from perceptic_workflow import (
+    WorkflowEvent,
+    InfoEvent,
+    CheckpointEvent,
+    UserInputEvent,
+    UserInputRequestEvent,
+    WorkflowCheckpointStatus,
+)
+
+# Create events
+info_event = InfoEvent(
+    event_id=1,
+    type="progress",
+    payload={"step": "processing"},
+    timestamp=datetime.now()
+)
+```
+
+### Implementing Workflows
+
+The SDK provides a mixin class for implementing Perceptic-compatible workflows:
+
+```python
+from temporalio import workflow
+from perceptic_workflow import PercepticWorkflowMixin, WorkflowEvent
+
+@workflow.defn
+class MyWorkflow(PercepticWorkflowMixin):
+    def __init__(self):
+        self._events: list[WorkflowEvent] = []
+        self._paused = False
+
+    @workflow.run
+    async def run(self, input: dict) -> dict:
+        # Your workflow logic here
+        pass
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_SUBMIT_USER_INPUT)
+    async def submit_user_input(self, inputs: dict) -> None:
+        self._paused = False
+        # Handle user input
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_INTERRUPT)
+    async def interrupt(self, reason: str) -> None:
+        # Handle interruption
+        pass
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_IS_PAUSED)
+    def is_paused(self) -> bool:
+        return self._paused
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_GET_EVENTS)
+    def get_events(self, after_event_id: int | None = None) -> list[WorkflowEvent]:
+        if after_event_id is None:
+            return self._events
+        return [e for e in self._events if e.event_id > after_event_id]
+```
+
+## Compatibility
+
+This package is designed to be compatible with:
+- perceptic-core-client (Java)
+- perceptic-core-workflow-runtime (Java)
+
+The workflow definitions and event types are generated from the same JSON Schema sources to ensure cross-language compatibility.

perceptic_workflow_sdk-0.50.94/VERSION

@@ -0,0 +1 @@
+0.50.94

perceptic_workflow_sdk-0.50.94/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires      = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name             = "perceptic-workflow-sdk"
+dynamic          = ["version"]
+description      = "Python SDK for Perceptic Workflow definitions - cross-language Temporal workflow types"
+authors          = [{name = "Perceptic Technologies Ltd."}]
+readme           = "README.md"
+requires-python  = ">=3.10"
+license          = {text = "Proprietary"}
+classifiers      = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+
+# Runtime dependencies - minimal, only what's needed for the types
+dependencies = [
+    "temporalio >= 1.7.0",
+]
+
+[project.optional-dependencies]
+# Development dependencies (install with 'pip install -e .[dev]')
+dev = [
+    "pytest",
+    "pytest-cov",
+    "ruff",
+    "mypy",
+    "build",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { file = "VERSION" }
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true

perceptic_workflow_sdk-0.50.94/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/__init__.py

@@ -0,0 +1,27 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+"""Perceptic Workflow SDK - Cross-language workflow definitions."""
+
+from perceptic_workflow.definitions import (
+    AgentInput,
+    AgentOutput,
+    CheckpointEvent,
+    InfoEvent,
+    UserInputEvent,
+    UserInputRequestEvent,
+    WorkflowCheckpointStatus,
+    WorkflowEvent,
+)
+from perceptic_workflow.workflows import PercepticWorkflowMixin
+
+__all__ = [
+    "AgentInput",
+    "AgentOutput",
+    "WorkflowCheckpointStatus",
+    "WorkflowEvent",
+    "CheckpointEvent",
+    "InfoEvent",
+    "UserInputEvent",
+    "UserInputRequestEvent",
+    "PercepticWorkflowMixin",
+]

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/definitions/__init__.py

@@ -0,0 +1,25 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+"""Workflow definition types."""
+
+from perceptic_workflow.definitions.agent_input import AgentInput
+from perceptic_workflow.definitions.agent_output import AgentOutput
+from perceptic_workflow.definitions.workflow_checkpoint_status import WorkflowCheckpointStatus
+from perceptic_workflow.definitions.workflow_event import (
+    CheckpointEvent,
+    InfoEvent,
+    UserInputEvent,
+    UserInputRequestEvent,
+    WorkflowEvent,
+)
+
+__all__ = [
+    "AgentInput",
+    "AgentOutput",
+    "WorkflowCheckpointStatus",
+    "WorkflowEvent",
+    "CheckpointEvent",
+    "InfoEvent",
+    "UserInputEvent",
+    "UserInputRequestEvent",
+]

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/definitions/agent_input.py

@@ -0,0 +1,20 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass(frozen=True)
+class AgentInput:
+    """Input to an agent within a workflow conversation."""
+
+    run_rid: str
+    """Resource identifier for the workflow run."""
+
+    user_id: str
+    """Identifier of the user providing input."""
+
+    payload: dict[str, Any] | None = None
+    """Optional JSON payload containing the input data."""

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/definitions/agent_output.py

@@ -0,0 +1,14 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass(frozen=True)
+class AgentOutput:
+    """Output from an agent within a workflow conversation."""
+
+    payload: dict[str, Any]
+    """JSON payload containing the output data."""

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/definitions/workflow_checkpoint_status.py

@@ -0,0 +1,13 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class WorkflowCheckpointStatus(str, Enum):
+    """Status of a workflow checkpoint."""
+
+    ACCEPTED = "ACCEPTED"
+    COMPLETED = "COMPLETED"
+    REJECTED = "REJECTED"

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/definitions/workflow_event.py

@@ -0,0 +1,53 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Union
+
+from perceptic_workflow.definitions.workflow_checkpoint_status import WorkflowCheckpointStatus
+
+
+@dataclass(frozen=True)
+class InfoEvent:
+    """Generic information event with a type and payload."""
+
+    event_id: int
+    type: str
+    payload: dict[str, Any]
+    timestamp: datetime
+
+
+@dataclass(frozen=True)
+class UserInputEvent:
+    """Event representing user input submitted to the workflow."""
+
+    event_id: int
+    input: dict[str, Any]
+    timestamp: datetime
+
+
+@dataclass(frozen=True)
+class UserInputRequestEvent:
+    """Event requesting user input from the client."""
+
+    event_id: int
+    requested_data: dict[str, Any]
+    timestamp: datetime
+
+
+@dataclass(frozen=True)
+class CheckpointEvent:
+    """Event representing a workflow checkpoint status update."""
+
+    event_id: int
+    checkpoint_name: str
+    update_id: str
+    status: WorkflowCheckpointStatus
+    payload: dict[str, Any]
+    timestamp: datetime
+
+
+# Union type representing all WorkflowEvent variants
+WorkflowEvent = Union[InfoEvent, UserInputEvent, UserInputRequestEvent, CheckpointEvent]

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/workflows/__init__.py

@@ -0,0 +1,9 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+"""Workflow interfaces and mixins."""
+
+from perceptic_workflow.workflows.perceptic_workflow_mixin import PercepticWorkflowMixin
+
+__all__ = [
+    "PercepticWorkflowMixin",
+]

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow/workflows/perceptic_workflow_mixin.py

@@ -0,0 +1,109 @@
+# (c) Copyright 2025 Perceptic Technologies Ltd. All rights reserved.
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from perceptic_workflow.definitions import WorkflowEvent
+
+
+class PercepticWorkflowMixin(ABC):
+    """
+    Defines the standard Perceptic Workflow control updates that all workflows must support
+    to handle user interaction and interruption.
+
+    These update names are reserved and invoked directly by the Perceptic Core V3 API.
+    Workflows should implement this mixin in their main workflow to ensure they handle
+    these signals correctly.
+
+    This is a mixin class that provides the method signatures and constants for
+    the Perceptic workflow interface. Since Temporal's @workflow.defn decorator
+    must be applied to concrete classes, implement this mixin in your workflow class
+    and apply the appropriate decorators.
+
+    Example:
+        @workflow.defn
+        class MyWorkflow(PercepticWorkflowMixin):
+            @workflow.update(name=PercepticWorkflowMixin.UPDATE_SUBMIT_USER_INPUT)
+            async def submit_user_input(self, inputs: dict[str, Any]) -> None:
+                # Handle user input
+                pass
+
+            @workflow.update(name=PercepticWorkflowMixin.UPDATE_INTERRUPT)
+            async def interrupt(self, reason: str) -> None:
+                # Handle interruption
+                pass
+
+            @workflow.query(name=PercepticWorkflowMixin.QUERY_IS_PAUSED)
+            def is_paused(self) -> bool:
+                return self._paused
+
+            @workflow.query(name=PercepticWorkflowMixin.QUERY_GET_EVENTS)
+            def get_events(self, after_event_id: int | None = None) -> list[WorkflowEvent]:
+                return self._events
+    """
+
+    # The reserved update name for submitting user input to a paused workflow.
+    UPDATE_SUBMIT_USER_INPUT: str = "submitUserInput"
+
+    # The reserved update name for interrupting a running workflow.
+    UPDATE_INTERRUPT: str = "interrupt"
+
+    # The reserved query name for checking if a workflow is paused (waiting for user input).
+    QUERY_IS_PAUSED: str = "isPaused"
+
+    # The reserved query name for retrieving workflow events.
+    QUERY_GET_EVENTS: str = "getEvents"
+
+    @abstractmethod
+    async def submit_user_input(
+        self,
+        inputs: dict[str, Any],
+    ) -> None:
+        """
+        Handles user input submission.
+
+        Args:
+            inputs: The input data provided by the user (matching the schema requested by the workflow).
+        """
+        ...
+
+    @abstractmethod
+    async def interrupt(
+        self,
+        reason: str,
+    ) -> None:
+        """
+        Handles an interrupt signal.
+
+        Args:
+            reason: The reason for the interruption.
+        """
+        ...
+
+    @abstractmethod
+    def is_paused(self) -> bool:
+        """
+        Checks if the workflow is currently paused (waiting for user input).
+
+        Returns:
+            True if the workflow is paused, False otherwise.
+        """
+        ...
+
+    @abstractmethod
+    def get_events(
+        self,
+        after_event_id: int | None = None,
+    ) -> list[WorkflowEvent]:
+        """
+        Retrieves workflow events, optionally filtered to events after a given event ID.
+
+        Args:
+            after_event_id: If provided, only return events with eventId greater than this value.
+
+        Returns:
+            List of workflow events.
+        """
+        ...

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow_sdk.egg-info/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: perceptic-workflow-sdk
+Version: 0.50.94
+Summary: Python SDK for Perceptic Workflow definitions - cross-language Temporal workflow types
+Author: Perceptic Technologies Ltd.
+License: Proprietary
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: temporalio>=1.7.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+
+# Perceptic Workflow SDK
+
+Python SDK for Perceptic Workflow definitions. This package provides cross-language Temporal workflow types that are compatible with the Java workflow definitions in perceptic-core-client.
+
+## Installation
+
+```bash
+pip install perceptic-workflow-sdk
+```
+
+## Usage
+
+### Workflow Events
+
+```python
+from perceptic_workflow import (
+    WorkflowEvent,
+    InfoEvent,
+    CheckpointEvent,
+    UserInputEvent,
+    UserInputRequestEvent,
+    WorkflowCheckpointStatus,
+)
+
+# Create events
+info_event = InfoEvent(
+    event_id=1,
+    type="progress",
+    payload={"step": "processing"},
+    timestamp=datetime.now()
+)
+```
+
+### Implementing Workflows
+
+The SDK provides a mixin class for implementing Perceptic-compatible workflows:
+
+```python
+from temporalio import workflow
+from perceptic_workflow import PercepticWorkflowMixin, WorkflowEvent
+
+@workflow.defn
+class MyWorkflow(PercepticWorkflowMixin):
+    def __init__(self):
+        self._events: list[WorkflowEvent] = []
+        self._paused = False
+
+    @workflow.run
+    async def run(self, input: dict) -> dict:
+        # Your workflow logic here
+        pass
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_SUBMIT_USER_INPUT)
+    async def submit_user_input(self, inputs: dict) -> None:
+        self._paused = False
+        # Handle user input
+
+    @workflow.update(name=PercepticWorkflowMixin.UPDATE_INTERRUPT)
+    async def interrupt(self, reason: str) -> None:
+        # Handle interruption
+        pass
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_IS_PAUSED)
+    def is_paused(self) -> bool:
+        return self._paused
+
+    @workflow.query(name=PercepticWorkflowMixin.QUERY_GET_EVENTS)
+    def get_events(self, after_event_id: int | None = None) -> list[WorkflowEvent]:
+        if after_event_id is None:
+            return self._events
+        return [e for e in self._events if e.event_id > after_event_id]
+```
+
+## Compatibility
+
+This package is designed to be compatible with:
+- perceptic-core-client (Java)
+- perceptic-core-workflow-runtime (Java)
+
+The workflow definitions and event types are generated from the same JSON Schema sources to ensure cross-language compatibility.

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+README.md
+VERSION
+pyproject.toml
+src/perceptic_workflow/__init__.py
+src/perceptic_workflow/py.typed
+src/perceptic_workflow/definitions/__init__.py
+src/perceptic_workflow/definitions/agent_input.py
+src/perceptic_workflow/definitions/agent_output.py
+src/perceptic_workflow/definitions/workflow_checkpoint_status.py
+src/perceptic_workflow/definitions/workflow_event.py
+src/perceptic_workflow/workflows/__init__.py
+src/perceptic_workflow/workflows/perceptic_workflow_mixin.py
+src/perceptic_workflow_sdk.egg-info/PKG-INFO
+src/perceptic_workflow_sdk.egg-info/SOURCES.txt
+src/perceptic_workflow_sdk.egg-info/dependency_links.txt
+src/perceptic_workflow_sdk.egg-info/requires.txt
+src/perceptic_workflow_sdk.egg-info/top_level.txt

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow_sdk.egg-info/requires.txt

@@ -0,0 +1,8 @@
+temporalio>=1.7.0
+
+[dev]
+pytest
+pytest-cov
+ruff
+mypy
+build

perceptic_workflow_sdk-0.50.94/src/perceptic_workflow_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+perceptic_workflow