ddeutil-workflow 0.0.66__tar.gz → 0.0.68__tar.gz

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.66
-Summary: Lightweight workflow orchestration
+Version: 0.0.68
+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/
@@ -24,10 +24,10 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ddeutil[checksum]>=0.4.8
 Requires-Dist: ddeutil-io[toml,yaml]>=0.2.14
-Requires-Dist: pydantic==2.11.4
+Requires-Dist: pydantic==2.11.5
 Requires-Dist: pydantic-extra-types==2.10.4
 Requires-Dist: python-dotenv==1.1.0
-Requires-Dist: typer==0.15.4
+Requires-Dist: typer>=0.16.0
 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.66 → ddeutil_workflow-0.0.68}/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.66 → ddeutil_workflow-0.0.68}/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" }]
@@ -27,11 +27,10 @@ requires-python = ">=3.9.13"
 dependencies = [
     "ddeutil[checksum]>=0.4.8",
     "ddeutil-io[yaml,toml]>=0.2.14",
-    "pydantic==2.11.4",
+    "pydantic==2.11.5",
     "pydantic-extra-types==2.10.4",
     "python-dotenv==1.1.0",
-#    "schedule==1.2.2,<2.0.0",
-    "typer==0.15.4",
+    "typer>=0.16.0",
 ]
 dynamic = ["version"]
 
@@ -43,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/"
@@ -91,9 +78,10 @@ omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
     "src/ddeutil/workflow/__main__.py",
+    "src/ddeutil/workflow/__types.py",
     "src/ddeutil/workflow/cli.py",
     "src/ddeutil/workflow/api/__init__.py",
-    "src/ddeutil/workflow/api/logs.py",
+    "src/ddeutil/workflow/api/log_conf.py",
     "src/ddeutil/workflow/api/routes/__init__.py",
     "src/ddeutil/workflow/api/routes/job.py",
     "src/ddeutil/workflow/api/routes/logs.py",
@@ -109,12 +97,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.68/src/ddeutil/workflow/__about__.py

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

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/src/ddeutil/workflow/api/__init__.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 import contextlib
+import logging
 from collections.abc import AsyncIterator
 
 from dotenv import load_dotenv
@@ -19,11 +20,10 @@ from fastapi.responses import UJSONResponse
 
 from ..__about__ import __version__
 from ..conf import api_config
-from ..logs import get_logger
 from .routes import job, log, workflow
 
 load_dotenv()
-logger = get_logger("uvicorn.error")
+logger = logging.getLogger("uvicorn.error")
 
 
 @contextlib.asynccontextmanager
@@ -58,12 +58,16 @@ app.add_middleware(
 
 
 @app.get(path="/", response_class=UJSONResponse)
-async def health():
+async def health() -> UJSONResponse:
     """Index view that not return any template without json status."""
-    return {"message": "Workflow already start up with healthy status."}
+    logger.info("[API]: Workflow API Application already running ...")
+    return UJSONResponse(
+        content={"message": "Workflow already start up with healthy status."},
+        status_code=st.HTTP_200_OK,
+    )
 
 
-# NOTE Add the jobs and logs routes by default.
+# NOTE: Add the jobs and logs routes by default.
 app.include_router(job, prefix=api_config.prefix_path)
 app.include_router(log, prefix=api_config.prefix_path)
 app.include_router(workflow, prefix=api_config.prefix_path)
@@ -71,21 +75,18 @@ app.include_router(workflow, prefix=api_config.prefix_path)
 
 @app.exception_handler(RequestValidationError)
 async def validation_exception_handler(
-    request: Request, exc: RequestValidationError
-):
+    request: Request,
+    exc: RequestValidationError,
+) -> UJSONResponse:
+    """Error Handler for model validate does not valid."""
     _ = request
     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,
-        log_level="DEBUG",
+        content=jsonable_encoder(
+            {
+                "message": "Body does not parsing with model.",
+                "detail": exc.errors(),
+                "body": exc.body,
+            }
+        ),
     )

ddeutil_workflow-0.0.66/src/ddeutil/workflow/api/logs.py → ddeutil_workflow-0.0.68/src/ddeutil/workflow/api/log_conf.py

@@ -1,6 +1,8 @@
+from typing import Any
+
 from ..conf import config
 
-LOGGING_CONFIG = {  # pragma: no cov
+LOGGING_CONFIG: dict[str, Any] = {  # pragma: no cov
     "version": 1,
     "disable_existing_loggers": False,
     "formatters": {
@@ -22,38 +24,49 @@ LOGGING_CONFIG = {  # pragma: no cov
             "stream": "ext://sys.stderr",
         },
         "stream_handler": {
+            # "formatter": "standard",
             "formatter": "custom_formatter",
             "class": "logging.StreamHandler",
             "stream": "ext://sys.stdout",
         },
-        "file_handler": {
-            "formatter": "custom_formatter",
-            "class": "logging.handlers.RotatingFileHandler",
-            "filename": "logs/app.log",
-            "maxBytes": 1024 * 1024 * 1,
-            "backupCount": 3,
-        },
+        # "file_handler": {
+        #     "formatter": "custom_formatter",
+        #     "class": "logging.handlers.RotatingFileHandler",
+        #     "filename": "logs/app.log",
+        #     "maxBytes": 1024 * 1024 * 1,
+        #     "backupCount": 3,
+        # },
     },
     "loggers": {
         "uvicorn": {
-            "handlers": ["default", "file_handler"],
+            # "handlers": ["default", "file_handler"],
+            "handlers": ["default"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
         "uvicorn.access": {
-            "handlers": ["stream_handler", "file_handler"],
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
         "uvicorn.error": {
-            "handlers": ["stream_handler", "file_handler"],
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
-        # "uvicorn.asgi": {
-        #     "handlers": ["stream_handler", "file_handler"],
-        #     "level": "TRACE",
-        #     "propagate": False,
+        "uvicorn.asgi": {
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
+            "level": "TRACE",
+            "propagate": False,
+        },
+        # "ddeutil.workflow": {
+        #     "handlers": ["stream_handler"],
+        #     "level": "INFO",
+        #     # "propagate": False,
+        #     "propagate": True,
         # },
     },
 }

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/src/ddeutil/workflow/api/routes/__init__.py

@@ -3,6 +3,6 @@
 # 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 .workflows import workflow_route as workflow
+from .job import router as job
+from .logs import router as log
+from .workflows import router as workflow

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/src/ddeutil/workflow/api/routes/job.py

@@ -5,20 +5,21 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+import logging
 from typing import Any, Optional
 
 from fastapi import APIRouter
+from fastapi import status as st
 from fastapi.responses import UJSONResponse
 from pydantic import BaseModel, Field
 
 from ...__types import DictData
 from ...errors import JobError
 from ...job import Job
-from ...logs import get_logger
 from ...result import Result
 
-logger = get_logger("uvicorn.error")
-job_route = APIRouter(prefix="/job", tags=["job"])
+logger = logging.getLogger("uvicorn.error")
+router = APIRouter(prefix="/job", tags=["job"])
 
 
 class ResultCreate(BaseModel):
@@ -32,14 +33,19 @@ class ResultCreate(BaseModel):
     )
 
 
-@job_route.post(path="/execute/", response_class=UJSONResponse)
+@router.post(
+    path="/execute/",
+    response_class=UJSONResponse,
+    status_code=st.HTTP_200_OK,
+)
 async def job_execute(
     result: ResultCreate,
     job: Job,
     params: dict[str, Any],
     extras: Optional[dict[str, Any]] = None,
-):
+) -> UJSONResponse:
     """Execute job via RestAPI with execute route path."""
+    logger.info("[API]: Start execute job ...")
     rs: Result = Result(
         run_id=result.run_id,
         parent_run_id=result.parent_run_id,
@@ -61,15 +67,35 @@ async def job_execute(
         )
     except JobError as err:
         rs.trace.error(f"[JOB]: {err.__class__.__name__}: {err}")
+        return UJSONResponse(
+            content={
+                "message": str(err),
+                "result": {
+                    "run_id": rs.run_id,
+                    "parent_run_id": rs.parent_run_id,
+                },
+                "job": job.model_dump(
+                    by_alias=True,
+                    exclude_none=False,
+                    exclude_unset=True,
+                ),
+                "params": params,
+                "context": context,
+            },
+            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
+        )
 
-    return {
-        "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=False,
-            exclude_unset=True,
-        ),
-        "params": params,
-        "context": context,
-    }
+    return UJSONResponse(
+        content={
+            "message": "Execute job via RestAPI successful.",
+            "result": {"run_id": rs.run_id, "parent_run_id": rs.parent_run_id},
+            "job": job.model_dump(
+                by_alias=True,
+                exclude_none=False,
+                exclude_unset=True,
+            ),
+            "params": params,
+            "context": context,
+        },
+        status_code=st.HTTP_200_OK,
+    )

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/src/ddeutil/workflow/api/routes/logs.py

@@ -13,14 +13,14 @@ from fastapi.responses import UJSONResponse
 from ...logs import get_audit
 from ...result import Result
 
-log_route = APIRouter(
+router = APIRouter(
     prefix="/logs",
     tags=["logs"],
     default_response_class=UJSONResponse,
 )
 
 
-@log_route.get(
+@router.get(
     path="/traces/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -50,7 +50,7 @@ async def get_traces(
     }
 
 
-@log_route.get(
+@router.get(
     path="/traces/{run_id}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -77,7 +77,7 @@ async def get_trace_with_id(run_id: str):
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -94,7 +94,7 @@ async def get_audits():
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -113,7 +113,7 @@ async def get_audit_with_workflow(workflow: str):
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/{release}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -140,7 +140,7 @@ async def get_audit_with_workflow_release(
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/{release}/{run_id}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,

{ddeutil_workflow-0.0.66 → ddeutil_workflow-0.0.68}/src/ddeutil/workflow/api/routes/workflows.py

@@ -5,6 +5,7 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+import logging
 from dataclasses import asdict
 from datetime import datetime
 from typing import Any
@@ -16,19 +17,19 @@ from pydantic import BaseModel
 
 from ...__types import DictData
 from ...conf import Loader
-from ...logs import Audit, get_audit, get_logger
+from ...logs import AuditModel, get_audit
 from ...result import Result
 from ...workflow import Workflow
 
-logger = get_logger("uvicorn.error")
-workflow_route = APIRouter(
+logger = logging.getLogger("uvicorn.error")
+router = APIRouter(
     prefix="/workflows",
     tags=["workflows"],
     default_response_class=UJSONResponse,
 )
 
 
-@workflow_route.get(path="/", status_code=st.HTTP_200_OK)
+@router.get(path="/", status_code=st.HTTP_200_OK)
 async def get_workflows() -> DictData:
     """Return all workflow workflows that exists in config path."""
     workflows: DictData = dict(Loader.finds(Workflow))
@@ -39,7 +40,7 @@ async def get_workflows() -> DictData:
     }
 
 
-@workflow_route.get(path="/{name}", status_code=st.HTTP_200_OK)
+@router.get(path="/{name}", status_code=st.HTTP_200_OK)
 async def get_workflow_by_name(name: str) -> DictData:
     """Return model of workflow that passing an input workflow name."""
     try:
@@ -63,7 +64,7 @@ class ExecutePayload(BaseModel):
     params: dict[str, Any]
 
 
-@workflow_route.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
+@router.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
 async def workflow_execute(name: str, payload: ExecutePayload) -> DictData:
     """Return model of workflow that passing an input workflow name."""
     try:
@@ -88,7 +89,7 @@ async def workflow_execute(name: str, payload: ExecutePayload) -> DictData:
     return asdict(result)
 
 
-@workflow_route.get(path="/{name}/audits", status_code=st.HTTP_200_OK)
+@router.get(path="/{name}/audits", status_code=st.HTTP_200_OK)
 async def get_workflow_audits(name: str):
     try:
         return {
@@ -109,11 +110,11 @@ async def get_workflow_audits(name: str):
         ) from None
 
 
-@workflow_route.get(path="/{name}/audits/{release}", status_code=st.HTTP_200_OK)
+@router.get(path="/{name}/audits/{release}", status_code=st.HTTP_200_OK)
 async def get_workflow_release_audit(name: str, release: str):
     """Get Workflow audit log with an input release value."""
     try:
-        audit: Audit = get_audit().find_audit_with_release(
+        audit: AuditModel = get_audit().find_audit_with_release(
             name=name,
             release=datetime.strptime(release, "%Y%m%d%H%M%S"),
         )