Skip to content

Commit b0a600b

Browse files
korawicakorawica
committed
📄 docs: remove scheduler docs.
1 parent 131dca3 commit b0a600b

7 files changed

Lines changed: 5 additions & 208 deletions

File tree

‎.github/workflows/tests-schedule.yml‎

Lines changed: 0 additions & 94 deletions
This file was deleted.

‎README.md‎

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -214,45 +214,6 @@ result: Result = workflow.execute(
214214
)
215215
```
216216

217-
> [!NOTE]
218-
> So, this package provide the `Schedule` template for this action, and you can
219-
> pass the parameters dynamically for changing align with that running time by
220-
> the `release` prefix.
221-
>
222-
> ```yaml
223-
> schedule-run-local-wf:
224-
>
225-
> # Validate model that use to parsing exists for template file
226-
> type: Schedule
227-
> workflows:
228-
>
229-
> # Map existing workflow that want to deploy with scheduler application.
230-
> # It allows you to pass release parameter that dynamic change depend on the
231-
> # current context of this scheduler application releasing that time.
232-
> - name: run-py-local
233-
> params:
234-
> source-extract: "USD-THB"
235-
> run-date: "${{ release.logical_date }}"
236-
> ```
237-
>
238-
> The main method of the `Schedule` model that use to running is `pending`. If you
239-
> do not pass the `stop` date on this method, it will use config with
240-
> `WORKFLOW_APP_STOP_BOUNDARY_DELTA` key for generate this stop date.
241-
>
242-
> ```python
243-
> from ddeutil.workflow import Schedule
244-
>
245-
> (
246-
> Schedule
247-
> .from_conf("schedule-run-local-wf")
248-
> .pending(stop=None)
249-
> )
250-
> ```
251-
252-
> [!WARNING]
253-
> The scheduler feature is the expensive feature of this project. You should
254-
> avoid to use it and find a scheduler tool instead.
255-
256217
## :cookie: Configuration
257218

258219
The main configuration that use to dynamic changing this workflow engine for your
@@ -282,9 +243,6 @@ it will use default value and do not raise any error to you.
282243
| **TRACE_ENABLE_WRITE** | Log | `false` | |
283244
| **AUDIT_PATH** | Log | `./audits` | |
284245
| **AUDIT_ENABLE_WRITE** | Log | `true` | A flag that enable logging object saving log to its destination. |
285-
| **MAX_PROCESS** | App | `2` | The maximum process worker number that run in scheduler app module. |
286-
| **MAX_SCHEDULE_PER_PROCESS** | App | `100` | A schedule per process that run parallel. |
287-
| **STOP_BOUNDARY_DELTA** | App | `'{"minutes": 5, "seconds": 20}'` | A time delta value that use to stop scheduler app in json string format. |
288246

289247
**API Application**:
290248

@@ -294,7 +252,6 @@ only.
294252
| Environment | Component | Default | Description |
295253
|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
296254
| **ENABLE_ROUTE_WORKFLOW** | API | `true` | A flag that enable workflow route to manage execute manually and workflow logging. |
297-
| **ENABLE_ROUTE_SCHEDULE** | API | `true` | A flag that enable run scheduler. |
298255

299256
## :rocket: Deployment
300257

‎docs/api/scheduler.md‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎docs/configuration.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,12 @@ and do not raise any error to you.
3333
| **TRACE_ENABLE_WRITE** | Log | `false` | |
3434
| **AUDIT_PATH** | Log | `./audits` | |
3535
| **AUDIT_ENABLE_WRITE** | Log | `true` | A flag that enable logging object saving log to its destination. |
36-
| **MAX_PROCESS** | App | `2` | The maximum process worker number that run in scheduler app module. |
37-
| **MAX_SCHEDULE_PER_PROCESS** | App | `100` | A schedule per process that run parallel. |
38-
| **STOP_BOUNDARY_DELTA** | App | `'{"minutes": 5, "seconds": 20}'` | A time delta value that use to stop scheduler app in json string format. |
3936

4037
### API
4138

4239
| Environment | Component | Default | <div style="width:25em">Description</div> |
4340
|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
4441
| **ENABLE_ROUTE_WORKFLOW** | API | `true` | A flag that enable workflow route to manage execute manually and workflow logging. |
45-
| **ENABLE_ROUTE_SCHEDULE** | API | `true` | A flag that enable run scheduler. |
4642

4743
## Execution Override
4844

‎docs/index.md‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -204,39 +204,6 @@ result: Result = workflow.execute(
204204
)
205205
```
206206

207-
So, this package provide the `Schedule` template for this action, and you can dynamic
208-
pass the parameters for changing align with that running time by the `release` prefix.
209-
210-
```yaml
211-
schedule-run-local-wf:
212-
213-
# Validate model that use to parsing exists for template file
214-
type: Schedule
215-
workflows:
216-
217-
# Map existing workflow that want to deploy with scheduler application.
218-
# It allows you to pass release parameter that dynamic change depend on the
219-
# current context of this scheduler application releasing that time.
220-
- name: run-py-local
221-
params:
222-
source-extract: "USD-THB"
223-
asat-dt: "${{ release.logical_date }}"
224-
```
225-
226-
The main method of the `Schedule` model that use to running is `pending`. If you
227-
do not pass the `stop` date on this method, it will use config with `WORKFLOW_APP_STOP_BOUNDARY_DELTA`
228-
key for generate this stop date.
229-
230-
```python
231-
from ddeutil.workflow import Schedule
232-
233-
(
234-
Schedule
235-
.from_conf("schedule-run-local-wf")
236-
.pending(stop=None)
237-
)
238-
```
239-
240207
!!! example
241208

242209
For more examples, this workflow can use with these scenarios:

‎src/ddeutil/workflow/reusables.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ def make_filter_registry(
123123
if not (
124124
hasattr(func, "filter")
125125
and str(getattr(func, "mark", "NOT SET")) == "filter"
126-
):
126+
): # pragma: no cov
127127
continue
128128

129129
func: FilterFunc

‎src/ddeutil/workflow/utils.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,11 +293,13 @@ def cut_id(run_id: str, *, num: int = 6) -> str:
293293

294294

295295
@overload
296-
def dump_all(value: BaseModel, by_alias: bool = False) -> DictData: ...
296+
def dump_all(
297+
value: BaseModel, by_alias: bool = False
298+
) -> DictData: ... # pragma: no cov
297299

298300

299301
@overload
300-
def dump_all(value: T, by_alias: bool = False) -> T: ...
302+
def dump_all(value: T, by_alias: bool = False) -> T: ... # pragma: no cov
301303

302304

303305
def dump_all(

0 commit comments

Comments
 (0)