dotflow 0.10.0.dev2__tar.gz → 0.11.1.dev1__tar.gz

{dotflow-0.10.0.dev2 → dotflow-0.11.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dotflow
-Version: 0.10.0.dev2
+Version: 0.11.1.dev1
 Summary: 🎲 Dotflow turns an idea into flow!
 License: MIT License
          
@@ -45,7 +45,17 @@ Project-URL: Issues, https://github.com/dotflow-io/dotflow/issues
 Project-URL: Repository, https://github.com/dotflow-io/dotflow
 Description-Content-Type: text/markdown
 
-# Welcome to dotflow
+<div align="center">
+  <a aria-label="Serverless.com" href="https://dotflow.io">Website</a>
+  &nbsp;•&nbsp;
+  <a aria-label="Dotglow Documentation" href="https://dotflow-io.github.io/dotflow/">Documentation</a>
+  &nbsp;•&nbsp;
+  <a aria-label="Pypi" href="https://pypi.org/project/dotflow/">Pypi</a>
+</div>
+
+<br/>
+
+<div align="center">
 
 ![](https://raw.githubusercontent.com/FernandoCelmer/dotflow/master/docs/assets/dotflow.gif)
 
@@ -55,10 +65,43 @@ Description-Content-Type: text/markdown
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dotflow?style=flat-square)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/dotflow?style=flat-square)
 
-This is a very simple library that is still in the early stages of development. The main goal of this tool is to create a simple and secure workflow for executing any type of task. The library's API design was made to make it easy to add tasks and control their execution. To keep it simple, just instantiate the `DotFlow` class, use the `add` method, and the `start` method to begin execution.
+</div>
+
+# Welcome to dotflow
+
+With Dotflow, you get a powerful and easy-to-use library designed to create execution pipelines without complication. Add tasks intuitively and control the entire process with just a few commands.
+
+Our goal is to make task management faster and more secure, without overwhelming you with complexity. Simply instantiate the DotFlow class, add your tasks with the `add` method, and start execution with the `start` method.
 
 Start with the basics [here](https://dotflow-io.github.io/dotflow/nav/getting-started/).
 
+## Table of Contents
+
+<details>
+<summary>Click to expand</summary>
+
+- [Getting Help](#getting-help)
+- [Getting Started](#getting-started)
+    - [Install](#install)
+- [A Simple Example](#a-simple-example)
+- [First Steps](#first-steps)
+    - [Import](#import)
+    - [Callback function](#callback-function)
+    - [Task function](#task-function)
+    - [DotFlow Class](#dotflow-class)
+    - [Add Task](#add-task)
+    - [Start](#start)
+- [CLI](#cli)
+    - [Simple Start](#simple-start)
+    - [With Initial Context](#with-initial-context)
+    - [With Callback](#with-callback)
+    - [With Mode](#with-mode)
+- [More Examples](#more-examples)
+- [Commit Style](#commit-style)
+- [License](#license)
+
+</details>
+
 ## Getting Help
 
 We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.
@@ -96,18 +139,25 @@ from dotflow import DotFlow, action
 def my_callback(*args, **kwargs):
     print(args, kwargs)
 
+@action
+def my_task_x():
+    print("task")
+
 @action(retry=5)
-def my_task():
+def my_task_y():
     print("task")
 
 workflow = DotFlow()
-workflow.task.add(step=my_task, callback=my_callback)
+
+workflow.task.add(step=my_task_x, callback=my_callback)
+workflow.task.add(step=my_task_y, callback=my_callback)
+
 workflow.start()
 ```
 
 ## First Steps
 
-#### 1 - Import
+#### 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/))
 
@@ -115,7 +165,7 @@ Start with the basics, which is importing the necessary classes and methods. ([D
 from dotflow import DotFlow, action
 ```
 
-#### 2 - Callback function
+#### 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)
 
@@ -124,17 +174,17 @@ def my_callback(*args, **kwargs):
     print(args, kwargs)
 ```
 
-#### 3 - Task function
+#### 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)
 
 ```python
 @action(retry=5)
-def my_task():
+def my_task_x():
     print("task")
 ```
 
-#### 4 - DotFlow Class
+#### 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/).
 
@@ -142,15 +192,30 @@ Instantiate the DotFlow class in a `workflow` variable to be used in the followi
 workflow = DotFlow()
 ```
 
-#### 5 - Add Task
+#### 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)
+
+- 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)
+```
+
+- Adding multiple steps at the same time:
+
+```python
+workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
+```
 
-Now, simply add the `my_task` 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)
+- Adding a step with the module path:
 
 ```python
-workflow.task.add(step=my_task, callback=my_callback)
+workflow.task.add(step="module.task.my_task_x", callback=my_callback)
 ```
 
-#### 6 - Start
+#### 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.Workflow)
 
@@ -158,33 +223,63 @@ Finally, just execute the workflow with the following code snippet. [More detail
 workflow.start()
 ```
 
+## CLI
+
+#### Simple Start
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step
+```
+
+#### With Initial Context
+
+```bash
+dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc
+```
+
+#### With Callback
+
+```bash
+dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback
+```
+
+#### With Mode
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step --mode sequential
+```
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step --mode background
+```
+
 ## More Examples
 
-|  | Example                                                                                                                                  |
-|--| ---------------------------------------------------------------------------------------------------------------------------------------- |
-|01| [cli_with_callback](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_callback.py)                                     |
-|02| [cli_with_initial_context](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_initial_context.py)                       |
-|03| [cli_with_mode](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_mode.py)                                             |
-|04| [cli_with_output_context](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_output_context.py)                         |
-|05| [cli_with_path](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_path.py)                                             |
-|06| [simple_cli](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_cli.py)                                                                 |
-|07| [simple_class_workflow](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_class_workflow.py)                             |
-|08| [simple_function_workflow_with_error](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_function_workflow_with_error.py) |
-|09| [simple_function_workflow](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_function_workflow.py)                       |
-|10| [step_class_result_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_context.py)                     |
-|11| [step_class_result_storage](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_storage.py)                     |
-|12| [step_class_result_task](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_task.py)                           |
-|13| [step_function_result_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_context.py)               |
-|14| [step_function_result_storage](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_storage.py)               |
-|15| [step_function_result_task](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_task.py)                     |
-|16| [step_with_initial_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_initial_context.py)                     |
-|17| [step_with_many_contexts](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_many_contexts.py)                         |
-|18| [step_with_previous_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_previous_context.py)                   |
-|19| [workflow_keep_going_true](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_keep_going_true.py)                       |
-|20| [workflow_step_callback](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_step_callback.py)                           |
-|21| [workflow_with_callback_failure](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_callback_failure.py)           |
-|22| [workflow_with_callback_success](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_callback_success.py)           |
-|23| [workflow_with_retry](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_retry.py)                                 |
+|  | Example                                                                                                                          |
+|--| -------------------------------------------------------------------------------------------------------------------------------- |
+|01| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py)                                     |
+|02| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py)                       |
+|03| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py)                                             |
+|04| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py)                         |
+|05| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py)                                             |
+|06| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py)                                                   |
+|07| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py)                             |
+|08| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) |
+|09| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py)                       |
+|10| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py)                     |
+|11| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py)                     |
+|12| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py)                           |
+|13| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py)               |
+|14| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py)               |
+|15| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py)                     |
+|16| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py)                     |
+|17| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py)                         |
+|18| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py)                   |
+|19| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py)                       |
+|20| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py)                           |
+|21| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py)           |
+|22| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py)           |
+|23| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py)                                 |
 
 ## Commit Style
 

dotflow-0.11.1.dev1/README.md

@@ -0,0 +1,252 @@
+<div align="center">
+  <a aria-label="Serverless.com" href="https://dotflow.io">Website</a>
+  &nbsp;•&nbsp;
+  <a aria-label="Dotglow Documentation" href="https://dotflow-io.github.io/dotflow/">Documentation</a>
+  &nbsp;•&nbsp;
+  <a aria-label="Pypi" href="https://pypi.org/project/dotflow/">Pypi</a>
+</div>
+
+<br/>
+
+<div align="center">
+
+![](https://raw.githubusercontent.com/FernandoCelmer/dotflow/master/docs/assets/dotflow.gif)
+
+![GitHub Org's stars](https://img.shields.io/github/stars/dotflow-io?label=Dotflow&style=flat-square)
+![GitHub last commit](https://img.shields.io/github/last-commit/dotflow-io/dotflow?style=flat-square)
+![PyPI](https://img.shields.io/pypi/v/dotflow?style=flat-square)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dotflow?style=flat-square)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/dotflow?style=flat-square)
+
+</div>
+
+# Welcome to dotflow
+
+With Dotflow, you get a powerful and easy-to-use library designed to create execution pipelines without complication. Add tasks intuitively and control the entire process with just a few commands.
+
+Our goal is to make task management faster and more secure, without overwhelming you with complexity. Simply instantiate the DotFlow class, add your tasks with the `add` method, and start execution with the `start` method.
+
+Start with the basics [here](https://dotflow-io.github.io/dotflow/nav/getting-started/).
+
+## Table of Contents
+
+<details>
+<summary>Click to expand</summary>
+
+- [Getting Help](#getting-help)
+- [Getting Started](#getting-started)
+    - [Install](#install)
+- [A Simple Example](#a-simple-example)
+- [First Steps](#first-steps)
+    - [Import](#import)
+    - [Callback function](#callback-function)
+    - [Task function](#task-function)
+    - [DotFlow Class](#dotflow-class)
+    - [Add Task](#add-task)
+    - [Start](#start)
+- [CLI](#cli)
+    - [Simple Start](#simple-start)
+    - [With Initial Context](#with-initial-context)
+    - [With Callback](#with-callback)
+    - [With Mode](#with-mode)
+- [More Examples](#more-examples)
+- [Commit Style](#commit-style)
+- [License](#license)
+
+</details>
+
+## Getting Help
+
+We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.
+
+- 🐛 [Bug Report](https://github.com/dotflow-io/dotflow/issues/new/choose)
+- 📕 [Documentation Issue](https://github.com/dotflow-io/dotflow/issues/new/choose)
+- 🚀 [Feature Request](https://github.com/dotflow-io/dotflow/issues/new/choose)
+- 💬 [General Question](https://github.com/dotflow-io/dotflow/issues/new/choose)
+
+## Getting Started
+
+### Install
+
+To install `Dotflow`, run the following command from the command line:
+
+**With Pip**
+
+```bash
+pip install dotflow
+```
+
+**With Poetry**
+
+```bash
+poetry add dotflow
+```
+
+## A Simple Example
+
+The simplest file could look like this:
+
+```python
+from dotflow import DotFlow, action
+
+def my_callback(*args, **kwargs):
+    print(args, kwargs)
+
+@action
+def my_task_x():
+    print("task")
+
+@action(retry=5)
+def my_task_y():
+    print("task")
+
+workflow = DotFlow()
+
+workflow.task.add(step=my_task_x, callback=my_callback)
+workflow.task.add(step=my_task_y, callback=my_callback)
+
+workflow.start()
+```
+
+## First Steps
+
+#### 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/))
+
+```python
+from dotflow import DotFlow, action
+```
+
+#### 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)
+
+```python
+def my_callback(*args, **kwargs):
+    print(args, kwargs)
+```
+
+#### 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)
+
+```python
+@action(retry=5)
+def my_task_x():
+    print("task")
+```
+
+#### 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/).
+
+```python
+workflow = DotFlow()
+```
+
+#### 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)
+
+- 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)
+```
+
+- Adding multiple steps at the same time:
+
+```python
+workflow.task.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)
+```
+
+#### 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.Workflow)
+
+```python
+workflow.start()
+```
+
+## CLI
+
+#### Simple Start
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step
+```
+
+#### With Initial Context
+
+```bash
+dotflow start --step examples.cli_with_initial_context.simple_step --initial-context abc
+```
+
+#### With Callback
+
+```bash
+dotflow start --step examples.cli_with_callback.simple_step --callback examples.cli_with_callback.callback
+```
+
+#### With Mode
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step --mode sequential
+```
+
+```bash
+dotflow start --step examples.cli_with_mode.simple_step --mode background
+```
+
+## More Examples
+
+|  | Example                                                                                                                          |
+|--| -------------------------------------------------------------------------------------------------------------------------------- |
+|01| [cli_with_callback](https://github.com/dotflow-io/examples/blob/master/cli_with_callback.py)                                     |
+|02| [cli_with_initial_context](https://github.com/dotflow-io/examples/blob/master/cli_with_initial_context.py)                       |
+|03| [cli_with_mode](https://github.com/dotflow-io/examples/blob/master/cli_with_mode.py)                                             |
+|04| [cli_with_output_context](https://github.com/dotflow-io/examples/blob/master/cli_with_output_context.py)                         |
+|05| [cli_with_path](https://github.com/dotflow-io/examples/blob/master/cli_with_path.py)                                             |
+|06| [simple_cli](https://github.com/dotflow-io/examples/blob/master/simple_cli.py)                                                   |
+|07| [simple_class_workflow](https://github.com/dotflow-io/examples/blob/master/simple_class_workflow.py)                             |
+|08| [simple_function_workflow_with_error](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow_with_error.py) |
+|09| [simple_function_workflow](https://github.com/dotflow-io/examples/blob/master/simple_function_workflow.py)                       |
+|10| [step_class_result_context](https://github.com/dotflow-io/examples/blob/master/step_class_result_context.py)                     |
+|11| [step_class_result_storage](https://github.com/dotflow-io/examples/blob/master/step_class_result_storage.py)                     |
+|12| [step_class_result_task](https://github.com/dotflow-io/examples/blob/master/step_class_result_task.py)                           |
+|13| [step_function_result_context](https://github.com/dotflow-io/examples/blob/master/step_function_result_context.py)               |
+|14| [step_function_result_storage](https://github.com/dotflow-io/examples/blob/master/step_function_result_storage.py)               |
+|15| [step_function_result_task](https://github.com/dotflow-io/examples/blob/master/step_function_result_task.py)                     |
+|16| [step_with_initial_context](https://github.com/dotflow-io/examples/blob/master/step_with_initial_context.py)                     |
+|17| [step_with_many_contexts](https://github.com/dotflow-io/examples/blob/master/step_with_many_contexts.py)                         |
+|18| [step_with_previous_context](https://github.com/dotflow-io/examples/blob/master/step_with_previous_context.py)                   |
+|19| [workflow_keep_going_true](https://github.com/dotflow-io/examples/blob/master/workflow_keep_going_true.py)                       |
+|20| [workflow_step_callback](https://github.com/dotflow-io/examples/blob/master/workflow_step_callback.py)                           |
+|21| [workflow_with_callback_failure](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_failure.py)           |
+|22| [workflow_with_callback_success](https://github.com/dotflow-io/examples/blob/master/workflow_with_callback_success.py)           |
+|23| [workflow_with_retry](https://github.com/dotflow-io/examples/blob/master/workflow_with_retry.py)                                 |
+
+## Commit Style
+
+- ⚙️ FEATURE
+- 📝 PEP8
+- 📌 ISSUE
+- 🪲 BUG
+- 📘 DOCS
+- 📦 PyPI
+- ❤️️ TEST
+- ⬆️ CI/CD
+- ⚠️ SECURITY
+
+## License
+![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
+
+This project is licensed under the terms of the MIT License.

{dotflow-0.10.0.dev2 → dotflow-0.11.1.dev1}/dotflow/__init__.py

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

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

@@ -53,11 +53,14 @@ class Execution:
         self._excution()
 
     def _is_action(self, class_instance: Callable, func: Callable):
-        return (
-            callable(getattr(class_instance, func))
-            and not func.startswith("__")
-            and getattr(class_instance, func).__module__ is Action.__module__
-        )
+        try:
+            return (
+                callable(getattr(class_instance, func))
+                and getattr(class_instance, func).__module__ is Action.__module__
+                and not func.startswith("__")
+            )
+        except AttributeError:
+            return False
 
     def _execution_orderer(
             self,

{dotflow-0.10.0.dev2 → dotflow-0.11.1.dev1}/dotflow/utils/tools.py

@@ -37,7 +37,7 @@ def write_file(
 def read_file(
         path: Path,
         encoding: str = "utf-8"
-) -> Any | None:
+) -> Any:
     """Read file"""
     if path.exists():
         with open(file=path, mode="r", encoding=encoding) as file:

{dotflow-0.10.0.dev2 → dotflow-0.11.1.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dotflow"
-version = "0.10.0.dev2"
+version = "0.11.1.dev1"
 authors = [
   { name="Fernando Celmer", email="email@fernandocelmer.com" },
 ]
@@ -35,7 +35,7 @@ mongodb = ["dotflow-mongodb"]
 
 [tool.poetry]
 name = "dotflow"
-version = "0.10.0.dev2"
+version = "0.11.1.dev1"
 description = "🎲 Dotflow turns an idea into flow!"
 authors = ["Fernando Celmer <email@fernandocelmer.com>"]
 readme = "README.md"

dotflow-0.10.0.dev2/README.md

@@ -1,157 +0,0 @@
-# Welcome to dotflow
-
-![](https://raw.githubusercontent.com/FernandoCelmer/dotflow/master/docs/assets/dotflow.gif)
-
-![GitHub Org's stars](https://img.shields.io/github/stars/dotflow-io?label=Dotflow&style=flat-square)
-![GitHub last commit](https://img.shields.io/github/last-commit/dotflow-io/dotflow?style=flat-square)
-![PyPI](https://img.shields.io/pypi/v/dotflow?style=flat-square)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dotflow?style=flat-square)
-![PyPI - Downloads](https://img.shields.io/pypi/dm/dotflow?style=flat-square)
-
-This is a very simple library that is still in the early stages of development. The main goal of this tool is to create a simple and secure workflow for executing any type of task. The library's API design was made to make it easy to add tasks and control their execution. To keep it simple, just instantiate the `DotFlow` class, use the `add` method, and the `start` method to begin execution.
-
-Start with the basics [here](https://dotflow-io.github.io/dotflow/nav/getting-started/).
-
-## Getting Help
-
-We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.
-
-- 🐛 [Bug Report](https://github.com/dotflow-io/dotflow/issues/new/choose)
-- 📕 [Documentation Issue](https://github.com/dotflow-io/dotflow/issues/new/choose)
-- 🚀 [Feature Request](https://github.com/dotflow-io/dotflow/issues/new/choose)
-- 💬 [General Question](https://github.com/dotflow-io/dotflow/issues/new/choose)
-
-## Getting Started
-
-### Install
-
-To install `Dotflow`, run the following command from the command line:
-
-**With Pip**
-
-```bash
-pip install dotflow
-```
-
-**With Poetry**
-
-```bash
-poetry add dotflow
-```
-
-## A Simple Example
-
-The simplest file could look like this:
-
-```python
-from dotflow import DotFlow, action
-
-def my_callback(*args, **kwargs):
-    print(args, kwargs)
-
-@action(retry=5)
-def my_task():
-    print("task")
-
-workflow = DotFlow()
-workflow.task.add(step=my_task, callback=my_callback)
-workflow.start()
-```
-
-## First Steps
-
-#### 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/))
-
-```python
-from dotflow import DotFlow, action
-```
-
-#### 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)
-
-```python
-def my_callback(*args, **kwargs):
-    print(args, kwargs)
-```
-
-#### 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)
-
-```python
-@action(retry=5)
-def my_task():
-    print("task")
-```
-
-#### 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/).
-
-```python
-workflow = DotFlow()
-```
-
-#### 5 - Add Task
-
-Now, simply add the `my_task` 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)
-
-```python
-workflow.task.add(step=my_task, callback=my_callback)
-```
-
-#### 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.Workflow)
-
-```python
-workflow.start()
-```
-
-## More Examples
-
-|  | Example                                                                                                                                  |
-|--| ---------------------------------------------------------------------------------------------------------------------------------------- |
-|01| [cli_with_callback](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_callback.py)                                     |
-|02| [cli_with_initial_context](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_initial_context.py)                       |
-|03| [cli_with_mode](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_mode.py)                                             |
-|04| [cli_with_output_context](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_output_context.py)                         |
-|05| [cli_with_path](https://github.com/dotflow-io/dotflow/blob/master/examples/cli_with_path.py)                                             |
-|06| [simple_cli](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_cli.py)                                                                 |
-|07| [simple_class_workflow](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_class_workflow.py)                             |
-|08| [simple_function_workflow_with_error](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_function_workflow_with_error.py) |
-|09| [simple_function_workflow](https://github.com/dotflow-io/dotflow/blob/master/examples/simple_function_workflow.py)                       |
-|10| [step_class_result_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_context.py)                     |
-|11| [step_class_result_storage](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_storage.py)                     |
-|12| [step_class_result_task](https://github.com/dotflow-io/dotflow/blob/master/examples/step_class_result_task.py)                           |
-|13| [step_function_result_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_context.py)               |
-|14| [step_function_result_storage](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_storage.py)               |
-|15| [step_function_result_task](https://github.com/dotflow-io/dotflow/blob/master/examples/step_function_result_task.py)                     |
-|16| [step_with_initial_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_initial_context.py)                     |
-|17| [step_with_many_contexts](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_many_contexts.py)                         |
-|18| [step_with_previous_context](https://github.com/dotflow-io/dotflow/blob/master/examples/step_with_previous_context.py)                   |
-|19| [workflow_keep_going_true](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_keep_going_true.py)                       |
-|20| [workflow_step_callback](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_step_callback.py)                           |
-|21| [workflow_with_callback_failure](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_callback_failure.py)           |
-|22| [workflow_with_callback_success](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_callback_success.py)           |
-|23| [workflow_with_retry](https://github.com/dotflow-io/dotflow/blob/master/examples/workflow_with_retry.py)                                 |
-
-## Commit Style
-
-- ⚙️ FEATURE
-- 📝 PEP8
-- 📌 ISSUE
-- 🪲 BUG
-- 📘 DOCS
-- 📦 PyPI
-- ❤️️ TEST
-- ⬆️ CI/CD
-- ⚠️ SECURITY
-
-## License
-![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
-
-This project is licensed under the terms of the MIT License.