dotflow-io · FernandoCelmer · Aug 13, 2025 · Aug 13, 2025 · Aug 13, 2025 · Aug 13, 2025
diff --git a/.env-example b/.env-example
@@ -0,0 +1,14 @@
+OTEL_SERVICE_NAME=dotflow
+OTEL_METRICS_EXPORT_INTERVAL_MILLIS=5000
+
+OTEL_EXPORTER_OTLP_ENDPOINT=0.0.0.0:4317
+OTEL_EXPORTER_OTLP_INSECURE=true
+
+OTEL_PYTHON_LOG_CORRELATION=true
+OTEL_PYTHON_LOG_FORMAT=%(asctime)s - %(levelname)s [%(name)s]: %(message)s
+OTEL_PYTHON_LOG_LEVEL=20
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+OTEL_PYTHON_LOGGING_SCHEDULE_DELAY_MILLIS=5000
+OTEL_PYTHON_EXCLUDED_URLS=client/.*/info,healthcheck
+OTEL_PYTHON_URLLIB3_EXCLUDED_URLS=client/.*/info
+OTEL_PYTHON_REQUESTS_EXCLUDED_URLS=healthcheck
diff --git a/.gitignore b/.gitignore
@@ -175,7 +175,7 @@ cython_debug/
 
 
 # Dotflow
-.output
+*.output
 .storage
 .dotflow-io
 *.json

diff --git a/LAST_VERSION b/LAST_VERSION
@@ -1 +1 @@
-0.13.1
+1.0.0-dev-3
diff --git a/README.md b/README.md
@@ -103,8 +103,8 @@ def my_task_y():
 
 workflow = DotFlow()
 
-workflow.task.add(step=my_task_x, callback=my_callback)
-workflow.task.add(step=my_task_y, callback=my_callback)
+workflow.add(step=my_task_x, callback=my_callback)
+workflow.add(step=my_task_y, callback=my_callback)
 
 workflow.start()
 ```
@@ -153,20 +153,20 @@ Now, simply add the `my_task_x` and `my_callback` functions you created earlier
 - Adding one step at a time:
 
 ```python
-workflow.task.add(step=my_task_x, callback=my_callback)
-workflow.task.add(step=my_task_y, callback=my_callback)
+workflow.add(step=my_task_x, callback=my_callback)
+workflow.add(step=my_task_y, callback=my_callback)
 ```
 
 - Adding multiple steps at the same time:
 
 ```python
-workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
+workflow.add(step=[my_task_x, my_task_y], callback=my_callback)
 ```
 
 - Adding a step with the module path:
 
 ```python
-workflow.task.add(step="module.task.my_task_x", callback=my_callback)
+workflow.add(step="module.task.my_task_x", callback=my_callback)
 ```
 
 #### 6. Start
@@ -216,8 +216,8 @@ dotflow start --step examples.cli_with_mode.simple_step --mode parallel
 #### Sequential
 
 ```python
-workflow.task.add(step=task_foo)
-workflow.task.add(step=task_bar)
+workflow.add(step=task_foo)
+workflow.add(step=task_bar)
 
 workflow.start()
 ```
@@ -237,8 +237,8 @@ D[Finish]
 #### Background
 
 ```python
-workflow.task.add(step=task_foo)
-workflow.task.add(step=task_bar)
+workflow.add(step=task_foo)
+workflow.add(step=task_bar)
 
 workflow.start(mode="background")
 ```
@@ -259,10 +259,10 @@ D[Finish]
 #### Parallel
 
 ```python
-workflow.task.add(step=task_a)
-workflow.task.add(step=task_b)
-workflow.task.add(step=task_c)
-workflow.task.add(step=task_d)
+workflow.add(step=task_a)
+workflow.add(step=task_b)
+workflow.add(step=task_c)
+workflow.add(step=task_d)
 
 workflow.start(mode="parallel")
 ```

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,7 @@
+services:
+  otel:
+    image: grafana/otel-lgtm
+    ports:
+      - 3000:3000
+      - 4317:4317
+      - 4318:4318
diff --git a/docs/nav/advanced/notify-with-telegram.md b/docs/nav/advanced/notify-with-telegram.md
@@ -47,7 +47,7 @@ import os
 
 from dotflow import Config, DotFlow, action
 from dotflow.notify import NotifyTelegram
-from dotflow.types import TypeStatus
+from dotflow.types import StatusTaskType
 ```
 
 ### Task function
@@ -69,7 +69,7 @@ Instantiate the `NotifyTelegram` class with your Telegram bot credentials. You c
 notify = NotifyTelegram(
     token=os.getenv("TOKEN"),
     chat_id=os.getenv("CHAT_ID"),
-    notification_type=TypeStatus.FAILED  # Notify only on failure
+    notification_type=StatusTaskType.FAILED  # Notify only on failure
 )
 ```
 
@@ -88,7 +88,7 @@ workflow = DotFlow(
 Add your defined task as a step in the workflow:
 
 ```python
-workflow.task.add(step=simple_task)
+workflow.add(step=simple_task)
 ```
 
 ### Start

diff --git a/docs/nav/reference/abc-log.md b/docs/nav/reference/abc-log.md
diff --git a/docs/nav/reference/abc-logs.md b/docs/nav/reference/abc-logs.md
@@ -0,0 +1,3 @@
+# Logs
+
+::: dotflow.abc.logs.Logs
diff --git a/docs/nav/reference/abc-metrics.md b/docs/nav/reference/abc-metrics.md
@@ -0,0 +1,3 @@
+# Metrics
+
+::: dotflow.abc.metrics.Metrics
diff --git a/docs/nav/reference/config.md b/docs/nav/reference/config.md
diff --git a/docs/nav/reference/context-instance.md b/docs/nav/reference/context-instance.md
@@ -1,4 +1,4 @@
-# ContextInstance
+# Context Instance
 
 ::: dotflow.core.context.ContextInstance
     options:

diff --git a/docs/nav/reference/dotflow-instance.md b/docs/nav/reference/dotflow-instance.md
@@ -0,0 +1,11 @@
+# Dotflow Instance
+
+::: dotflow.core.dotflow.DotflowInstance
+    options:
+        members:
+            - _plugins
+            - _workflow_id
+            - _task
+            - _add
+            - _start
+
diff --git a/docs/nav/reference/index.md b/docs/nav/reference/index.md
@@ -0,0 +1,3 @@
+# Reference
+
+Here's the reference or code API, the classes, functions, parameters, attributes, and all the **Dotflow** parts you can use in your applications.
diff --git a/docs/nav/reference/log-default.md b/docs/nav/reference/log-default.md
diff --git a/docs/nav/reference/logs-handler.md b/docs/nav/reference/logs-handler.md
@@ -0,0 +1,3 @@
+# Logs Handler
+
+::: dotflow.plugins.logs.LogsHandler
diff --git a/docs/nav/reference/metrics-handler.md b/docs/nav/reference/metrics-handler.md
@@ -0,0 +1,3 @@
+# Metrics Handler
+
+::: dotflow.plugins.metrics.MetricsHandler
diff --git a/docs/nav/reference/notify-default.md b/docs/nav/reference/notify-default.md
diff --git a/docs/nav/reference/notify-handler.md b/docs/nav/reference/notify-handler.md
@@ -0,0 +1,3 @@
+# Notify Handler
+
+::: dotflow.plugins.notify.NotifyHandler
diff --git a/docs/nav/reference/plugin.md b/docs/nav/reference/plugin.md
@@ -0,0 +1,3 @@
+# Plugin
+
+::: dotflow.core.plugin.Plugin
diff --git a/docs/nav/reference/storage-handler.md b/docs/nav/reference/storage-handler.md
@@ -0,0 +1,3 @@
+# Storage Handler
+
+::: dotflow.plugins.storage.StorageHandler
diff --git a/docs/nav/reference/storage-init.md b/docs/nav/reference/storage-init.md
diff --git a/docs/nav/reference/task-builder.md b/docs/nav/reference/task-builder.md
@@ -1,4 +1,4 @@
-# TaskBuilder
+# Task Builder
 
 ::: dotflow.core.task.TaskBuilder
     options:
@@ -7,3 +7,5 @@
             - count
             - clear
             - reverse
+            - schema
+            - result
diff --git a/docs/nav/reference/task-error.md b/docs/nav/reference/task-error.md
@@ -1,3 +1,3 @@
-# TaskError
+# Task Error
 
 ::: dotflow.core.task.TaskError
diff --git a/docs/nav/reference/task-instance.md b/docs/nav/reference/task-instance.md
@@ -1,4 +1,4 @@
-# TaskInstance
+# Task Instance
 
 ::: dotflow.core.task.TaskInstance
     options:
@@ -13,5 +13,4 @@
             - _duration 
             - _error 
             - _status 
-            - _config 
             - group_name
diff --git a/docs/nav/reference/type-execution.md b/docs/nav/reference/type-execution.md
@@ -1,6 +1,6 @@
-# TypeExecution
+# Execution Mode Type
 
-::: dotflow.core.types.execution.TypeExecution
+::: dotflow.core.types.execution.ExecutionModeType
     options:
         members:
             - SEQUENTIAL

diff --git a/docs/nav/reference/type-status.md b/docs/nav/reference/type-status.md
@@ -1,11 +1,11 @@
-# TypeStatus
+# Status Task Type
 
-::: dotflow.core.types.status.TypeStatus
+::: dotflow.core.types.status.StatusTaskType
     options:
         members:
-            - NOT_STARTED
+            - IN_QUEUE
             - IN_PROGRESS
-            - COMPLETED
+            - SUCCESS
             - PAUSED
             - RETRY
             - FAILED
diff --git a/docs_src/backoff/backoff.py b/docs_src/backoff/backoff.py
@@ -25,15 +25,15 @@ def run(self):
 def main():
     workflow = DotFlow()
 
-    workflow.task.add(step=simple_step)
+    workflow.add(step=simple_step)
     workflow.start()
     workflow.task.clear()
 
-    workflow.task.add(step=SimpleStepX)
+    workflow.add(step=SimpleStepX)
     workflow.start()
     workflow.task.clear()
 
-    workflow.task.add(step=SimpleStepY)
+    workflow.add(step=SimpleStepY)
     workflow.start()
     workflow.task.clear()
 

diff --git a/docs_src/callback/task_callback.py b/docs_src/callback/task_callback.py
@@ -1,14 +1,14 @@
 from dotflow import DotFlow, action, Task
-from dotflow.core.types.status import TypeStatus
+from dotflow.core.types.task import StatusTaskType
 
 
 def callback_one(task: Task):
-    assert task.status is TypeStatus.COMPLETED
+    assert task.status is StatusTaskType.SUCCESS
     print(task.task_id, task.status, task.current_context.storage)
 
 
 def callback_two(task: Task):
-    assert task.status is TypeStatus.FAILED
+    assert task.status is StatusTaskType.FAILED
     print(task.task_id, task.status, task.current_context.storage)
 
 
@@ -25,8 +25,8 @@ def simple_two():
 def main():
     workflow = DotFlow()
 
-    workflow.task.add(step=simple_one, callback=callback_one)
-    workflow.task.add(step=simple_two, callback=callback_two)
+    workflow.add(step=simple_one, callback=callback_one)
+    workflow.add(step=simple_two, callback=callback_two)
     workflow.start(keep_going=True)
 
     return workflow

diff --git a/docs_src/callback/workflow_callback_failure.py b/docs_src/callback/workflow_callback_failure.py
@@ -1,15 +1,15 @@
 from typing import List
 
 from dotflow import DotFlow, action, Task
-from dotflow.core.types.status import TypeStatus
+from dotflow.core.types.task import StatusTaskType
 
 
 def callback(tasks: List[Task]):
     assert tasks
     assert len(tasks)
 
     for task in tasks:
-        assert task.status is TypeStatus.FAILED
+        assert task.status is StatusTaskType.FAILED
         print(task.task_id, task.status, task.current_context.storage)
 
 
@@ -21,7 +21,7 @@ def simple_step():
 def main():
     workflow = DotFlow()
 
-    workflow.task.add(step=simple_step)
+    workflow.add(step=simple_step)
     workflow.start(on_failure=callback)
 
     return workflow

diff --git a/docs_src/callback/workflow_callback_success.py b/docs_src/callback/workflow_callback_success.py
@@ -1,15 +1,15 @@
 from typing import List
 
 from dotflow import DotFlow, action, Task
-from dotflow.core.types.status import TypeStatus
+from dotflow.core.types.task import StatusTaskType
 
 
 def callback(tasks: List[Task]):
     assert tasks
     assert len(tasks)
 
     for task in tasks:
-        assert task.status is TypeStatus.COMPLETED
+        assert task.status is StatusTaskType.SUCCESS
         print(task.task_id, task.status, task.current_context.storage)
 
 
@@ -21,7 +21,7 @@ def simple_step():
 def main():
     workflow = DotFlow()
 
-    workflow.task.add(step=simple_step)
+    workflow.add(step=simple_step)
     workflow.start(on_success=callback)
 
     return workflow

diff --git a/docs_src/cli/execution_mode.py b/docs_src/cli/execution_mode.py
@@ -0,0 +1,28 @@
+from os import system
+
+from dotflow import action
+
+
+@action
+def simple_step():
+    return "ok"
+
+
+def main():
+    """
+    COMMAND:
+        dotflow start --step docs_src.cli.execution_mode.simple_step --mode sequential
+        dotflow start --step docs_src.cli.execution_mode.simple_step --mode background
+
+    OUTPUT:
+        0000-00-00 00:00:00,000 - INFO [dotflow]: 0: 1c88c8d5-a456-46e6-98b9-ceee3d223c88 - In queue
+        0000-00-00 00:00:00,000 - INFO [dotflow]: 0: 1c88c8d5-a456-46e6-98b9-ceee3d223c88 - In progress
+        0000-00-00 00:00:00,000 - INFO [dotflow]: 0: 1c88c8d5-a456-46e6-98b9-ceee3d223c88 - Success
+    """
+
+    system("dotflow start --step docs_src.cli.execution_mode.simple_step --mode sequential")
+    system("dotflow start --step docs_src.cli.execution_mode.simple_step --mode background")
+
+
+if __name__ == "__main__":
+    main()
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Reference

		Here's the reference or code API, the classes, functions, parameters, attributes, and all the Dotflow parts you can use in your applications.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Logs Handler

		::: dotflow.plugins.logs.LogsHandler
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Metrics Handler

		::: dotflow.plugins.metrics.MetricsHandler
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Notify Handler

		::: dotflow.plugins.notify.NotifyHandler
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Storage Handler

		::: dotflow.plugins.storage.StorageHandler