ddeutil-workflow 0.0.65__tar.gz → 0.0.67__tar.gz

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.65
-Summary: Lightweight workflow orchestration
+Version: 0.0.67
+Summary: Lightweight workflow orchestration with YAML template
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
 Project-URL: Homepage, https://github.com/ddeutils/ddeutil-workflow/
@@ -27,7 +27,7 @@ Requires-Dist: ddeutil-io[toml,yaml]>=0.2.14
 Requires-Dist: pydantic==2.11.4
 Requires-Dist: pydantic-extra-types==2.10.4
 Requires-Dist: python-dotenv==1.1.0
-Requires-Dist: schedule<2.0.0,==1.2.2
+Requires-Dist: typer==0.15.4
 Provides-Extra: all
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "all"
 Requires-Dist: uvicorn; extra == "all"
@@ -35,18 +35,9 @@ Requires-Dist: httpx; extra == "all"
 Requires-Dist: ujson; extra == "all"
 Requires-Dist: aiofiles; extra == "all"
 Requires-Dist: aiohttp; extra == "all"
-Provides-Extra: api
-Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"
-Requires-Dist: uvicorn; extra == "api"
-Requires-Dist: httpx; extra == "api"
-Requires-Dist: ujson; extra == "api"
-Provides-Extra: async
-Requires-Dist: aiofiles; extra == "async"
-Requires-Dist: aiohttp; extra == "async"
+Requires-Dist: requests==2.32.3; extra == "all"
 Provides-Extra: docker
 Requires-Dist: docker==7.1.0; extra == "docker"
-Provides-Extra: self-hosted
-Requires-Dist: requests==2.32.3; extra == "self-hosted"
 Dynamic: license-file
 
 # Workflow Orchestration
@@ -142,10 +133,10 @@ the base deps.
 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`      |    ✅    |
+| FastAPI Server | `ddeutil-workflow[all]` |    ✅    |
 
 ## 🎯 Usage
 
@@ -300,40 +291,27 @@ it will use default value and do not raise any error to you.
 ## :rocket: Deployment
 
 This package able to run as an application service for receive manual trigger
-from any node via RestAPI or use to be Scheduler background application
-like crontab job but via Python API or FastAPI app.
+from any node via RestAPI with the FastAPI package.
 
 ### API Server
 
 This server use FastAPI package to be the base application.
 
 ```shell
-(.venv) $ uvicorn ddeutil.workflow.api:app \
-  --host 127.0.0.1 \
-  --port 80 \
-  --no-access-log
+(.venv) $ workflow-cli api --host 127.0.0.1 --port 80
 ```
 
 > [!NOTE]
 > If this package already deploy, it is able to use multiprocess;
-> `uvicorn ddeutil.workflow.api:app --host 127.0.0.1 --port 80 --workers 4`
-
-### Local Schedule
-
-> [!WARNING]
-> This CLI does not implement yet.
-
-```shell
-(.venv) $ ddeutil-workflow schedule
-```
+> `$ workflow-cli api --host 127.0.0.1 --port 80 --workers 4`
 
 ### Docker Container
 
 Build a Docker container from this package.
 
 ```shell
-$ docker build -t ddeutil-workflow:latest -f .container/Dockerfile .
-$ docker run -i ddeutil-workflow:latest ddeutil-workflow
+$ docker pull ghcr.io/ddeutils/ddeutil-workflow:latest
+$ docker run --rm ghcr.io/ddeutils/ddeutil-workflow:latest ddeutil-worker
 ```
 
 ## :speech_balloon: Contribute

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/README.md

@@ -91,10 +91,10 @@ the base deps.
 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`      |    ✅    |
+| FastAPI Server | `ddeutil-workflow[all]` |    ✅    |
 
 ## 🎯 Usage
 
@@ -249,40 +249,27 @@ it will use default value and do not raise any error to you.
 ## :rocket: Deployment
 
 This package able to run as an application service for receive manual trigger
-from any node via RestAPI or use to be Scheduler background application
-like crontab job but via Python API or FastAPI app.
+from any node via RestAPI with the FastAPI package.
 
 ### API Server
 
 This server use FastAPI package to be the base application.
 
 ```shell
-(.venv) $ uvicorn ddeutil.workflow.api:app \
-  --host 127.0.0.1 \
-  --port 80 \
-  --no-access-log
+(.venv) $ workflow-cli api --host 127.0.0.1 --port 80
 ```
 
 > [!NOTE]
 > If this package already deploy, it is able to use multiprocess;
-> `uvicorn ddeutil.workflow.api:app --host 127.0.0.1 --port 80 --workers 4`
-
-### Local Schedule
-
-> [!WARNING]
-> This CLI does not implement yet.
-
-```shell
-(.venv) $ ddeutil-workflow schedule
-```
+> `$ workflow-cli api --host 127.0.0.1 --port 80 --workers 4`
 
 ### Docker Container
 
 Build a Docker container from this package.
 
 ```shell
-$ docker build -t ddeutil-workflow:latest -f .container/Dockerfile .
-$ docker run -i ddeutil-workflow:latest ddeutil-workflow
+$ docker pull ghcr.io/ddeutils/ddeutil-workflow:latest
+$ docker run --rm ghcr.io/ddeutils/ddeutil-workflow:latest ddeutil-worker
 ```
 
 ## :speech_balloon: Contribute

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ddeutil-workflow"
-description = "Lightweight workflow orchestration"
+description = "Lightweight workflow orchestration with YAML template"
 readme = {file = "README.md", content-type = "text/markdown"}
 license = {text = "MIT"}
 authors = [{ name = "ddeutils", email = "korawich.anu@gmail.com" }]
@@ -30,7 +30,7 @@ dependencies = [
     "pydantic==2.11.4",
     "pydantic-extra-types==2.10.4",
     "python-dotenv==1.1.0",
-    "schedule==1.2.2,<2.0.0",
+    "typer==0.15.4",
 ]
 dynamic = ["version"]
 
@@ -42,23 +42,11 @@ all = [
     "ujson",
     "aiofiles",
     "aiohttp",
-]
-api = [
-    "fastapi>=0.115.0,<1.0.0",
-    "uvicorn",
-    "httpx",
-    "ujson",
-]
-async = [
-    "aiofiles",
-    "aiohttp",
+    "requests==2.32.3",
 ]
 docker = [
     "docker==7.1.0",
 ]
-self_hosted = [
-    "requests==2.32.3",
-]
 
 [project.urls]
 Homepage = "https://github.com/ddeutils/ddeutil-workflow/"
@@ -90,15 +78,13 @@ omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
     "src/ddeutil/workflow/__main__.py",
+    "src/ddeutil/workflow/cli.py",
     "src/ddeutil/workflow/api/__init__.py",
     "src/ddeutil/workflow/api/logs.py",
-    "src/ddeutil/workflow/api/utils.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",
 ]
 
 [tool.coverage.report]
@@ -110,12 +96,10 @@ exclude_lines = [
 [tool.pytest.ini_options]
 pythonpath = ["src"]
 asyncio_default_fixture_loop_scope = "fuction"
-# NOTE: You can deslect multiple markers by '-m "not (poke or api)"'
+# NOTE: You can deslect multiple markers by '-m "not (asyncio or api)"'
 markers = [
-    "poke: marks tests as slow by poking (deselect with '-m \"not poke\"')",
-    "schedule: marks tests as schedule (deselect with '-m \"not schedule\"')",
     "api: marks tests as api (deselect with '-m \"not api\"')",
-    "asyncio: marks async testcases",
+    "asyncio: marks async test cases",
 ]
 console_output_style = "count"
 addopts = [

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

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

ddeutil_workflow-0.0.67/src/ddeutil/workflow/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

ddeutil_workflow-0.0.67/src/ddeutil/workflow/cli.py

@@ -0,0 +1,68 @@
+import json
+from typing import Annotated, Any
+
+import typer
+import uvicorn
+
+from .__about__ import __version__
+from .api import app as fastapp
+from .api.logs import LOGGING_CONFIG
+
+app = typer.Typer(
+    pretty_exceptions_enable=True,
+)
+
+
+@app.callback()
+def callback():
+    """
+    Awesome Portal Gun
+    """
+    typer.echo("Start call from callback function")
+
+
+@app.command()
+def version():
+    """Get the ddeutil-workflow package version."""
+    typer.echo(__version__)
+
+
+@app.command()
+def job(
+    params: Annotated[str, typer.Option(help="A job execute parameters")],
+):
+    """Job execution on the local.
+
+    Example:
+        ... workflow-cli job --params "{\"test\": 1}"
+    """
+    try:
+        params_dict: dict[str, Any] = json.loads(params)
+    except json.JSONDecodeError as e:
+        raise ValueError(f"params does not support format: {params!r}.") from e
+    typer.echo(f"Job params: {params_dict}")
+
+
+@app.command()
+def api(
+    host: Annotated[str, typer.Option(help="A host url.")] = "0.0.0.0",
+    port: Annotated[int, typer.Option(help="A port url.")] = 80,
+    debug: Annotated[bool, typer.Option(help="A debug mode flag")] = True,
+    worker: Annotated[int, typer.Option(help="A worker number")] = None,
+):
+    """
+    Provision API application from the FastAPI.
+    """
+
+    uvicorn.run(
+        fastapp,
+        host=host,
+        port=port,
+        log_config=uvicorn.config.LOGGING_CONFIG | LOGGING_CONFIG,
+        log_level=("DEBUG" if debug else "INFO"),
+        workers=worker,
+    )
+
+
+if __name__ == "__main__":
+    app()

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/src/ddeutil/workflow/conf.py

@@ -18,7 +18,7 @@ from zoneinfo import ZoneInfo
 from ddeutil.core import str2bool
 from ddeutil.io import YamlFlResolve, search_env_replace
 from ddeutil.io.paths import glob_files, is_ignored, read_ignore
-from pydantic import SecretStr, TypeAdapter
+from pydantic import SecretStr
 
 from .__types import DictData
 
@@ -470,7 +470,3 @@ class CallerSecret(SecretStr):  # pragma: no cov
         :rtype: str
         """
         return pass_env(super().get_secret_value())
-
-
-# NOTE: Define the caller secret type for use it directly in the caller func.
-CallerSecretType = TypeAdapter(CallerSecret)

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/src/ddeutil/workflow/errors.py

@@ -90,9 +90,6 @@ class ResultError(UtilError): ...
 class StageError(BaseError): ...
 
 
-class StageRetryError(StageError): ...
-
-
 class StageCancelError(StageError): ...
 
 
@@ -114,9 +111,6 @@ class WorkflowError(BaseError): ...
 class WorkflowCancelError(WorkflowError): ...
 
 
-class WorkflowSkipError(WorkflowError): ...
-
-
 class WorkflowTimeoutError(WorkflowError): ...
 
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/src/ddeutil/workflow/job.py

@@ -39,7 +39,6 @@ from pydantic import BaseModel, Discriminator, Field, SecretStr, Tag
 from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
-from . import JobSkipError
 from .__types import DictData, DictStr, Matrix, StrOrNone
 from .errors import JobCancelError, JobError, to_dict
 from .result import (
@@ -774,7 +773,7 @@ def local_execute_strategy(
     *,
     result: Optional[Result] = None,
     event: Optional[Event] = None,
-) -> Result:
+) -> tuple[Status, Result]:
     """Local strategy execution with passing dynamic parameters from the
     job execution and strategy matrix.
 
@@ -799,7 +798,7 @@ def local_execute_strategy(
     :raise JobError: If stage execution raise any error as `StageError`.
     :raise JobError: If the result from execution has `FAILED` status.
 
-    :rtype: Result
+    :rtype: tuple[Status, Result]
     """
     result: Result = result or Result(
         run_id=gen_id(job.id or "EMPTY", unique=True),
@@ -899,9 +898,7 @@ def local_execute_strategy(
             },
         },
     )
-    if status == SKIP:
-        raise JobSkipError("All stage was skipped.")
-    return result
+    return status, result
 
 
 def local_execute(
@@ -1017,14 +1014,13 @@ def local_execute(
 
         for i, future in enumerate(done, start=0):
             try:
-                statuses[i] = future.result().status
+                statuses[i], _ = future.result()
             except JobError as e:
                 statuses[i] = get_status_from_error(e)
                 result.trace.error(
-                    f"[JOB]: {ls} Error Handler:||{e.__class__.__name__}: {e}"
+                    f"[JOB]: {ls} Handler:||{e.__class__.__name__}: {e}"
                 )
-                if not isinstance(e, JobSkipError):
-                    mark_errors(context, e)
+                mark_errors(context, e)
             except CancelledError:
                 pass
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/src/ddeutil/workflow/logs.py

@@ -848,7 +848,7 @@ class FileAudit(BaseAudit):
             "audit_path", extras=self.extras
         ) / self.filename_fmt.format(name=self.name, release=self.release)
 
-    def save(self, excluded: Optional[list[str]]) -> Self:
+    def save(self, excluded: Optional[list[str]] = None) -> Self:
         """Save logging data that receive a context data from a workflow
         execution result.
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.67}/src/ddeutil/workflow/result.py

@@ -11,7 +11,7 @@ from __future__ import annotations
 
 from dataclasses import field
 from datetime import datetime
-from enum import IntEnum, auto
+from enum import Enum
 from typing import Optional, Union
 
 from pydantic import ConfigDict
@@ -28,7 +28,6 @@ from . import (
     StageSkipError,
     WorkflowCancelError,
     WorkflowError,
-    WorkflowSkipError,
 )
 from .__types import DictData
 from .conf import dynamic
@@ -37,16 +36,16 @@ from .logs import TraceModel, get_dt_tznow, get_trace
 from .utils import default_gen_id, gen_id, get_dt_now
 
 
-class Status(IntEnum):
+class Status(str, Enum):
     """Status Int Enum object that use for tracking execution status to the
     Result dataclass object.
     """
 
-    SUCCESS = auto()
-    FAILED = auto()
-    WAIT = auto()
-    SKIP = auto()
-    CANCEL = auto()
+    SUCCESS = "SUCCESS"
+    FAILED = "FAILED"
+    WAIT = "WAIT"
+    SKIP = "SKIP"
+    CANCEL = "CANCEL"
 
     @property
     def emoji(self) -> str:  # pragma: no cov
@@ -68,6 +67,9 @@ class Status(IntEnum):
     def __str__(self) -> str:
         return self.name
 
+    def is_result(self) -> bool:
+        return self in ResultStatuses
+
 
 SUCCESS = Status.SUCCESS
 FAILED = Status.FAILED
@@ -75,6 +77,8 @@ WAIT = Status.WAIT
 SKIP = Status.SKIP
 CANCEL = Status.CANCEL
 
+ResultStatuses: list[Status] = [SUCCESS, FAILED, CANCEL, SKIP]
+
 
 def validate_statuses(statuses: list[Status]) -> Status:
     """Validate the final status from list of Status object.
@@ -106,13 +110,12 @@ def get_status_from_error(
         JobSkipError,
         WorkflowError,
         WorkflowCancelError,
-        WorkflowSkipError,
         Exception,
         BaseException,
     ]
 ) -> Status:
     """Get the Status from the error object."""
-    if isinstance(error, (StageSkipError, JobSkipError, WorkflowSkipError)):
+    if isinstance(error, (StageSkipError, JobSkipError)):
         return SKIP
     elif isinstance(
         error, (StageCancelError, JobCancelError, WorkflowCancelError)