ddeutil-workflow 0.0.35__tar.gz → 0.0.36__tar.gz

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ddeutil-workflow
-Version: 0.0.35
+Version: 0.0.36
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -29,6 +29,8 @@ Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"
+Requires-Dist: httpx; extra == "api"
+Requires-Dist: ujson; extra == "api"
 
 # Workflow Orchestration
 
@@ -78,12 +80,12 @@ flowchart LR
 
     subgraph Docker Container
         direction TB
-        G@{ shape: rounded, label: "Observe<br>Application" }
+        G@{ shape: rounded, label: "📡Observe<br>Application" }
     end
 
     subgraph Docker Container
         direction TB
-        B@{ shape: rounded, label: "Workflow<br>Application" }
+        B@{ shape: rounded, label: "🏃Workflow<br>Application" }
     end
 
     A <-->|action &<br>response| B
@@ -95,7 +97,7 @@ flowchart LR
         E@{ shape: lin-cyl, label: "Audit<br>Logs" }
     end
 
-    subgraph Git Context
+    subgraph Config Context
         F@{ shape: tag-rect, label: "YAML<br>files" }
     end
 
@@ -130,10 +132,10 @@ This project need `ddeutil` and `ddeutil-io` extension namespace packages.
 If you want to install this package with application add-ons, you should add
 `app` in installation;
 
-| Use-case       | Install Optional         | Support            |
-|----------------|--------------------------|--------------------|
-| Python         | `ddeutil-workflow`       | :heavy_check_mark: |
-| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark: |
+| Use-case       | Install Optional         |       Support       |
+|----------------|--------------------------|:-------------------:|
+| Python         | `ddeutil-workflow`       | :heavy_check_mark:  |
+| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark:  |
 
 ## :beers: Usage
 
@@ -295,7 +297,7 @@ like crontab job but via Python API.
 ### API Server
 
 ```shell
-(venv) $ uvicorn src.ddeutil.workflow.api:app \
+(venv) $ uvicorn ddeutil.workflow.api:app \
   --host 127.0.0.1 \
   --port 80 \
   --no-access-log

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/README.md

@@ -46,12 +46,12 @@ flowchart LR
 
     subgraph Docker Container
         direction TB
-        G@{ shape: rounded, label: "Observe<br>Application" }
+        G@{ shape: rounded, label: "📡Observe<br>Application" }
     end
 
     subgraph Docker Container
         direction TB
-        B@{ shape: rounded, label: "Workflow<br>Application" }
+        B@{ shape: rounded, label: "🏃Workflow<br>Application" }
     end
 
     A <-->|action &<br>response| B
@@ -63,7 +63,7 @@ flowchart LR
         E@{ shape: lin-cyl, label: "Audit<br>Logs" }
     end
 
-    subgraph Git Context
+    subgraph Config Context
         F@{ shape: tag-rect, label: "YAML<br>files" }
     end
 
@@ -98,10 +98,10 @@ This project need `ddeutil` and `ddeutil-io` extension namespace packages.
 If you want to install this package with application add-ons, you should add
 `app` in installation;
 
-| Use-case       | Install Optional         | Support            |
-|----------------|--------------------------|--------------------|
-| Python         | `ddeutil-workflow`       | :heavy_check_mark: |
-| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark: |
+| Use-case       | Install Optional         |       Support       |
+|----------------|--------------------------|:-------------------:|
+| Python         | `ddeutil-workflow`       | :heavy_check_mark:  |
+| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark:  |
 
 ## :beers: Usage
 
@@ -263,7 +263,7 @@ like crontab job but via Python API.
 ### API Server
 
 ```shell
-(venv) $ uvicorn src.ddeutil.workflow.api:app \
+(venv) $ uvicorn ddeutil.workflow.api:app \
   --host 127.0.0.1 \
   --port 80 \
   --no-access-log

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/pyproject.toml

@@ -35,7 +35,11 @@ dependencies = [
 dynamic = ["version"]
 
 [project.optional-dependencies]
-api = [ "fastapi>=0.115.0,<1.0.0" ]
+api = [
+    "fastapi>=0.115.0,<1.0.0",
+    "httpx",
+    "ujson",
+]
 
 [project.urls]
 Homepage = "https://github.com/ddeutils/ddeutil-workflow/"
@@ -66,7 +70,11 @@ omit = [
     "src/ddeutil/workflow/api/__init__.py",
     "src/ddeutil/workflow/api/api.py",
     "src/ddeutil/workflow/api/repeat.py",
-    "src/ddeutil/workflow/api/route.py",
+    "src/ddeutil/workflow/api/routes/__init__.py",
+    "src/ddeutil/workflow/api/routes/job.py",
+    "src/ddeutil/workflow/api/routes/logs.py",
+    "src/ddeutil/workflow/api/routes/schedules.py",
+    "src/ddeutil/workflow/api/routes/workflows.py",
     "app.py",
 ]
 
@@ -89,7 +97,10 @@ addopts = [
     "--strict-config",
     "--strict-markers",
 ]
-filterwarnings = ["error"]
+filterwarnings = [
+    "error",
+    "ignore::DeprecationWarning",
+]
 log_cli = true
 log_cli_level = "DEBUG"
 log_cli_format = "%(asctime)s [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)"

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

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

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/__init__.py

@@ -37,9 +37,11 @@ from .exceptions import (
 )
 from .job import (
     Job,
+    RunsOn,
     Strategy,
 )
 from .logs import (
+    TraceData,
     TraceLog,
     get_dt_tznow,
     get_trace,

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/api/api.py

@@ -11,7 +11,11 @@ from datetime import datetime, timedelta
 from typing import TypedDict
 
 from dotenv import load_dotenv
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
+from fastapi import status as st
+from fastapi.encoders import jsonable_encoder
+from fastapi.exceptions import RequestValidationError
+from fastapi.middleware.cors import CORSMiddleware
 from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.responses import UJSONResponse
 
@@ -20,7 +24,7 @@ from ..conf import config, get_logger
 from ..scheduler import ReleaseThread, ReleaseThreads
 from ..workflow import ReleaseQueue, WorkflowTask
 from .repeat import repeat_at
-from .routes import log
+from .routes import job, log
 
 load_dotenv()
 logger = get_logger("ddeutil.workflow")
@@ -61,24 +65,38 @@ async def lifespan(a: FastAPI) -> AsyncIterator[State]:
 
 
 app = FastAPI(
-    titile="Workflow API",
+    titile="Workflow",
     description=(
-        "This is workflow FastAPI web application that use to manage manual "
-        "execute or schedule workflow via RestAPI."
+        "This is a workflow FastAPI application that use to manage manual "
+        "execute, logging, and schedule workflow via RestAPI."
     ),
     version=__version__,
     lifespan=lifespan,
     default_response_class=UJSONResponse,
 )
 app.add_middleware(GZipMiddleware, minimum_size=1000)
+origins: list[str] = [
+    "http://localhost",
+    "http://localhost:88",
+    "http://localhost:80",
+]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
 
 
 @app.get("/")
 async def health():
-    return {"message": "Workflow API already start up"}
+    """Index view that not return any template without json status."""
+    return {"message": "Workflow already start up with healthy status."}
 
 
-# NOTE Add the logs route by default.
+# NOTE Add the jobs and logs routes by default.
+app.include_router(job, prefix=config.prefix_path)
 app.include_router(log, prefix=config.prefix_path)
 
 
@@ -111,12 +129,13 @@ if config.enable_route_schedule:
                 stop=datetime.now(config.tz) + timedelta(minutes=1),
                 queue=app.state.workflow_queue,
                 threads=app.state.workflow_threads,
-                log=get_audit(),
+                audit=get_audit(),
             )
 
     @schedule.on_event("startup")
     @repeat_at(cron="*/5 * * * *", delay=10)
     def monitoring():
+        """Monitoring workflow thread that running in the background."""
         logger.debug("[MONITOR]: Start monitoring threading.")
         snapshot_threads: list[str] = list(app.state.workflow_threads.keys())
         for t_name in snapshot_threads:
@@ -126,3 +145,23 @@ if config.enable_route_schedule:
             # NOTE: remove the thread that running success.
             if not thread_release["thread"].is_alive():
                 app.state.workflow_threads.pop(t_name)
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(
+    request: Request, exc: RequestValidationError
+):
+    return UJSONResponse(
+        status_code=st.HTTP_422_UNPROCESSABLE_ENTITY,
+        content=jsonable_encoder({"detail": exc.errors(), "body": exc.body}),
+    )
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(
+        app,
+        host="0.0.0.0",
+        port=80,
+    )

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/api/repeat.py

@@ -21,17 +21,26 @@ logger = get_logger("ddeutil.workflow")
 def get_cronjob_delta(cron: str) -> float:
     """This function returns the time delta between now and the next cron
     execution time.
+
+    :rtype: float
     """
     now: datetime = datetime.now(tz=config.tz)
     cron = CronJob(cron)
     return (cron.schedule(now).next - now).total_seconds()
 
 
-def cron_valid(cron: str):
+def cron_valid(cron: str, raise_error: bool = True) -> bool:
+    """Check this crontab string value is valid with its cron syntax.
+
+    :rtype: bool
+    """
     try:
         CronJob(cron)
+        return True
     except Exception as err:
-        raise ValueError(f"Crontab value does not valid, {cron}") from err
+        if raise_error:
+            raise ValueError(f"Crontab value does not valid, {cron}") from err
+        return False
 
 
 async def run_func(
@@ -41,6 +50,7 @@ async def run_func(
     raise_exceptions: bool = False,
     **kwargs,
 ):
+    """Run function inside the repeat decorator functions."""
     try:
         if is_coroutine:
             await func(*args, **kwargs)
@@ -62,11 +72,11 @@ def repeat_at(
     """This function returns a decorator that makes a function execute
     periodically as per the cron expression provided.
 
-    :param cron: str
-        Cron-style string for periodic execution, eg. '0 0 * * *' every midnight
-    :param delay:
-    :param raise_exceptions: bool (default False)
-        Whether to raise exceptions or log them
+    :param cron: (str) A Cron-style string for periodic execution, e.g.
+        '0 0 * * *' every midnight
+    :param delay: (float) A delay seconds value.
+    :param raise_exceptions: (bool) A raise exception flag. Whether to raise
+        exceptions or log them if raise was set be false.
     :param max_repetitions: int (default None)
         Maximum number of times to repeat the function. If None, repeat
         indefinitely.
@@ -81,12 +91,12 @@ def repeat_at(
 
         @wraps(func)
         def wrapper(*_args, **_kwargs):
-            repititions: int = 0
+            repetitions: int = 0
             cron_valid(cron)
 
             async def loop(*args, **kwargs):
-                nonlocal repititions
-                while max_repetitions is None or repititions < max_repetitions:
+                nonlocal repetitions
+                while max_repetitions is None or repetitions < max_repetitions:
                     sleep_time = get_cronjob_delta(cron) + delay
                     await asyncio.sleep(sleep_time)
                     await run_func(
@@ -96,7 +106,7 @@ def repeat_at(
                         raise_exceptions=raise_exceptions,
                         **kwargs,
                     )
-                    repititions += 1
+                    repetitions += 1
 
             ensure_future(loop(*_args, **_kwargs))
 

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/api/routes/__init__.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
+from .job import job_route as job
 from .logs import log_route as log
 from .schedules import schedule_route as schedule
 from .workflows import workflow_route as workflow

ddeutil_workflow-0.0.36/src/ddeutil/workflow/api/routes/job.py

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from fastapi import APIRouter
+from fastapi.responses import UJSONResponse
+from pydantic import BaseModel
+
+from ...__types import DictData
+from ...conf import get_logger
+from ...exceptions import JobException
+from ...job import Job
+from ...result import Result
+
+logger = get_logger("ddeutil.workflow")
+
+
+job_route = APIRouter(
+    prefix="/job",
+    tags=["job"],
+    default_response_class=UJSONResponse,
+)
+
+
+class ResultPost(BaseModel):
+    context: DictData
+    run_id: str
+    parent_run_id: Optional[str] = None
+
+
+@job_route.post(path="/execute/")
+async def job_execute(
+    result: ResultPost,
+    job: Job,
+    params: dict[str, Any],
+):
+    """Execute job via API."""
+    rs: Result = Result(
+        context=result.context,
+        run_id=result.run_id,
+        parent_run_id=result.parent_run_id,
+    )
+    try:
+        job.set_outputs(
+            job.execute(
+                params=params,
+                run_id=rs.run_id,
+                parent_run_id=rs.parent_run_id,
+            ).context,
+            to=params,
+        )
+    except JobException as err:
+        rs.trace.error(f"[WORKFLOW]: {err.__class__.__name__}: {err}")
+
+    return {
+        "message": "Start execute job via API.",
+        "result": {
+            "run_id": rs.run_id,
+            "parent_run_id": rs.parent_run_id,
+        },
+        "job": job.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+            exclude_defaults=True,
+        ),
+        "params": params,
+    }

ddeutil_workflow-0.0.36/src/ddeutil/workflow/api/routes/logs.py

@@ -0,0 +1,64 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+"""This route include audit and trace log paths."""
+from __future__ import annotations
+
+from fastapi import APIRouter
+from fastapi.responses import UJSONResponse
+
+from ...audit import get_audit
+from ...logs import get_trace_obj
+
+log_route = APIRouter(
+    prefix="/logs",
+    tags=["logs", "trace", "audit"],
+    default_response_class=UJSONResponse,
+)
+
+
+@log_route.get(path="/trace/")
+async def get_traces():
+    """Get all trace logs."""
+    return {
+        "message": "Getting trace logs",
+        "traces": list(get_trace_obj().find_logs()),
+    }
+
+
+@log_route.get(path="/trace/{run_id}")
+async def get_trace_with_id(run_id: str):
+    """Get trace log with specific running ID."""
+    return get_trace_obj().find_log_with_id(run_id)
+
+
+@log_route.get(path="/audit/")
+async def get_audits():
+    """Get all audit logs."""
+    return {
+        "message": "Getting audit logs",
+        "audits": list(get_audit().find_audits(name="demo")),
+    }
+
+
+@log_route.get(path="/audit/{workflow}/")
+async def get_audit_with_workflow(workflow: str):
+    """Get all audit logs."""
+    return {
+        "message": f"Getting audit logs with workflow name {workflow}",
+        "audits": list(get_audit().find_audits(name="demo")),
+    }
+
+
+@log_route.get(path="/audit/{workflow}/{release}")
+async def get_audit_with_workflow_release(workflow: str, release: str):
+    """Get all audit logs."""
+    return {
+        "message": (
+            f"Getting audit logs with workflow name {workflow} and release "
+            f"{release}"
+        ),
+        "audits": list(get_audit().find_audits(name="demo")),
+    }

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/api/routes/schedules.py

@@ -26,6 +26,7 @@ schedule_route = APIRouter(
 
 @schedule_route.get(path="/{name}")
 async def get_schedules(name: str):
+    """Get schedule object."""
     try:
         schedule: Schedule = Schedule.from_loader(name=name, externals={})
     except ValueError:

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/audit.py

@@ -112,7 +112,8 @@ class FileAudit(BaseAudit):
         :param release: A release datetime that want to search log.
 
         :raise FileNotFoundError:
-        :raise NotImplementedError:
+        :raise NotImplementedError: If an input release does not pass to this
+            method. Because this method does not implement latest log.
 
         :rtype: Self
         """
@@ -181,7 +182,9 @@ class FileAudit(BaseAudit):
             trace.debug("[LOG]: Skip writing log cause config was set")
             return self
 
-        log_file: Path = self.pointer() / f"{self.run_id}.log"
+        log_file: Path = (
+            self.pointer() / f"{self.parent_run_id or self.run_id}.log"
+        )
         log_file.write_text(
             json.dumps(
                 self.model_dump(exclude=excluded),
@@ -196,7 +199,7 @@ class FileAudit(BaseAudit):
 class SQLiteAudit(BaseAudit):  # pragma: no cov
     """SQLite Audit Pydantic Model."""
 
-    table_name: ClassVar[str] = "workflow_log"
+    table_name: ClassVar[str] = "audits"
     schemas: ClassVar[
         str
     ] = """

{ddeutil_workflow-0.0.35 → ddeutil_workflow-0.0.36}/src/ddeutil/workflow/job.py

@@ -32,7 +32,7 @@ from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
 from .__types import DictData, DictStr, Matrix, TupleStr
-from .conf import config, get_logger
+from .conf import config
 from .exceptions import (
     JobException,
     StageException,
@@ -48,7 +48,6 @@ from .utils import (
     gen_id,
 )
 
-logger = get_logger("ddeutil.workflow")
 MatrixFilter = list[dict[str, Union[str, int]]]
 
 
@@ -59,7 +58,6 @@ __all__: TupleStr = (
     "RunsOn",
     "RunsOnLocal",
     "RunsOnSelfHosted",
-    "RunsOnDocker",
     "RunsOnK8s",
     "make",
 )
@@ -225,12 +223,11 @@ class RunsOnType(str, Enum):
     """Runs-On enum object."""
 
     LOCAL: str = "local"
-    DOCKER: str = "docker"
     SELF_HOSTED: str = "self_hosted"
     K8S: str = "k8s"
 
 
-class BaseRunsOn(BaseModel):
+class BaseRunsOn(BaseModel):  # pragma: no cov
     model_config = ConfigDict(use_enum_values=True)
 
     type: Literal[RunsOnType.LOCAL]
@@ -240,13 +237,13 @@ class BaseRunsOn(BaseModel):
     )
 
 
-class RunsOnLocal(BaseRunsOn):
+class RunsOnLocal(BaseRunsOn):  # pragma: no cov
     """Runs-on local."""
 
     type: Literal[RunsOnType.LOCAL] = Field(default=RunsOnType.LOCAL)
 
 
-class RunsOnSelfHosted(BaseRunsOn):
+class RunsOnSelfHosted(BaseRunsOn):  # pragma: no cov
     """Runs-on self-hosted."""
 
     type: Literal[RunsOnType.SELF_HOSTED] = Field(
@@ -254,13 +251,7 @@ class RunsOnSelfHosted(BaseRunsOn):
     )
 
 
-class RunsOnDocker(BaseRunsOn):
-    """Runs-on local Docker."""
-
-    type: Literal[RunsOnType.DOCKER] = Field(default=RunsOnType.DOCKER)
-
-
-class RunsOnK8s(BaseRunsOn):
+class RunsOnK8s(BaseRunsOn):  # pragma: no cov
     """Runs-on Kubernetes."""
 
     type: Literal[RunsOnType.K8S] = Field(default=RunsOnType.K8S)
@@ -270,7 +261,6 @@ RunsOn = Annotated[
     Union[
         RunsOnLocal,
         RunsOnSelfHosted,
-        RunsOnDocker,
         RunsOnK8s,
     ],
     Field(discriminator="type"),
@@ -286,7 +276,7 @@ class Job(BaseModel):
 
     Data Validate:
         >>> job = {
-        ...     "runs-on": None,
+        ...     "runs-on": {"type": "local"},
         ...     "strategy": {
         ...         "max-parallel": 1,
         ...         "matrix": {