dotflow 0.9.0.dev2__tar.gz → 0.10.0__tar.gz

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dotflow
-Version: 0.9.0.dev2
+Version: 0.10.0
 Summary: 🎲 Dotflow turns an idea into flow!
 License: MIT License
          
@@ -34,8 +34,11 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: mongodb
+Requires-Dist: dotflow-mongodb ; extra == "mongodb"
 Requires-Dist: pydantic
 Requires-Dist: rich
+Requires-Dist: typing-extensions
 Project-URL: Documentation, https://github.com/dotflow-io/dotflow/blob/master/README.md
 Project-URL: Homepage, https://github.com/dotflow-io/dotflow
 Project-URL: Issues, https://github.com/dotflow-io/dotflow/issues
@@ -56,6 +59,33 @@ This is a very simple library that is still in the early stages of development.
 
 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.
@@ -93,68 +123,120 @@ 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-class/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/))
+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
+#### 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.
+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
+#### 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/) 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.
+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-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
+#### 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.
+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, callback=my_callback)
+workflow.task.add(step=my_task_x, callback=my_callback)
+workflow.task.add(step=my_task_y, callback=my_callback)
 ```
 
-#### 6 - Start
+- Adding multiple steps at the same time:
+
+```python
+workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
+```
 
-Finally, just execute the workflow with the following code snippet.
+- 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                                                                                                                                  |
@@ -196,7 +278,7 @@ workflow.start()
 - ⚠️ SECURITY
 
 ## License
-![GitHub License](https://img.shields.io/github/license/FernandoCelmer/dotflow)
+![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
 
 This project is licensed under the terms of the MIT License.
 

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/README.md

@@ -12,6 +12,33 @@ This is a very simple library that is still in the early stages of development.
 
 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.
@@ -49,68 +76,120 @@ 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-class/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/))
+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
+#### 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.
+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
+#### 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/) 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.
+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-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
+#### 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.
+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, callback=my_callback)
+workflow.task.add(step=my_task_x, callback=my_callback)
+workflow.task.add(step=my_task_y, callback=my_callback)
 ```
 
-#### 6 - Start
+- Adding multiple steps at the same time:
+
+```python
+workflow.task.add(step=[my_task_x, my_task_y], callback=my_callback)
+```
 
-Finally, just execute the workflow with the following code snippet.
+- 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                                                                                                                                  |
@@ -152,6 +231,6 @@ workflow.start()
 - ⚠️ SECURITY
 
 ## License
-![GitHub License](https://img.shields.io/github/license/FernandoCelmer/dotflow)
+![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
 
 This project is licensed under the terms of the MIT License.

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/dotflow/__init__.py

@@ -1,21 +1,13 @@
 """Dotflow __init__ module."""
 
-__version__ = "0.9.0.dev2"
+__version__ = "0.10.0"
 __description__ = "🎲 Dotflow turns an idea into flow!"
 
-from .core.config import Config
 from .core.action import Action as action
+from .core.config import Config
 from .core.context import Context
 from .core.dotflow import DotFlow
 from .core.task import Task
-from .core.decorators import retry  # deprecated
 
 
-__all__ = [
-    "action",
-    "retry",
-    "DotFlow",
-    "Context",
-    "Config",
-    "Task"
-]
+__all__ = ["action", "Context", "Config", "DotFlow", "Task"]

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/dotflow/abc/file.py

@@ -1,4 +1,4 @@
-"""File module"""
+"""File ABC"""
 
 from abc import ABC, abstractmethod
 

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/dotflow/abc/http.py

@@ -1,4 +1,4 @@
-"""HTTP module"""
+"""HTTP ABC"""
 
 from abc import ABC, abstractmethod
 from typing import Callable

dotflow-0.10.0/dotflow/abc/storage.py

@@ -0,0 +1,25 @@
+"""Storage ABC"""
+
+from typing import Callable
+from abc import ABC, abstractmethod
+
+from dotflow.core.context import Context
+
+
+class Storage(ABC):
+    """Storage"""
+
+    def __init__(self, *args, **kwargs):
+        pass
+
+    @abstractmethod
+    def post(self, key: str, context: Context) -> None:
+        """Post context somewhere"""
+
+    @abstractmethod
+    def get(self, key: str) -> Context:
+        """Get context somewhere"""
+
+    @abstractmethod
+    def key(self, task: Callable):
+        """Function that returns a key to get and post storage"""

dotflow-0.10.0/dotflow/cli/commands/start.py

@@ -0,0 +1,35 @@
+"""Command start module"""
+
+from os import system
+
+from dotflow import DotFlow, Config
+from dotflow.providers import StorageDefault, StorageFile
+from dotflow.core.types.execution import TypeExecution
+from dotflow.cli.command import Command
+
+
+class StartCommand(Command):
+
+    def setup(self):
+        workflow = DotFlow()
+
+        if self.params.storage:
+            storage = {"default": StorageDefault, "file": StorageFile}
+
+            config = Config(
+                storage=storage.get(self.params.storage)(
+                    path=self.params.path,
+                )
+            )
+            workflow = DotFlow(config=config)
+
+        workflow.task.add(
+            step=self.params.step,
+            callback=self.params.callback,
+            initial_context=self.params.initial_context,
+        )
+
+        workflow.start(mode=self.params.mode)
+
+        if self.params.mode == TypeExecution.BACKGROUND:
+            system("/bin/bash")

{dotflow-0.9.0.dev2 → dotflow-0.10.0}/dotflow/cli/setup.py

@@ -10,7 +10,7 @@ from dotflow.core.types.execution import TypeExecution
 from dotflow.core.exception import (
     MissingActionDecorator,
     ExecutionModeNotExist,
-    ModuleNotFound,
+    ImportModuleError,
     MESSAGE_UNKNOWN_ERROR,
 )
 from dotflow.cli.commands import (
@@ -56,9 +56,7 @@ class Command:
         self.cmd_start.add_argument("-s", "--step", required=True)
         self.cmd_start.add_argument("-c", "--callback", default=basic_callback)
         self.cmd_start.add_argument("-i", "--initial-context")
-        self.cmd_start.add_argument(
-            "-o", "--output-context", default=False, action="store_true"
-        )
+        self.cmd_start.add_argument("-o", "--storage", choices=["default", "file"])
         self.cmd_start.add_argument("-p", "--path", default=settings.START_PATH)
         self.cmd_start.add_argument(
             "-m",
@@ -71,9 +69,7 @@ class Command:
 
     def setup_logs(self):
         self.cmd_logs = self.subparsers.add_parser("logs", help="Logs")
-        self.cmd_logs = self.cmd_logs.add_argument_group(
-            "Usage: dotflow log [OPTIONS]"
-        )
+        self.cmd_logs = self.cmd_logs.add_argument_group("Usage: dotflow log [OPTIONS]")
         self.cmd_logs.set_defaults(exec=LogCommand)
 
     def command(self):
@@ -89,7 +85,7 @@ class Command:
         except ExecutionModeNotExist as err:
             print(settings.WARNING_ALERT, err)
 
-        except ModuleNotFound as err:
+        except ImportModuleError as err:
             print(settings.WARNING_ALERT, err)
 
         except Exception as err:

dotflow-0.10.0/dotflow/core/action.py

@@ -0,0 +1,129 @@
+"""Action module"""
+
+from typing import Callable, Dict
+from types import FunctionType
+
+from dotflow.core.context import Context
+
+
+class Action(object):
+    """
+    Import:
+        You can import the **action** decorator directly from dotflow:
+
+            from dotflow import action
+
+    Example:
+        `class` dotflow.core.action.Action
+
+        Standard
+
+            @action
+            def my_task():
+                print("task")
+
+        With Retry
+
+            @action(retry=5)
+            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.
+    """
+
+    def __init__(
+            self,
+            func: Callable = None,
+            task: Callable = None,
+            retry: int = 1
+    ) -> None:
+        self.func = func
+        self.task = task
+        self.retry = retry
+        self.params = []
+
+    def __call__(self, *args, **kwargs):
+        # With parameters
+        if self.func:
+            self._set_params()
+
+            task = self._get_task(kwargs=kwargs)
+            contexts = self._get_context(kwargs=kwargs)
+
+            if contexts:
+                return Context(
+                    storage=self._retry(*args, **contexts),
+                    task_id=task.task_id,
+                    workflow_id=task.workflow_id
+                )
+
+            return Context(
+                storage=self._retry(*args),
+                task_id=task.task_id,
+                workflow_id=task.workflow_id
+            )
+
+        # No parameters
+        def action(*_args, **_kwargs):
+            self.func = args[0]
+            self._set_params()
+
+            task = self._get_task(kwargs=_kwargs)
+            contexts = self._get_context(kwargs=_kwargs)
+
+            if contexts:
+                return Context(
+                    storage=self._retry(*_args, **contexts),
+                    task_id=task.task_id,
+                    workflow_id=task.workflow_id
+                )
+
+            return Context(
+                storage=self._retry(*_args),
+                task_id=task.task_id,
+                workflow_id=task.workflow_id
+            )
+
+        return action
+
+    def _retry(self, *args, **kwargs):
+        attempt = 0
+        exception = Exception()
+
+        while self.retry > attempt:
+            try:
+                return self.func(*args, **kwargs)
+            except Exception as error:
+                exception = error
+                attempt += 1
+
+        raise exception
+
+    def _set_params(self):
+        if isinstance(self.func, FunctionType):
+            self.params = [param for param in self.func.__code__.co_varnames]
+
+        if type(self.func) is type:
+            if hasattr(self.func, "__init__"):
+                if hasattr(self.func.__init__, "__code__"):
+                    self.params = [param for param in self.func.__init__.__code__.co_varnames]
+
+    def _get_context(self, kwargs: Dict):
+        context = {}
+        if "initial_context" in self.params:
+            context["initial_context"] = Context(kwargs.get("initial_context"))
+
+        if "previous_context" in self.params:
+            context["previous_context"] = Context(kwargs.get("previous_context"))
+
+        return context
+
+    def _get_task(self, kwargs: Dict):
+        return kwargs.get("task")

dotflow-0.10.0/dotflow/core/config.py

@@ -0,0 +1,28 @@
+"""Config module"""
+
+from dotflow.abc.storage import Storage
+from dotflow.providers.storage_default import StorageDefault
+
+
+class Config:
+    """
+    Import:
+        You can import the **Config** class with:
+
+            from dotflow import Config
+            from dotflow.storage import StorageDefault
+
+    Example:
+        `class` dotflow.core.config.Config
+
+            config = Config(storage=StorageDefault)
+
+    Args:
+        storage (Storage): Type of the storage.
+
+    Attributes:
+        storage (Storage):
+    """
+
+    def __init__(self, storage: Storage = StorageDefault()) -> None:
+        self.storage = storage