dotflow 0.13.0.dev1__tar.gz → 0.13.0.dev2__tar.gz

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dotflow
-Version: 0.13.0.dev1
+Version: 0.13.0.dev2
 Summary: 🎲 Dotflow turns an idea into flow!
 License: MIT License
          
@@ -34,6 +34,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: mongodb
 Requires-Dist: dotflow-mongodb ; extra == "mongodb"
 Requires-Dist: pydantic
@@ -144,7 +145,7 @@ def my_callback(*args, **kwargs):
 def my_task_x():
     print("task")
 
-@action(retry=5)
+@action
 def my_task_y():
     print("task")
 
@@ -158,7 +159,7 @@ workflow.start()
 
 ## First Steps
 
-#### Import
+#### 1. Import
 
 Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action/))
 
@@ -166,7 +167,7 @@ Start with the basics, which is importing the necessary classes and methods. ([D
 from dotflow import DotFlow, action
 ```
 
-#### Callback function
+#### 2. Callback function
 
 Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_callback)
 
@@ -175,17 +176,17 @@ def my_callback(*args, **kwargs):
     print(args, kwargs)
 ```
 
-#### Task function
+#### 3. Task function
 
-Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_function)
+Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task.
 
 ```python
-@action(retry=5)
+@action
 def my_task_x():
     print("task")
 ```
 
-#### DotFlow Class
+#### 4. DotFlow Class
 
 Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/).
 
@@ -193,7 +194,7 @@ Instantiate the DotFlow class in a `workflow` variable to be used in the followi
 workflow = DotFlow()
 ```
 
-#### Add Task
+#### 5. Add Task
 
 Now, simply add the `my_task_x` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow. [More details](https://dotflow-io.github.io/dotflow/nav/reference/task-builder/#dotflow.core.task.TaskBuilder.add)
 
@@ -216,7 +217,7 @@ workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
 workflow.task.add(step="module.task.my_task_x", callback=my_callback)
 ```
 
-#### Start
+#### 6. Start
 
 Finally, just execute the workflow with the following code snippet. [More details](https://dotflow-io.github.io/dotflow/nav/reference/workflow/#dotflow.core.workflow.Manager)
 
@@ -358,37 +359,43 @@ flowchart TD
 
 ## More Examples
 
-| Example                                                                                                                          | Command                                                                                                        |
-| -------------------------------------------------------------------------------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------|
-| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py)                                     | `dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback`   |
-| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py)                       | `dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc`                     |
-| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py)                                             | `dotflow start --step examples.cli_with_mode.simple_step --mode sequential`                                    |
-| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py)                         | `dotflow start --step examples.cli_with_output_context.simple_step --storage file`                             |
-| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py)                                             | `dotflow start --step examples.cli_with_path.simple_step --path .storage --storage file`                       |
-| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py)                                                   | `dotflow start --step examples.simple_cli.simple_step`                                                         |
-| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py)                             | `python examples/simple_class_workflow.py`                                                                     |
-| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) | `python examples/simple_function_workflow_with_error.py`                                                       |
-| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py)                       | `python examples/simple_function_workflow.py`                                                                  |
-| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py)                     | `python examples/step_class_result_context.py`                                                                 |
-| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py)                     | `python examples/step_class_result_storage.py`                                                                 |
-| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py)                           | `python examples/step_class_result_task.py`                                                                    |
-| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py)               | `python examples/step_function_result_context.py`                                                              |
-| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py)               | `python examples/step_function_result_storage.py`                                                              |
-| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py)                     | `python examples/step_function_result_task.py`                                                                 |
-| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py)                     | `python examples/step_with_initial_context.py`                                                                 |
-| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py)                         | `python examples/step_with_many_contexts.py`                                                                   |
-| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py)                   | `python examples/step_with_previous_context.py`                                                                |
-| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py)                       | `python examples/workflow_keep_going_true.py`                                                                  |
-| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py)                           | `python examples/workflow_step_callback.py`                                                                    |
-| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py)           | `python examples/workflow_with_callback_failure.py`                                                            |
-| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py)           | `python examples/workflow_with_callback_success.py`                                                            |
-| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py)                                 | `python examples/workflow_with_retry.py`                                                                       |
-| [step_with_groups](https://github.com/dotflow-io/examples/blob/master/step_with_groups.py)                                       | `python examples/step_with_groups.py`                                                                          |
-| [workflow_background_mode](https://github.com/dotflow-io/examples/blob/master/workflow_background_mode.py)                       | `python examples/workflow_background_mode.py`                                                                  |
-| [workflow_parallel_mode](https://github.com/dotflow-io/examples/blob/master/workflow_parallel_mode.py)                           | `python examples/workflow_parallel_mode.py`                                                                    |
-| [workflow_sequential_group_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_group_mode.py)           | `python examples/workflow_sequential_group_mode.py`                                                            |
-| [workflow_sequential_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_mode.py)                       | `python examples/workflow_sequential_mode.py`                                                                  |
-
+| Example | Command |
+| ------- | ------- |
+| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py) | `dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback` |
+| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py) | `dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc` |
+| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py) | `dotflow start --step examples.cli_with_mode.simple_step --mode sequential` |
+| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py) | `dotflow start --step examples.cli_with_output_context.simple_step --storage file` |
+| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py) | `dotflow start --step examples.cli_with_path.simple_step --path .storage --storage file` |
+| [flow](https://github.com/dotflow-io/examples/blob/master/flow.py) | `python examples/flow.py` |
+| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py) | `python examples/simple_class_workflow.py` |
+| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py) | `dotflow start --step examples.simple_cli.simple_step` |
+| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py) | `python examples/simple_function_workflow.py` |
+| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) | `python examples/simple_function_workflow_with_error.py` |
+| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py) | `python examples/step_class_result_context.py` |
+| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py) | `python examples/step_class_result_storage.py` |
+| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py) | `python examples/step_class_result_task.py` |
+| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py) | `python examples/step_function_result_context.py` |
+| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py) | `python examples/step_function_result_storage.py` |
+| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py) | `python examples/step_function_result_task.py` |
+| [step_with_groups](https://github.com/dotflow-io/examples/blob/master/step_with_groups.py) | `python examples/step_with_groups.py` |
+| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py) | `python examples/step_with_initial_context.py` |
+| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py) | `python examples/step_with_many_contexts.py` |
+| [step_with_notify_telegram](https://github.com/dotflow-io/examples/blob/master/step_with_notify_telegram.py) | `python examples/step_with_notify_telegram.py` |
+| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py) | `python examples/step_with_previous_context.py` |
+| [step_with_storage_file](https://github.com/dotflow-io/examples/blob/master/step_with_storage_file.py) | `python examples/step_with_storage_file.py` |
+| [step_with_storage_mongodb](https://github.com/dotflow-io/examples/blob/master/step_with_storage_mongodb.py) | `python examples/step_with_storage_mongodb.py` |
+| [workflow_background_mode](https://github.com/dotflow-io/examples/blob/master/workflow_background_mode.py) | `python examples/workflow_background_mode.py` |
+| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py) | `python examples/workflow_keep_going_true.py` |
+| [workflow_parallel_mode](https://github.com/dotflow-io/examples/blob/master/workflow_parallel_mode.py) | `python examples/workflow_parallel_mode.py` |
+| [workflow_sequential_group_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_group_mode.py) | `python examples/workflow_sequential_group_mode.py` |
+| [workflow_sequential_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_mode.py) | `python examples/workflow_sequential_mode.py` |
+| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py) | `python examples/workflow_step_callback.py` |
+| [workflow_with_backoff](https://github.com/dotflow-io/examples/blob/master/workflow_with_backoff.py) | `python examples/workflow_with_backoff.py` |
+| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py) | `python examples/workflow_with_callback_failure.py` |
+| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py) | `python examples/workflow_with_callback_success.py` |
+| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py) | `python examples/workflow_with_retry.py` |
+| [workflow_with_retry_delay](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry_delay.py) | `python examples/workflow_with_retry_delay.py` |
+| [workflow_with_timeout](https://github.com/dotflow-io/examples/blob/master/workflow_with_timeout.py) | `python examples/workflow_with_timeout.py` |
 
 ## Commit Style
 

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/README.md

@@ -96,7 +96,7 @@ def my_callback(*args, **kwargs):
 def my_task_x():
     print("task")
 
-@action(retry=5)
+@action
 def my_task_y():
     print("task")
 
@@ -110,7 +110,7 @@ workflow.start()
 
 ## First Steps
 
-#### Import
+#### 1. Import
 
 Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action/))
 
@@ -118,7 +118,7 @@ Start with the basics, which is importing the necessary classes and methods. ([D
 from dotflow import DotFlow, action
 ```
 
-#### Callback function
+#### 2. Callback function
 
 Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_callback)
 
@@ -127,17 +127,17 @@ def my_callback(*args, **kwargs):
     print(args, kwargs)
 ```
 
-#### Task function
+#### 3. Task function
 
-Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_function)
+Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task.
 
 ```python
-@action(retry=5)
+@action
 def my_task_x():
     print("task")
 ```
 
-#### DotFlow Class
+#### 4. DotFlow Class
 
 Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/).
 
@@ -145,7 +145,7 @@ Instantiate the DotFlow class in a `workflow` variable to be used in the followi
 workflow = DotFlow()
 ```
 
-#### Add Task
+#### 5. Add Task
 
 Now, simply add the `my_task_x` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow. [More details](https://dotflow-io.github.io/dotflow/nav/reference/task-builder/#dotflow.core.task.TaskBuilder.add)
 
@@ -168,7 +168,7 @@ workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
 workflow.task.add(step="module.task.my_task_x", callback=my_callback)
 ```
 
-#### Start
+#### 6. Start
 
 Finally, just execute the workflow with the following code snippet. [More details](https://dotflow-io.github.io/dotflow/nav/reference/workflow/#dotflow.core.workflow.Manager)
 
@@ -310,37 +310,43 @@ flowchart TD
 
 ## More Examples
 
-| Example                                                                                                                          | Command                                                                                                        |
-| -------------------------------------------------------------------------------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------|
-| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py)                                     | `dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback`   |
-| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py)                       | `dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc`                     |
-| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py)                                             | `dotflow start --step examples.cli_with_mode.simple_step --mode sequential`                                    |
-| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py)                         | `dotflow start --step examples.cli_with_output_context.simple_step --storage file`                             |
-| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py)                                             | `dotflow start --step examples.cli_with_path.simple_step --path .storage --storage file`                       |
-| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py)                                                   | `dotflow start --step examples.simple_cli.simple_step`                                                         |
-| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py)                             | `python examples/simple_class_workflow.py`                                                                     |
-| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) | `python examples/simple_function_workflow_with_error.py`                                                       |
-| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py)                       | `python examples/simple_function_workflow.py`                                                                  |
-| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py)                     | `python examples/step_class_result_context.py`                                                                 |
-| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py)                     | `python examples/step_class_result_storage.py`                                                                 |
-| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py)                           | `python examples/step_class_result_task.py`                                                                    |
-| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py)               | `python examples/step_function_result_context.py`                                                              |
-| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py)               | `python examples/step_function_result_storage.py`                                                              |
-| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py)                     | `python examples/step_function_result_task.py`                                                                 |
-| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py)                     | `python examples/step_with_initial_context.py`                                                                 |
-| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py)                         | `python examples/step_with_many_contexts.py`                                                                   |
-| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py)                   | `python examples/step_with_previous_context.py`                                                                |
-| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py)                       | `python examples/workflow_keep_going_true.py`                                                                  |
-| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py)                           | `python examples/workflow_step_callback.py`                                                                    |
-| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py)           | `python examples/workflow_with_callback_failure.py`                                                            |
-| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py)           | `python examples/workflow_with_callback_success.py`                                                            |
-| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py)                                 | `python examples/workflow_with_retry.py`                                                                       |
-| [step_with_groups](https://github.com/dotflow-io/examples/blob/master/step_with_groups.py)                                       | `python examples/step_with_groups.py`                                                                          |
-| [workflow_background_mode](https://github.com/dotflow-io/examples/blob/master/workflow_background_mode.py)                       | `python examples/workflow_background_mode.py`                                                                  |
-| [workflow_parallel_mode](https://github.com/dotflow-io/examples/blob/master/workflow_parallel_mode.py)                           | `python examples/workflow_parallel_mode.py`                                                                    |
-| [workflow_sequential_group_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_group_mode.py)           | `python examples/workflow_sequential_group_mode.py`                                                            |
-| [workflow_sequential_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_mode.py)                       | `python examples/workflow_sequential_mode.py`                                                                  |
-
+| Example | Command |
+| ------- | ------- |
+| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py) | `dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback` |
+| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py) | `dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc` |
+| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py) | `dotflow start --step examples.cli_with_mode.simple_step --mode sequential` |
+| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py) | `dotflow start --step examples.cli_with_output_context.simple_step --storage file` |
+| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py) | `dotflow start --step examples.cli_with_path.simple_step --path .storage --storage file` |
+| [flow](https://github.com/dotflow-io/examples/blob/master/flow.py) | `python examples/flow.py` |
+| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py) | `python examples/simple_class_workflow.py` |
+| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py) | `dotflow start --step examples.simple_cli.simple_step` |
+| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py) | `python examples/simple_function_workflow.py` |
+| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) | `python examples/simple_function_workflow_with_error.py` |
+| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py) | `python examples/step_class_result_context.py` |
+| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py) | `python examples/step_class_result_storage.py` |
+| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py) | `python examples/step_class_result_task.py` |
+| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py) | `python examples/step_function_result_context.py` |
+| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py) | `python examples/step_function_result_storage.py` |
+| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py) | `python examples/step_function_result_task.py` |
+| [step_with_groups](https://github.com/dotflow-io/examples/blob/master/step_with_groups.py) | `python examples/step_with_groups.py` |
+| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py) | `python examples/step_with_initial_context.py` |
+| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py) | `python examples/step_with_many_contexts.py` |
+| [step_with_notify_telegram](https://github.com/dotflow-io/examples/blob/master/step_with_notify_telegram.py) | `python examples/step_with_notify_telegram.py` |
+| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py) | `python examples/step_with_previous_context.py` |
+| [step_with_storage_file](https://github.com/dotflow-io/examples/blob/master/step_with_storage_file.py) | `python examples/step_with_storage_file.py` |
+| [step_with_storage_mongodb](https://github.com/dotflow-io/examples/blob/master/step_with_storage_mongodb.py) | `python examples/step_with_storage_mongodb.py` |
+| [workflow_background_mode](https://github.com/dotflow-io/examples/blob/master/workflow_background_mode.py) | `python examples/workflow_background_mode.py` |
+| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py) | `python examples/workflow_keep_going_true.py` |
+| [workflow_parallel_mode](https://github.com/dotflow-io/examples/blob/master/workflow_parallel_mode.py) | `python examples/workflow_parallel_mode.py` |
+| [workflow_sequential_group_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_group_mode.py) | `python examples/workflow_sequential_group_mode.py` |
+| [workflow_sequential_mode](https://github.com/dotflow-io/examples/blob/master/workflow_sequential_mode.py) | `python examples/workflow_sequential_mode.py` |
+| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py) | `python examples/workflow_step_callback.py` |
+| [workflow_with_backoff](https://github.com/dotflow-io/examples/blob/master/workflow_with_backoff.py) | `python examples/workflow_with_backoff.py` |
+| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py) | `python examples/workflow_with_callback_failure.py` |
+| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py) | `python examples/workflow_with_callback_success.py` |
+| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py) | `python examples/workflow_with_retry.py` |
+| [workflow_with_retry_delay](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry_delay.py) | `python examples/workflow_with_retry_delay.py` |
+| [workflow_with_timeout](https://github.com/dotflow-io/examples/blob/master/workflow_with_timeout.py) | `python examples/workflow_with_timeout.py` |
 
 ## Commit Style
 

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/__init__.py

@@ -1,6 +1,6 @@
 """Dotflow __init__ module."""
 
-__version__ = "0.13.0.dev1"
+__version__ = "0.13.0.dev2"
 __description__ = "🎲 Dotflow turns an idea into flow!"
 
 from .core.action import Action as action

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/action.py

@@ -42,14 +42,38 @@ class Action(object):
             def my_task():
                 print("task")
 
+
+        With Timeout
+
+            @action(timeout=60)
+            def my_task():
+                print("task")
+
+        With Retry delay
+
+            @action(retry=5, retry_delay=5)
+            def my_task():
+                print("task")
+
+        With Backoff
+
+            @action(retry=5, backoff=True)
+            def my_task():
+                print("task")
+
     Args:
         func (Callable):
 
         task (Callable):
 
-        retry (int):
-            Integer-type argument referring to the number of retry attempts
-            the function will execute in case of failure.
+        retry (int): Number of task retries on on_failure.
+
+        timeout (int): Execution timeout for a task. Duration (in seconds)
+
+        retry_delay (int): Retry delay on task on_failure. Duration (in seconds)
+
+        backoff (int): Exponential backoff
+
     """
 
     def __init__(

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/config.py

@@ -17,6 +17,7 @@ class Config:
         You can import the **Config** class with:
 
             from dotflow import Config
+
             from dotflow.providers import (
                 StorageDefault,
                 NotifyDefault,
@@ -45,10 +46,10 @@ class Config:
 
     def __init__(
         self,
-        storage: Optional[Storage] = None,
-        notify: Optional[Notify] = None,
-        log: Optional[Log] = None,
+        storage: Optional[Storage] = StorageDefault(),
+        notify: Optional[Notify] = NotifyDefault(),
+        log: Optional[Log] = LogDefault(),
     ) -> None:
-        self.storage = storage if storage else StorageDefault()
-        self.notify = notify if notify else NotifyDefault()
-        self.log = log if log else LogDefault()
+        self.storage = storage
+        self.notify = notify
+        self.log = log

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/dotflow.py

@@ -15,7 +15,7 @@ class DotFlow:
         You can import the **Dotflow** class directly from dotflow:
 
             from dotflow import DotFlow, Config
-            from dotflow.storage import StorageFile
+            from dotflow.providers import StorageFile
 
     Example:
         `class` dotflow.core.dotflow.Dotflow

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/execution.py

@@ -106,14 +106,15 @@ class Execution:
             callable_list=callable_list, class_instance=class_instance
         )
 
-        for _, new in ordered_list:
-            new_object = getattr(class_instance, new)
+        for index, new in enumerate(ordered_list):
+            new_object = getattr(class_instance, new[1])
             try:
                 subcontext = new_object(
                     initial_context=self.task.initial_context,
                     previous_context=previous_context,
                     task=self.task,
                 )
+                subcontext.task_id = index
                 new_context.storage.append(subcontext)
                 previous_context = subcontext
 
@@ -127,6 +128,7 @@ class Execution:
                     previous_context=previous_context,
                     task=self.task,
                 )
+                subcontext.task_id = index
                 new_context.storage.append(subcontext)
                 previous_context = subcontext
 

dotflow-0.13.0.dev2/dotflow/core/serializers/task.py

@@ -0,0 +1,83 @@
+"""Task serializer module"""
+
+import json
+
+from typing import Any, Optional
+from uuid import UUID
+
+from pydantic import BaseModel, Field, ConfigDict, field_validator
+
+from dotflow.core.context import Context
+
+
+class SerializerTaskError(BaseModel):
+
+    traceback: str
+    message: str
+
+
+class SerializerTask(BaseModel):
+    model_config = ConfigDict(title="task")
+
+    task_id: int = Field(default=None)
+    workflow_id: Optional[UUID] = Field(default=None)
+    status: str = Field(default=None, alias="_status")
+    error: Optional[SerializerTaskError] = Field(default=None, alias="_error")
+    duration: Optional[float] = Field(default=None, alias="_duration")
+    initial_context: Any = Field(default=None, alias="_initial_context")
+    current_context: Any = Field(default=None, alias="_current_context")
+    previous_context: Any = Field(default=None, alias="_previous_context")
+    group_name: str = Field(default=None)
+    max: Optional[int] = Field(default=None, exclude=True)
+    size_message: Optional[str] = Field(default="Context size exceeded", exclude=True)
+
+    def model_dump_json(self, **kwargs) -> str:
+        dump_json = super().model_dump_json(serialize_as_any=True, **kwargs)
+
+        if self.max and len(dump_json) > self.max:
+            self.initial_context = self.size_message
+            self.current_context = self.size_message
+            self.previous_context = self.size_message
+
+            dump_json = super().model_dump_json(serialize_as_any=True, **kwargs)
+
+            return dump_json[0:self.max]
+
+        return dump_json
+
+    @field_validator("error", mode="before")
+    @classmethod
+    def error_validator(cls, value: str) -> str:
+        if value:
+            return SerializerTaskError(**value.__dict__)
+        return None
+
+    @field_validator(
+        "initial_context", "current_context", "previous_context", mode="before"
+    )
+    @classmethod
+    def context_validator(cls, value: str) -> str:
+        if value and value.storage:
+            context = cls.context_loop(value=value)
+            return context
+        return None
+
+    @classmethod
+    def format_context(cls, value):
+        try:
+            return json.dumps(value.storage)
+        except TypeError:
+            return str(value.storage)
+
+    @classmethod
+    def context_loop(cls, value):
+        if isinstance(value.storage, list):
+            contexts = {}
+            if any(isinstance(context, Context) for context in value.storage):
+                for context in value.storage:
+                    if isinstance(context, Context):
+                        contexts[context.task_id] = cls.context_loop(context)
+                    else:
+                        contexts[context.task_id] = cls.format_context(context)
+            return contexts
+        return cls.format_context(value=value)

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/task.py

@@ -228,13 +228,11 @@ class Task(TaskInstance):
     def config(self, value: Config):
         self._config = value
 
-    def schema(self) -> SerializerTask:
-        return SerializerTask(
-            **self.__dict__
-        )
+    def schema(self, max: int = None) -> SerializerTask:
+        return SerializerTask(**self.__dict__, max=max)
 
-    def result(self) -> SerializerWorkflow:
-        item = self.schema().model_dump_json()
+    def result(self, max: int = None) -> SerializerWorkflow:
+        item = self.schema(max=max).model_dump_json()
         return json.loads(item)
 
 

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/core/workflow.py

@@ -47,8 +47,8 @@ class Manager:
 
             workflow = Manager(
                 tasks=[tasks],
-                success=basic_callback,
-                failure=basic_callback,
+                on_success=basic_callback,
+                on_failure=basic_callback,
                 keep_going=True
             )
 
@@ -56,11 +56,11 @@ class Manager:
         tasks (List[Task]):
             A list containing objects of type Task.
 
-        success (Callable):
+        on_success (Callable):
             Success function to be executed after the completion of the entire
             workflow. It's essentially a callback for successful scenarios.
 
-        failure (Callable):
+        on_failure (Callable):
             Failure function to be executed after the completion of the entire
             workflow. It's essentially a callback for error scenarios
 
@@ -76,27 +76,30 @@ class Manager:
             execution of a task. If it is **true**, the execution will continue;
             if it is **False**, the workflow will stop.
 
-        workflow_id (UUID):
+        workflow_id (UUID): Workflow ID.
 
     Attributes:
-        success (Callable):
-        failure (Callable):
+        on_success (Callable):
+
+        on_failure (Callable):
+
         workflow_id (UUID):
+
         started (datetime):
     """
 
     def __init__(
         self,
         tasks: List[Task],
-        success: Callable = basic_callback,
-        failure: Callable = basic_callback,
+        on_success: Callable = basic_callback,
+        on_failure: Callable = basic_callback,
         mode: TypeExecution = TypeExecution.SEQUENTIAL,
         keep_going: bool = False,
         workflow_id: UUID = None,
     ) -> None:
         self.tasks = tasks
-        self.success = success
-        self.failure = failure
+        self.on_success = on_success
+        self.on_failure = on_failure
         self.workflow_id = workflow_id or uuid4()
         self.started = datetime.now()
 
@@ -118,9 +121,9 @@ class Manager:
         final_status = [task.status for task in tasks]
 
         if TypeStatus.FAILED in final_status:
-            self.failure(tasks=tasks)
+            self.on_failure(tasks=tasks)
         else:
-            self.success(tasks=tasks)
+            self.on_success(tasks=tasks)
 
     def sequential(self, **kwargs) -> List[Task]:
         if len(kwargs.get("groups", {})) > 1 and not is_darwin():

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/dotflow/providers/notify_telegram.py

@@ -9,21 +9,23 @@ from dotflow.core.types.status import TypeStatus
 from dotflow.abc.notify import Notify
 from dotflow.logging import logger
 
-MESSAGE = "{symbol} {status}\n```json\n{task}```\n{workflow_id}-{task_id}"
-API_TELEGRAM = "https://api.telegram.org/bot{token}/sendMessage"
-
 
 class NotifyTelegram(Notify):
 
+    MESSAGE = "{symbol} {status}\n```json\n{task}```\n{workflow_id}-{task_id}"
+    API_TELEGRAM = "https://api.telegram.org/bot{token}/sendMessage"
+
     def __init__(
         self,
         token: str,
         chat_id: int,
-        notification_type: Optional[TypeStatus] = None
+        notification_type: Optional[TypeStatus] = None,
+        timeout: int = 1.5
     ):
         self.token = token
         self.chat_id = chat_id
         self.notification_type = notification_type
+        self.timeout = timeout
 
     def send(self, task: Any) -> None:
         if not self.notification_type or self.notification_type == task.status:
@@ -34,10 +36,10 @@ class NotifyTelegram(Notify):
             }
             try:
                 response = post(
-                    url=API_TELEGRAM.format(token=self.token),
+                    url=self.API_TELEGRAM.format(token=self.token),
                     headers={"Content-Type": "application/json"},
                     data=dumps(data),
-                    timeout=5
+                    timeout=self.timeout
                 )
                 response.raise_for_status()
             except Exception as error:
@@ -47,10 +49,10 @@ class NotifyTelegram(Notify):
                 )
 
     def _get_text(self, task: Any) -> str:
-        return MESSAGE.format(
+        return self.MESSAGE.format(
             symbol=TypeStatus.get_symbol(task.status),
             status=task.status,
             workflow_id=task.workflow_id,
             task_id=task.task_id,
-            task=task.result(),
+            task=task.result(max=4000),
         )

{dotflow-0.13.0.dev1 → dotflow-0.13.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dotflow"
-version = "0.13.0.dev1"
+version = "0.13.0.dev2"
 authors = [
   { name="Fernando Celmer", email="email@fernandocelmer.com" },
 ]
@@ -23,6 +23,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
 ]
 
 [project.urls]
@@ -36,7 +37,7 @@ mongodb = ["dotflow-mongodb"]
 
 [tool.poetry]
 name = "dotflow"
-version = "0.13.0.dev1"
+version = "0.13.0.dev2"
 description = "🎲 Dotflow turns an idea into flow!"
 authors = ["Fernando Celmer <email@fernandocelmer.com>"]
 readme = "README.md"
@@ -54,6 +55,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
 ]
 
 [tool.poetry.scripts]
@@ -79,9 +81,11 @@ pyzmq = "^26.2.1"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.6.1"
-mkdocs-simple-blog = "^0.1.0"
 mkdocstrings = {extras = ["python"], version = "^0.29.0"}
 griffe-typingdoc = "^0.2.8"
+mike = "^2.1.3"
+mkdocs-simple-blog = "0.2.0"
+mkdocs-material = "^9.6.13"
 
 
 [[tool.poetry.source]]

dotflow-0.13.0.dev1/dotflow/core/serializers/task.py

@@ -1,47 +0,0 @@
-"""Task serializer module"""
-
-import json
-
-from typing import Any, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, Field, ConfigDict, field_validator  # type: ignore
-
-
-class SerializerTaskError(BaseModel):
-
-    traceback: str
-    message: str
-
-
-class SerializerTask(BaseModel):
-    model_config = ConfigDict(title="task")
-
-    task_id: int = Field(default=None)
-    workflow_id: Optional[UUID] = Field(default=None)
-    status: str = Field(default=None, alias="_status")
-    error: Optional[SerializerTaskError] = Field(default=None, alias="_error")
-    duration: Optional[float] = Field(default=None, alias="_duration")
-    initial_context: Any = Field(default=None, alias="_initial_context")
-    current_context: Any = Field(default=None, alias="_current_context")
-    previous_context: Any = Field(default=None, alias="_previous_context")
-    group_name: str = Field(default=None)
-
-    @field_validator("error", mode="before")
-    @classmethod
-    def error_validator(cls, value: str) -> str:
-        if value:
-            return SerializerTaskError(**value.__dict__)
-        return None
-
-    @field_validator(
-        "initial_context", "current_context", "previous_context", mode="before"
-    )
-    @classmethod
-    def context_validator(cls, value: str) -> str:
-        if value and value.storage:
-            try:
-                return json.dumps(value.storage)
-            except Exception:
-                return str(value)
-        return None