highway-dsl 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

highway_dsl/__init__.py

@@ -0,0 +1,25 @@
+from .workflow_dsl import (
+    Workflow,
+    WorkflowBuilder,
+    TaskOperator,
+    ConditionOperator,
+    ParallelOperator,
+    WaitOperator,
+    ForEachOperator,
+    RetryPolicy,
+    TimeoutPolicy,
+    OperatorType,
+)
+
+__all__ = [
+    "Workflow",
+    "WorkflowBuilder",
+    "TaskOperator",
+    "ConditionOperator",
+    "ParallelOperator",
+    "WaitOperator",
+    "ForEachOperator",
+    "RetryPolicy",
+    "TimeoutPolicy",
+    "OperatorType",
+]

highway_dsl/workflow_dsl.py

@@ -26,7 +26,9 @@ class RetryPolicy(BaseModel):
 
 class TimeoutPolicy(BaseModel):
     timeout: timedelta = Field(..., description="Timeout duration")
-    kill_on_timeout: bool = Field(True, description="Whether to kill the task on timeout")
+    kill_on_timeout: bool = Field(
+        True, description="Whether to kill the task on timeout"
+    )
 
 
 class BaseOperator(BaseModel, ABC):
@@ -59,7 +61,7 @@ class WaitOperator(BaseOperator):
     wait_for: Union[timedelta, datetime, str]
     operator_type: OperatorType = Field(OperatorType.WAIT, frozen=True)
 
-    @model_validator(mode='before')
+    @model_validator(mode="before")
     @classmethod
     def parse_wait_for(cls, data: Any) -> Any:
         if isinstance(data, dict) and "wait_for" in data:
@@ -96,17 +98,20 @@ class Workflow(BaseModel):
     name: str
     version: str = "1.0.0"
     description: str = ""
-    tasks: Dict[str, Union[
-        TaskOperator,
-        ConditionOperator,
-        WaitOperator,
-        ParallelOperator,
-        ForEachOperator,
-    ]] = Field(default_factory=dict)
+    tasks: Dict[
+        str,
+        Union[
+            TaskOperator,
+            ConditionOperator,
+            WaitOperator,
+            ParallelOperator,
+            ForEachOperator,
+        ],
+    ] = Field(default_factory=dict)
     variables: Dict[str, Any] = Field(default_factory=dict)
     start_task: Optional[str] = None
 
-    @model_validator(mode='before')
+    @model_validator(mode="before")
     @classmethod
     def validate_tasks(cls, data: Any) -> Any:
         if isinstance(data, dict) and "tasks" in data:
@@ -128,13 +133,16 @@ class Workflow(BaseModel):
             data["tasks"] = validated_tasks
         return data
 
-    def add_task(self, task: Union[
-        TaskOperator,
-        ConditionOperator,
-        WaitOperator,
-        ParallelOperator,
-        ForEachOperator,
-    ]) -> "Workflow":
+    def add_task(
+        self,
+        task: Union[
+            TaskOperator,
+            ConditionOperator,
+            WaitOperator,
+            ParallelOperator,
+            ForEachOperator,
+        ],
+    ) -> "Workflow":
         self.tasks[task.task_id] = task
         return self
 
@@ -147,7 +155,7 @@ class Workflow(BaseModel):
         return self
 
     def to_yaml(self) -> str:
-        data = self.model_dump(mode='json', by_alias=True, exclude_none=True)
+        data = self.model_dump(mode="json", by_alias=True, exclude_none=True)
         return yaml.dump(data, default_flow_style=False)
 
     def to_json(self) -> str:
@@ -183,7 +191,11 @@ class WorkflowBuilder:
         self, task_id: str, condition: str, if_true: str, if_false: str, **kwargs
     ) -> "WorkflowBuilder":
         task = ConditionOperator(
-            task_id=task_id, condition=condition, if_true=if_true, if_false=if_false, **kwargs
+            task_id=task_id,
+            condition=condition,
+            if_true=if_true,
+            if_false=if_false,
+            **kwargs,
         )
         if self._current_task:
             task.dependencies.append(self._current_task)
@@ -214,7 +226,9 @@ class WorkflowBuilder:
     def foreach(
         self, task_id: str, items: str, task_chain: List[str], **kwargs
     ) -> "WorkflowBuilder":
-        task = ForEachOperator(task_id=task_id, items=items, task_chain=task_chain, **kwargs)
+        task = ForEachOperator(
+            task_id=task_id, items=items, task_chain=task_chain, **kwargs
+        )
         if self._current_task:
             task.dependencies.append(self._current_task)
         self.workflow.add_task(task)

{highway_dsl-0.0.1.dist-info → highway_dsl-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: highway_dsl
-Version: 0.0.1
+Version: 0.0.2
 Summary: A domain specific language (DSL) for defining and managing data processing pipelines.
 Author-email: Farseed Ashouri <farseed.ashouri@gmail.com>
 License: MIT
@@ -39,6 +39,28 @@ Highway DSL is a Python-based Domain Specific Language (DSL) for defining and ma
 *   **Serialization/Deserialization:** Seamless conversion of workflow definitions between Python objects, YAML, and JSON formats.
 *   **Workflow Builder:** A fluent API for constructing workflows programmatically.
 
+### Feature Overview
+
+```mermaid
+graph TD
+    A[Workflow] --> B{TaskOperator};
+    A --> C{ConditionOperator};
+    A --> D{WaitOperator};
+    A --> E{ParallelOperator};
+    A --> F{ForEachOperator};
+
+    B --> G[Executes Python Function];
+    C --> H{If/Else Branching};
+    D --> I[Pauses Execution];
+    E --> J[Concurrent Branches];
+    F --> K[Iterates Over Items];
+
+    subgraph Policies
+        B --> L[RetryPolicy];
+        B --> M[TimeoutPolicy];
+    end
+```
+
 ## Installation
 
 To install Highway DSL, you can use pip:
@@ -59,7 +81,7 @@ pip install "highway-dsl[dev]"
 
 ```python
 from datetime import timedelta
-from workflow_dsl import WorkflowBuilder
+from highway_dsl import WorkflowBuilder
 
 def demonstrate_basic_workflow():
     """Show a simple complete workflow using just the builder"""
@@ -159,7 +181,7 @@ tasks:
 To load this YAML:
 
 ```python
-from workflow_dsl import Workflow
+from highway_dsl import Workflow
 
 yaml_content = """
 # ... (yaml content from above)
@@ -191,7 +213,9 @@ mypy .
 
 ```
 .highway/
-├── workflow_dsl.py         # Core DSL definitions (Pydantic models)
+├── highway_dsl/
+│   ├── __init__.py         # Exposes the public API
+│   └── workflow_dsl.py     # Core DSL definitions (Pydantic models)
 ├── example_usage.py        # Examples of how to use the DSL
 ├── tests/
 │   ├── __init__.py

highway_dsl-0.0.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+highway_dsl/__init__.py,sha256=8qmPd9ZZNgwPGZuWwPYvMOljg73BJIT2SSM7iIRycmw,447
+highway_dsl/workflow_dsl.py,sha256=2QWDhbXLPulq_kTZk_Yjs6L3BNwws_H6EDV0S1CjOXs,9205
+highway_dsl-0.0.2.dist-info/licenses/LICENSE,sha256=qdFq1H66BvKg67mf4-WGpFwtG2u_dNknxuJDQ1_ubaY,1072
+highway_dsl-0.0.2.dist-info/METADATA,sha256=uLLXSVlLWM8H6F5wR1huiAtgXfkIVdmLV-XsYwZkW6s,6390
+highway_dsl-0.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+highway_dsl-0.0.2.dist-info/top_level.txt,sha256=_5uX-bbBsQ2rsi1XMr7WRyKbr6ack5GqVBcy-QjF1C8,12
+highway_dsl-0.0.2.dist-info/RECORD,,

highway_dsl-0.0.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-highway_dsl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-highway_dsl/workflow_dsl.py,sha256=PDUCYFBt0SHSZxXv6HKZXlVOmjUcYWiX4i6Kwhsn4h8,9026
-highway_dsl-0.0.1.dist-info/licenses/LICENSE,sha256=qdFq1H66BvKg67mf4-WGpFwtG2u_dNknxuJDQ1_ubaY,1072
-highway_dsl-0.0.1.dist-info/METADATA,sha256=3DgCxoxYJki8WYd4gfDB9IWIq1iAK-liAmWQ7fWxFvU,5838
-highway_dsl-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-highway_dsl-0.0.1.dist-info/top_level.txt,sha256=_5uX-bbBsQ2rsi1XMr7WRyKbr6ack5GqVBcy-QjF1C8,12
-highway_dsl-0.0.1.dist-info/RECORD,,