ddeutil-workflow 0.0.53__tar.gz → 0.0.55__tar.gz

{ddeutil_workflow-0.0.53/src/ddeutil_workflow.egg-info → ddeutil_workflow-0.0.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.53
+Version: 0.0.55
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -62,12 +62,6 @@ by a `.yaml` template.
 > use the workflow stage to process any large volume data which use a lot of compute
 > resource :cold_sweat:.
 
-In my opinion, I think it should not create duplicate workflow codes if I can
-write with dynamic input parameters on the one template workflow that just change
-the input parameters per use-case instead.
-This way I can handle a lot of logical workflows in our orgs with only metadata
-configuration. It called **Metadata Driven Data Workflow**.
-
 ---
 
 **:pushpin: <u>Rules of This Workflow engine</u>**:
@@ -127,12 +121,10 @@ flowchart LR
 
 > [!WARNING]
 > _**Disclaimer**_: I inspire the dynamic YAML statement from the [**GitHub Action**](https://github.com/features/actions),
-> and all configs pattern from several data orchestration framework tools from
-> my data engineering experience. :grimacing:
-
-> [!NOTE]
-> Other workflow orchestration tools that I interest and pick them to be inspiration
-> some for this package:
+> and my experience of data framework configs pattern. :grimacing:
+>
+> Other workflow orchestration services that I interest and pick them to be
+> this project inspiration:
 >
 > - [Google **Workflows**](https://cloud.google.com/workflows)
 > - [AWS **Step Functions**](https://aws.amazon.com/step-functions/)

{ddeutil_workflow-0.0.53 → ddeutil_workflow-0.0.55}/README.md

@@ -17,12 +17,6 @@ by a `.yaml` template.
 > use the workflow stage to process any large volume data which use a lot of compute
 > resource :cold_sweat:.
 
-In my opinion, I think it should not create duplicate workflow codes if I can
-write with dynamic input parameters on the one template workflow that just change
-the input parameters per use-case instead.
-This way I can handle a lot of logical workflows in our orgs with only metadata
-configuration. It called **Metadata Driven Data Workflow**.
-
 ---
 
 **:pushpin: <u>Rules of This Workflow engine</u>**:
@@ -82,12 +76,10 @@ flowchart LR
 
 > [!WARNING]
 > _**Disclaimer**_: I inspire the dynamic YAML statement from the [**GitHub Action**](https://github.com/features/actions),
-> and all configs pattern from several data orchestration framework tools from
-> my data engineering experience. :grimacing:
-
-> [!NOTE]
-> Other workflow orchestration tools that I interest and pick them to be inspiration
-> some for this package:
+> and my experience of data framework configs pattern. :grimacing:
+>
+> Other workflow orchestration services that I interest and pick them to be
+> this project inspiration:
 >
 > - [Google **Workflows**](https://cloud.google.com/workflows)
 > - [AWS **Step Functions**](https://aws.amazon.com/step-functions/)

{ddeutil_workflow-0.0.53 → ddeutil_workflow-0.0.55}/pyproject.toml

@@ -79,9 +79,7 @@ source = ["src.ddeutil.workflow"]
 omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
-    "src/ddeutil/workflow/context.py",
     "src/ddeutil/workflow/api/__init__.py",
-    "src/ddeutil/workflow/api/api.py",
     "src/ddeutil/workflow/api/log.py",
     "src/ddeutil/workflow/api/repeat.py",
     "src/ddeutil/workflow/api/routes/__init__.py",

ddeutil_workflow-0.0.55/src/ddeutil/workflow/__about__.py

@@ -0,0 +1 @@
+__version__: str = "0.0.55"

ddeutil_workflow-0.0.53/src/ddeutil/workflow/api/api.py → ddeutil_workflow-0.0.55/src/ddeutil/workflow/api/__init__.py

@@ -24,8 +24,8 @@ from ..conf import api_config, config
 from ..logs import get_logger
 from ..scheduler import ReleaseThread, ReleaseThreads
 from ..workflow import ReleaseQueue, WorkflowTask
-from .repeat import repeat_at
 from .routes import job, log
+from .utils import repeat_at
 
 load_dotenv()
 logger = get_logger("uvicorn.error")
@@ -90,7 +90,7 @@ app.add_middleware(
 )
 
 
-@app.get("/")
+@app.get(path="/", response_class=UJSONResponse)
 async def health():
     """Index view that not return any template without json status."""
     return {"message": "Workflow already start up with healthy status."}

{ddeutil_workflow-0.0.53 → ddeutil_workflow-0.0.55}/src/ddeutil/workflow/api/routes/job.py

@@ -9,7 +9,7 @@ from typing import Any, Optional
 
 from fastapi import APIRouter
 from fastapi.responses import UJSONResponse
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 from ...__types import DictData
 from ...exceptions import JobException
@@ -18,33 +18,37 @@ from ...logs import get_logger
 from ...result import Result
 
 logger = get_logger("uvicorn.error")
+job_route = APIRouter(prefix="/job", tags=["job"])
 
 
-job_route = APIRouter(
-    prefix="/job",
-    tags=["job"],
-    default_response_class=UJSONResponse,
-)
+class ResultCreate(BaseModel):
+    """Create Result model for receive running IDs to create the Result
+    dataclass.
+    """
 
-
-class ResultPost(BaseModel):
-    context: DictData
-    run_id: str
-    parent_run_id: Optional[str] = None
+    run_id: str = Field(description="A running ID.")
+    parent_run_id: Optional[str] = Field(
+        default=None, description="A parent running ID."
+    )
 
 
-@job_route.post(path="/execute/")
+@job_route.post(path="/execute/", response_class=UJSONResponse)
 async def job_execute(
-    result: ResultPost,
+    result: ResultCreate,
     job: Job,
     params: dict[str, Any],
+    extras: Optional[dict[str, Any]] = None,
 ):
-    """Execute job via API."""
+    """Execute job via RestAPI with execute route path."""
     rs: Result = Result(
-        context=result.context,
         run_id=result.run_id,
         parent_run_id=result.parent_run_id,
+        extras=extras or {},
     )
+
+    if extras:
+        job.extras = extras
+
     context: DictData = {}
     try:
         job.set_outputs(
@@ -56,17 +60,14 @@ async def job_execute(
             to=context,
         )
     except JobException as err:
-        rs.trace.error(f"[WORKFLOW]: {err.__class__.__name__}: {err}")
+        rs.trace.error(f"[JOB]: {err.__class__.__name__}: {err}")
 
     return {
-        "message": "Start execute job via API.",
-        "result": {
-            "run_id": rs.run_id,
-            "parent_run_id": rs.parent_run_id,
-        },
+        "message": "Execute job via RestAPI.",
+        "result": {"run_id": rs.run_id, "parent_run_id": rs.parent_run_id},
         "job": job.model_dump(
             by_alias=True,
-            exclude_none=True,
+            exclude_none=False,
             exclude_unset=True,
             exclude_defaults=True,
         ),

{ddeutil_workflow-0.0.53 → ddeutil_workflow-0.0.55}/src/ddeutil/workflow/api/routes/schedules.py

@@ -17,7 +17,6 @@ from ...logs import get_logger
 from ...scheduler import Schedule
 
 logger = get_logger("uvicorn.error")
-
 schedule_route = APIRouter(
     prefix="/schedules",
     tags=["schedules"],
@@ -108,7 +107,6 @@ async def add_deploy_scheduler(request: Request, name: str):
         schedule.tasks(
             start_date_waiting,
             queue=request.state.workflow_queue,
-            extras={},
         ),
     )
     return {

{ddeutil_workflow-0.0.53 → ddeutil_workflow-0.0.55}/src/ddeutil/workflow/api/routes/workflows.py

@@ -21,7 +21,6 @@ from ...result import Result
 from ...workflow import Workflow
 
 logger = get_logger("uvicorn.error")
-
 workflow_route = APIRouter(
     prefix="/workflows",
     tags=["workflows"],
@@ -55,7 +54,7 @@ async def get_workflow_by_name(name: str) -> DictData:
         ) from None
     return workflow.model_dump(
         by_alias=True,
-        exclude_none=True,
+        exclude_none=False,
         exclude_unset=True,
         exclude_defaults=True,
     )
@@ -98,7 +97,7 @@ async def get_workflow_audits(name: str):
             "audits": [
                 audit.model_dump(
                     by_alias=True,
-                    exclude_none=True,
+                    exclude_none=False,
                     exclude_unset=True,
                     exclude_defaults=True,
                 )
@@ -132,7 +131,7 @@ async def get_workflow_release_audit(name: str, release: str):
         "message": f"Getting workflow {name!r} audit in release {release}",
         "audit": audit.model_dump(
             by_alias=True,
-            exclude_none=True,
+            exclude_none=False,
             exclude_unset=True,
             exclude_defaults=True,
         ),