ddeutil-workflow 0.0.24__tar.gz → 0.0.26__tar.gz

{ddeutil_workflow-0.0.24/src/ddeutil_workflow.egg-info → ddeutil_workflow-0.0.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ddeutil-workflow
-Version: 0.0.24
+Version: 0.0.26
 Summary: Lightweight workflow orchestration with less dependencies
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -26,7 +26,6 @@ Requires-Dist: ddeutil>=0.4.3
 Requires-Dist: ddeutil-io[toml,yaml]>=0.2.3
 Requires-Dist: pydantic==2.10.4
 Requires-Dist: python-dotenv==1.0.1
-Requires-Dist: typer==0.15.1
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"
@@ -68,8 +67,8 @@ configuration. It called **Metadata Driven Data Workflow**.
 > with `.yml` files and all of config file from several data orchestration framework
 > tools from my experience on Data Engineer. :grimacing:
 >
-> Other workflow that I interest on them and pick some interested feature to this
-> package:
+> Other workflow tools that I interest on them and pick some interested feature
+> implement to this package:
 >
 > - [Google **Workflows**](https://cloud.google.com/workflows)
 > - [AWS **Step Functions**](https://aws.amazon.com/step-functions/)
@@ -80,23 +79,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;
 
-| Usecase           | Install Optional                         | Support            |
-|-------------------|------------------------------------------|--------------------|
-| Python & CLI      | `pip install ddeutil-workflow`           | :heavy_check_mark: |
-| FastAPI Server    | `pip install ddeutil-workflow[api]`      | :heavy_check_mark: |
-
-
-> I added this feature to the main milestone.
->
-> :egg: **Docker Images** supported:
->
-> | Docker Image                | Python Version | Support |
-> |-----------------------------|----------------|---------|
-> | ddeutil-workflow:latest     | `3.9`          | :x:     |
-> | ddeutil-workflow:python3.10 | `3.10`         | :x:     |
-> | ddeutil-workflow:python3.11 | `3.11`         | :x:     |
-> | ddeutil-workflow:python3.12 | `3.12`         | :x:     |
-> | ddeutil-workflow:python3.12 | `3.13`         | :x:     |
+| Usecase        | Install Optional                         | Support            |
+|----------------|------------------------------------------|--------------------|
+| Python         | `pip install ddeutil-workflow`           | :heavy_check_mark: |
+| FastAPI Server | `pip install ddeutil-workflow[api]`      | :heavy_check_mark: |
 
 ## :beers: Usage
 
@@ -113,7 +99,7 @@ use-case.
 run-py-local:
 
    # Validate model that use to parsing exists for template file
-   type: ddeutil.workflow.Workflow
+   type: ddeutil.workflow.workflow.Workflow
    on:
       # If workflow deploy to schedule, it will running every 5 minutes
       # with Asia/Bangkok timezone.
@@ -182,35 +168,35 @@ The main configuration that use to dynamic changing with your propose of this
 application. If any configuration values do not set yet, it will use default value
 and do not raise any error to you.
 
-| Environment                             | Component | Default                          | Description                                                                                                        | Remark |
-|:----------------------------------------|:----------|:---------------------------------|--------------------------------------------------------------------------------------------------------------------|--------|
-| `WORKFLOW_ROOT_PATH`                    | Core      | .                                | The root path of the workflow application.                                                                         |        |
-| `WORKFLOW_CORE_REGISTRY`                | Core      | src.ddeutil.workflow,tests.utils | List of importable string for the hook stage.                                                                      |        |
-| `WORKFLOW_CORE_REGISTRY_FILTER`         | Core      | ddeutil.workflow.utils           | List of importable string for the filter template.                                                                 |        |
-| `WORKFLOW_CORE_PATH_CONF`               | Core      | conf                             | The config path that keep all template `.yaml` files.                                                              |        |
-| `WORKFLOW_CORE_TIMEZONE`                | Core      | Asia/Bangkok                     | A Timezone string value that will pass to `ZoneInfo` object.                                                       |        |
-| `WORKFLOW_CORE_STAGE_DEFAULT_ID`        | Core      | true                             | A flag that enable default stage ID that use for catch an execution output.                                        |        |
-| `WORKFLOW_CORE_STAGE_RAISE_ERROR`       | Core      | false                            | A flag that all stage raise StageException from stage execution.                                                   |        |
-| `WORKFLOW_CORE_JOB_DEFAULT_ID`          | Core      | false                            | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |        |
-| `WORKFLOW_CORE_JOB_RAISE_ERROR`         | Core      | true                             | A flag that all job raise JobException from job strategy execution.                                                |        |
-| `WORKFLOW_CORE_MAX_NUM_POKING`          | Core      | 4                                | .                                                                                                                  |        |
-| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        | Core      | 2                                | The maximum job number that able to run parallel in workflow executor.                                             |        |
-| `WORKFLOW_CORE_MAX_JOB_EXEC_TIMEOUT`    | Core      | 600                              |                                                                                                                    |        |
-| `WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW`   | Core      | 5                                |                                                                                                                    |        |
-| `WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST` | Core      | 16                               |                                                                                                                    |        |
-| `WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE` | Core      | true                             | A flog that enable generating ID with `md5` algorithm.                                                             |        |
-| `WORKFLOW_LOG_DEBUG_MODE`               | Log       | true                             | A flag that enable logging with debug level mode.                                                                  |        |
-| `WORKFLOW_LOG_ENABLE_WRITE`             | Log       | true                             | A flag that enable logging object saving log to its destination.                                                   |        |
-| `WORKFLOW_APP_MAX_PROCESS`              | Schedule  | 2                                | The maximum process worker number that run in scheduler app module.                                                |        |
-| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` | Schedule  | 100                              | A schedule per process that run parallel.                                                                          |        |
-| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      | Schedule  | '{"minutes": 5, "seconds": 20}'  | A time delta value that use to stop scheduler app in json string format.                                           |        |
+| Environment                             | Component  | Default                                            | Description                                                                                                        | Remark |
+|:----------------------------------------|:----------:|:---------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|--------|
+| `WORKFLOW_ROOT_PATH`                    |    Core    | .                                                  | The root path of the workflow application.                                                                         |        |
+| `WORKFLOW_CORE_REGISTRY`                |    Core    | src,src.ddeutil.workflow,tests,tests.utils         | List of importable string for the hook stage.                                                                      |        |
+| `WORKFLOW_CORE_REGISTRY_FILTER`         |    Core    | src.ddeutil.workflow.utils,ddeutil.workflow.utils  | List of importable string for the filter template.                                                                 |        |
+| `WORKFLOW_CORE_PATH_CONF`               |    Core    | conf                                               | The config path that keep all template `.yaml` files.                                                              |        |
+| `WORKFLOW_CORE_TIMEZONE`                |    Core    | Asia/Bangkok                                       | A Timezone string value that will pass to `ZoneInfo` object.                                                       |        |
+| `WORKFLOW_CORE_STAGE_DEFAULT_ID`        |    Core    | true                                               | A flag that enable default stage ID that use for catch an execution output.                                        |        |
+| `WORKFLOW_CORE_STAGE_RAISE_ERROR`       |    Core    | false                                              | A flag that all stage raise StageException from stage execution.                                                   |        |
+| `WORKFLOW_CORE_JOB_DEFAULT_ID`          |    Core    | false                                              | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |        |
+| `WORKFLOW_CORE_JOB_RAISE_ERROR`         |    Core    | true                                               | A flag that all job raise JobException from job strategy execution.                                                |        |
+| `WORKFLOW_CORE_MAX_NUM_POKING`          |    Core    | 4                                                  | .                                                                                                                  |        |
+| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        |    Core    | 2                                                  | The maximum job number that able to run parallel in workflow executor.                                             |        |
+| `WORKFLOW_CORE_MAX_JOB_EXEC_TIMEOUT`    |    Core    | 600                                                |                                                                                                                    |        |
+| `WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW`   |    Core    | 5                                                  |                                                                                                                    |        |
+| `WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST` |    Core    | 16                                                 |                                                                                                                    |        |
+| `WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE` |    Core    | true                                               | A flog that enable generating ID with `md5` algorithm.                                                             |        |
+| `WORKFLOW_LOG_DEBUG_MODE`               |    Log     | true                                               | A flag that enable logging with debug level mode.                                                                  |        |
+| `WORKFLOW_LOG_ENABLE_WRITE`             |    Log     | true                                               | A flag that enable logging object saving log to its destination.                                                   |        |
+| `WORKFLOW_APP_MAX_PROCESS`              |  Schedule  | 2                                                  | The maximum process worker number that run in scheduler app module.                                                |        |
+| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` |  Schedule  | 100                                                | A schedule per process that run parallel.                                                                          |        |
+| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      |  Schedule  | '{"minutes": 5, "seconds": 20}'                    | A time delta value that use to stop scheduler app in json string format.                                           |        |
 
 **API Application**:
 
-| Environment                           | Component | Default | Description                                                                        | Remark |
-|:--------------------------------------|-----------|---------|------------------------------------------------------------------------------------|--------|
-| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  | API       | true    | A flag that enable workflow route to manage execute manually and workflow logging. |        |
-| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  | API       | true    | A flag that enable run scheduler.                                                  |        |
+| Environment                           |  Component  | Default | Description                                                                        | Remark |
+|:--------------------------------------|:-----------:|---------|------------------------------------------------------------------------------------|--------|
+| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  |     API     | true    | A flag that enable workflow route to manage execute manually and workflow logging. |        |
+| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  |     API     | true    | A flag that enable run scheduler.                                                  |        |
 
 ## :rocket: Deployment
 
@@ -218,12 +204,6 @@ This package able to run as a application service for receive manual trigger
 from the master node via RestAPI or use to be Scheduler background service
 like crontab job but via Python API.
 
-### Schedule App
-
-```shell
-(venv) $ ddeutil-workflow schedule
-```
-
 ### API Server
 
 ```shell
@@ -231,7 +211,7 @@ like crontab job but via Python API.
 ```
 
 > [!NOTE]
-> If this package already deploy, it able to use
+> If this package already deploy, it able to use multiprocess;
 > `uvicorn ddeutil.workflow.api:app --host 127.0.0.1 --port 80 --workers 4`
 
 ### Docker Container

{ddeutil_workflow-0.0.24 → ddeutil_workflow-0.0.26}/README.md

@@ -35,8 +35,8 @@ configuration. It called **Metadata Driven Data Workflow**.
 > with `.yml` files and all of config file from several data orchestration framework
 > tools from my experience on Data Engineer. :grimacing:
 >
-> Other workflow that I interest on them and pick some interested feature to this
-> package:
+> Other workflow tools that I interest on them and pick some interested feature
+> implement to this package:
 >
 > - [Google **Workflows**](https://cloud.google.com/workflows)
 > - [AWS **Step Functions**](https://aws.amazon.com/step-functions/)
@@ -47,23 +47,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;
 
-| Usecase           | Install Optional                         | Support            |
-|-------------------|------------------------------------------|--------------------|
-| Python & CLI      | `pip install ddeutil-workflow`           | :heavy_check_mark: |
-| FastAPI Server    | `pip install ddeutil-workflow[api]`      | :heavy_check_mark: |
-
-
-> I added this feature to the main milestone.
->
-> :egg: **Docker Images** supported:
->
-> | Docker Image                | Python Version | Support |
-> |-----------------------------|----------------|---------|
-> | ddeutil-workflow:latest     | `3.9`          | :x:     |
-> | ddeutil-workflow:python3.10 | `3.10`         | :x:     |
-> | ddeutil-workflow:python3.11 | `3.11`         | :x:     |
-> | ddeutil-workflow:python3.12 | `3.12`         | :x:     |
-> | ddeutil-workflow:python3.12 | `3.13`         | :x:     |
+| Usecase        | Install Optional                         | Support            |
+|----------------|------------------------------------------|--------------------|
+| Python         | `pip install ddeutil-workflow`           | :heavy_check_mark: |
+| FastAPI Server | `pip install ddeutil-workflow[api]`      | :heavy_check_mark: |
 
 ## :beers: Usage
 
@@ -80,7 +67,7 @@ use-case.
 run-py-local:
 
    # Validate model that use to parsing exists for template file
-   type: ddeutil.workflow.Workflow
+   type: ddeutil.workflow.workflow.Workflow
    on:
       # If workflow deploy to schedule, it will running every 5 minutes
       # with Asia/Bangkok timezone.
@@ -149,35 +136,35 @@ The main configuration that use to dynamic changing with your propose of this
 application. If any configuration values do not set yet, it will use default value
 and do not raise any error to you.
 
-| Environment                             | Component | Default                          | Description                                                                                                        | Remark |
-|:----------------------------------------|:----------|:---------------------------------|--------------------------------------------------------------------------------------------------------------------|--------|
-| `WORKFLOW_ROOT_PATH`                    | Core      | .                                | The root path of the workflow application.                                                                         |        |
-| `WORKFLOW_CORE_REGISTRY`                | Core      | src.ddeutil.workflow,tests.utils | List of importable string for the hook stage.                                                                      |        |
-| `WORKFLOW_CORE_REGISTRY_FILTER`         | Core      | ddeutil.workflow.utils           | List of importable string for the filter template.                                                                 |        |
-| `WORKFLOW_CORE_PATH_CONF`               | Core      | conf                             | The config path that keep all template `.yaml` files.                                                              |        |
-| `WORKFLOW_CORE_TIMEZONE`                | Core      | Asia/Bangkok                     | A Timezone string value that will pass to `ZoneInfo` object.                                                       |        |
-| `WORKFLOW_CORE_STAGE_DEFAULT_ID`        | Core      | true                             | A flag that enable default stage ID that use for catch an execution output.                                        |        |
-| `WORKFLOW_CORE_STAGE_RAISE_ERROR`       | Core      | false                            | A flag that all stage raise StageException from stage execution.                                                   |        |
-| `WORKFLOW_CORE_JOB_DEFAULT_ID`          | Core      | false                            | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |        |
-| `WORKFLOW_CORE_JOB_RAISE_ERROR`         | Core      | true                             | A flag that all job raise JobException from job strategy execution.                                                |        |
-| `WORKFLOW_CORE_MAX_NUM_POKING`          | Core      | 4                                | .                                                                                                                  |        |
-| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        | Core      | 2                                | The maximum job number that able to run parallel in workflow executor.                                             |        |
-| `WORKFLOW_CORE_MAX_JOB_EXEC_TIMEOUT`    | Core      | 600                              |                                                                                                                    |        |
-| `WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW`   | Core      | 5                                |                                                                                                                    |        |
-| `WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST` | Core      | 16                               |                                                                                                                    |        |
-| `WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE` | Core      | true                             | A flog that enable generating ID with `md5` algorithm.                                                             |        |
-| `WORKFLOW_LOG_DEBUG_MODE`               | Log       | true                             | A flag that enable logging with debug level mode.                                                                  |        |
-| `WORKFLOW_LOG_ENABLE_WRITE`             | Log       | true                             | A flag that enable logging object saving log to its destination.                                                   |        |
-| `WORKFLOW_APP_MAX_PROCESS`              | Schedule  | 2                                | The maximum process worker number that run in scheduler app module.                                                |        |
-| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` | Schedule  | 100                              | A schedule per process that run parallel.                                                                          |        |
-| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      | Schedule  | '{"minutes": 5, "seconds": 20}'  | A time delta value that use to stop scheduler app in json string format.                                           |        |
+| Environment                             | Component  | Default                                            | Description                                                                                                        | Remark |
+|:----------------------------------------|:----------:|:---------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|--------|
+| `WORKFLOW_ROOT_PATH`                    |    Core    | .                                                  | The root path of the workflow application.                                                                         |        |
+| `WORKFLOW_CORE_REGISTRY`                |    Core    | src,src.ddeutil.workflow,tests,tests.utils         | List of importable string for the hook stage.                                                                      |        |
+| `WORKFLOW_CORE_REGISTRY_FILTER`         |    Core    | src.ddeutil.workflow.utils,ddeutil.workflow.utils  | List of importable string for the filter template.                                                                 |        |
+| `WORKFLOW_CORE_PATH_CONF`               |    Core    | conf                                               | The config path that keep all template `.yaml` files.                                                              |        |
+| `WORKFLOW_CORE_TIMEZONE`                |    Core    | Asia/Bangkok                                       | A Timezone string value that will pass to `ZoneInfo` object.                                                       |        |
+| `WORKFLOW_CORE_STAGE_DEFAULT_ID`        |    Core    | true                                               | A flag that enable default stage ID that use for catch an execution output.                                        |        |
+| `WORKFLOW_CORE_STAGE_RAISE_ERROR`       |    Core    | false                                              | A flag that all stage raise StageException from stage execution.                                                   |        |
+| `WORKFLOW_CORE_JOB_DEFAULT_ID`          |    Core    | false                                              | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |        |
+| `WORKFLOW_CORE_JOB_RAISE_ERROR`         |    Core    | true                                               | A flag that all job raise JobException from job strategy execution.                                                |        |
+| `WORKFLOW_CORE_MAX_NUM_POKING`          |    Core    | 4                                                  | .                                                                                                                  |        |
+| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        |    Core    | 2                                                  | The maximum job number that able to run parallel in workflow executor.                                             |        |
+| `WORKFLOW_CORE_MAX_JOB_EXEC_TIMEOUT`    |    Core    | 600                                                |                                                                                                                    |        |
+| `WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW`   |    Core    | 5                                                  |                                                                                                                    |        |
+| `WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST` |    Core    | 16                                                 |                                                                                                                    |        |
+| `WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE` |    Core    | true                                               | A flog that enable generating ID with `md5` algorithm.                                                             |        |
+| `WORKFLOW_LOG_DEBUG_MODE`               |    Log     | true                                               | A flag that enable logging with debug level mode.                                                                  |        |
+| `WORKFLOW_LOG_ENABLE_WRITE`             |    Log     | true                                               | A flag that enable logging object saving log to its destination.                                                   |        |
+| `WORKFLOW_APP_MAX_PROCESS`              |  Schedule  | 2                                                  | The maximum process worker number that run in scheduler app module.                                                |        |
+| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` |  Schedule  | 100                                                | A schedule per process that run parallel.                                                                          |        |
+| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      |  Schedule  | '{"minutes": 5, "seconds": 20}'                    | A time delta value that use to stop scheduler app in json string format.                                           |        |
 
 **API Application**:
 
-| Environment                           | Component | Default | Description                                                                        | Remark |
-|:--------------------------------------|-----------|---------|------------------------------------------------------------------------------------|--------|
-| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  | API       | true    | A flag that enable workflow route to manage execute manually and workflow logging. |        |
-| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  | API       | true    | A flag that enable run scheduler.                                                  |        |
+| Environment                           |  Component  | Default | Description                                                                        | Remark |
+|:--------------------------------------|:-----------:|---------|------------------------------------------------------------------------------------|--------|
+| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  |     API     | true    | A flag that enable workflow route to manage execute manually and workflow logging. |        |
+| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  |     API     | true    | A flag that enable run scheduler.                                                  |        |
 
 ## :rocket: Deployment
 
@@ -185,12 +172,6 @@ This package able to run as a application service for receive manual trigger
 from the master node via RestAPI or use to be Scheduler background service
 like crontab job but via Python API.
 
-### Schedule App
-
-```shell
-(venv) $ ddeutil-workflow schedule
-```
-
 ### API Server
 
 ```shell
@@ -198,7 +179,7 @@ like crontab job but via Python API.
 ```
 
 > [!NOTE]
-> If this package already deploy, it able to use
+> If this package already deploy, it able to use multiprocess;
 > `uvicorn ddeutil.workflow.api:app --host 127.0.0.1 --port 80 --workers 4`
 
 ### Docker Container

{ddeutil_workflow-0.0.24 → ddeutil_workflow-0.0.26}/pyproject.toml

@@ -30,7 +30,6 @@ dependencies = [
     "ddeutil-io[yaml,toml]>=0.2.3",
     "pydantic==2.10.4",
     "python-dotenv==1.0.1",
-    "typer==0.15.1",
     "schedule==1.2.2,<2.0.0",
 ]
 dynamic = ["version"]
@@ -44,9 +43,6 @@ api = [
 Homepage = "https://github.com/ddeutils/ddeutil-workflow/"
 "Source Code" = "https://github.com/ddeutils/ddeutil-workflow/"
 
-[project.scripts]
-ddeutil-workflow = "ddeutil.workflow.cli:cli"
-
 [tool.setuptools.dynamic]
 version = {attr = "ddeutil.workflow.__about__.__version__"}
 
@@ -65,11 +61,10 @@ source = ["ddeutil.workflow"]
 omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
-    # NOTE: Omit this files because it does not ready to production.
-    "src/ddeutil/workflow/api.py",
-    "src/ddeutil/workflow/cli.py",
-    "src/ddeutil/workflow/repeat.py",
-    "src/ddeutil/workflow/route.py",
+    "src/ddeutil/workflow/api/__init__.py",
+    "src/ddeutil/workflow/api/api.py",
+    "src/ddeutil/workflow/api/repeat.py",
+    "src/ddeutil/workflow/api/route.py",
 ]
 
 [tool.coverage.report]

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

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

ddeutil_workflow-0.0.26/src/ddeutil/workflow/api/__init__.py

@@ -0,0 +1 @@
+from .api import app

{ddeutil_workflow-0.0.24/src/ddeutil/workflow → ddeutil_workflow-0.0.26/src/ddeutil/workflow/api}/api.py

@@ -11,7 +11,6 @@ import uuid
 from collections.abc import AsyncIterator
 from datetime import datetime, timedelta
 from queue import Empty, Queue
-from threading import Thread
 from typing import TypedDict
 
 from dotenv import load_dotenv
@@ -20,34 +19,39 @@ from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.responses import UJSONResponse
 from pydantic import BaseModel
 
-from .__about__ import __version__
-from .conf import config, get_logger
+from ..__about__ import __version__
+from ..conf import config, get_logger
+from ..scheduler import ReleaseThread, ReleaseThreads
+from ..workflow import WorkflowQueue, WorkflowTask
 from .repeat import repeat_at, repeat_every
-from .workflow import WorkflowTask
 
 load_dotenv()
 logger = get_logger("ddeutil.workflow")
 
 
 class State(TypedDict):
+    """TypeDict for State of FastAPI application."""
+
+    # NOTE: For upper queue route.
     upper_queue: Queue
     upper_result: dict[str, str]
+
+    # NOTE: For schedule listener.
     scheduler: list[str]
-    workflow_threads: dict[str, Thread]
+    workflow_threads: ReleaseThreads
     workflow_tasks: list[WorkflowTask]
-    workflow_queue: dict[str, list[datetime]]
-    workflow_running: dict[str, list[datetime]]
+    workflow_queue: dict[str, WorkflowQueue]
 
 
 @contextlib.asynccontextmanager
 async def lifespan(a: FastAPI) -> AsyncIterator[State]:
+    """Lifespan function for the FastAPI application."""
     a.state.upper_queue = Queue()
     a.state.upper_result = {}
     a.state.scheduler = []
     a.state.workflow_threads = {}
     a.state.workflow_tasks = []
     a.state.workflow_queue = {}
-    a.state.workflow_running = {}
 
     await asyncio.create_task(broker_upper_messages())
 
@@ -65,7 +69,6 @@ async def lifespan(a: FastAPI) -> AsyncIterator[State]:
         #
         "scheduler": a.state.scheduler,
         "workflow_queue": a.state.workflow_queue,
-        "workflow_running": a.state.workflow_running,
         "workflow_threads": a.state.workflow_threads,
         "workflow_tasks": a.state.workflow_tasks,
     }
@@ -114,12 +117,11 @@ async def get_result(request_id: str) -> dict[str, str]:
 
 
 @app.get("/")
-@app.get("/api")
 async def health():
     return {"message": "Workflow API already start up"}
 
 
-@app.post("/api")
+@app.post(f"{config.prefix_path}/upper")
 async def message_upper(payload: Payload):
     """Convert message from any case to the upper case."""
     request_id: str = str(uuid.uuid4())
@@ -129,27 +131,47 @@ async def message_upper(payload: Payload):
     return await get_result(request_id)
 
 
+# NOTE: Enable the workflow route.
 if config.enable_route_workflow:
-    from .route import workflow
+    from .route import workflow_route
+
+    app.include_router(workflow_route, prefix=config.prefix_path)
 
-    app.include_router(workflow)
 
+# NOTE: Enable the schedule route.
 if config.enable_route_schedule:
-    from .route import schedule
-    from .scheduler import workflow_task
+    from ..conf import FileLog
+    from ..scheduler import schedule_task
+    from .route import schedule_route
 
-    app.include_router(schedule)
+    app.include_router(schedule_route, prefix=config.prefix_path)
 
-    @schedule.on_event("startup")
+    @schedule_route.on_event("startup")
     @repeat_at(cron="* * * * *", delay=2)
-    def schedule_broker_up():
+    def scheduler_listener():
+        """Schedule broker every minute at 02 second."""
         logger.debug(
             f"[SCHEDULER]: Start listening schedule from queue "
             f"{app.state.scheduler}"
         )
         if app.state.workflow_tasks:
-            workflow_task(
+            schedule_task(
                 app.state.workflow_tasks,
-                stop=datetime.now() + timedelta(minutes=1),
+                stop=datetime.now(config.tz) + timedelta(minutes=1),
+                queue=app.state.workflow_queue,
                 threads=app.state.workflow_threads,
+                log=FileLog,
             )
+
+    @schedule_route.on_event("startup")
+    @repeat_at(cron="*/5 * * * *")
+    def monitoring():
+        logger.debug("[MONITOR]: Start monitoring threading.")
+        snapshot_threads: list[str] = list(app.state.workflow_threads.keys())
+        for t_name in snapshot_threads:
+
+            thread_release: ReleaseThread = app.state.workflow_threads[t_name]
+
+            # NOTE: remove the thread that running success.
+            if not thread_release["thread"].is_alive():
+                app.state.workflow_threads.pop(t_name)

{ddeutil_workflow-0.0.24/src/ddeutil/workflow → ddeutil_workflow-0.0.26/src/ddeutil/workflow/api}/repeat.py

@@ -12,8 +12,8 @@ from functools import wraps
 
 from starlette.concurrency import run_in_threadpool
 
-from .__cron import CronJob
-from .conf import config, get_logger
+from ..__cron import CronJob
+from ..conf import config, get_logger
 
 logger = get_logger("ddeutil.workflow")