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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: dotflow
-Version: 0.13.0.dev2
+Version: 0.13.2.dev1
 Summary: 🎲 Dotflow turns an idea into flow!
 License: MIT License
          
@@ -23,6 +23,7 @@ License: MIT License
          LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
          OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
          SOFTWARE.
+License-File: LICENSE
 Author: Fernando Celmer
 Author-email: email@fernandocelmer.com
 Requires-Python: >=3.9
@@ -75,7 +76,7 @@ With Dotflow, you get a powerful and easy-to-use library designed to create exec
 
 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/).
+Start with the basics [here](https://dotflow-io.github.io/dotflow/).
 
 ## Table of Contents
 
@@ -109,8 +110,9 @@ Start with the basics [here](https://dotflow-io.github.io/dotflow/nav/getting-st
 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)
+- 📕 [Documentation](https://github.com/dotflow-io/dotflow/issues/new/choose)
 - 🚀 [Feature Request](https://github.com/dotflow-io/dotflow/issues/new/choose)
+- ⚠️ [Security Issue](https://github.com/dotflow-io/dotflow/issues/new/choose)
 - 💬 [General Question](https://github.com/dotflow-io/dotflow/issues/new/choose)
 
 ## Getting Started
@@ -282,31 +284,6 @@ D[Finish]
 
 </details>
 
-#### Sequential with Groups
-
-```python
-workflow.task.add(step=task_foo, group_name="foo")
-workflow.task.add(step=task_bar, group_name="bar")
-
-workflow.start()
-```
-
-<details>
-<summary>Click to see diagram</summary>
-
-```mermaid
-flowchart TD
-    A[Start] -->|run| C(Parallel Groups)
-    C -->|run| D[task_a]
-    C -->|run| E[task_c]
-    D -->|response| X[task_b]
-    X --> H[Finish]
-    E -->|response| Y[task_d]
-    Y --> H[Finish]
-```
-
-</details>
-
 #### Background
 
 ```python
@@ -357,6 +334,31 @@ flowchart TD
 
 </details>
 
+#### Parallel with Groups
+
+```python
+workflow.task.add(step=task_foo, group_name="foo")
+workflow.task.add(step=task_bar, group_name="bar")
+
+workflow.start()
+```
+
+<details>
+<summary>Click to see diagram</summary>
+
+```mermaid
+flowchart TD
+    A[Start] -->|run| C(Parallel Groups)
+    C -->|run| D[task_a]
+    C -->|run| E[task_c]
+    D -->|response| X[task_b]
+    X --> H[Finish]
+    E -->|response| Y[task_d]
+    Y --> H[Finish]
+```
+
+</details>
+
 ## More Examples
 
 | Example | Command |
@@ -399,17 +401,20 @@ flowchart TD
 
 ## Commit Style
 
-- ⚙️ FEATURE
-- 📝 PEP8
-- 📌 ISSUE
-- 🪲 BUG
-- 📘 DOCS
-- 📦 PyPI
-- ❤️️ TEST
-- ⬆️ CI/CD
-- ⚠️ SECURITY
+| Icon | Type      | Description                                |
+|------|-----------|--------------------------------------------|
+| ⚙️   | FEATURE   | New feature                                |
+| 📝   | PEP8      | Formatting fixes following PEP8            |
+| 📌   | ISSUE     | Reference to issue                         |
+| 🪲   | BUG       | Bug fix                                    |
+| 📘   | DOCS      | Documentation changes                      |
+| 📦   | PyPI      | PyPI releases                              |
+| ❤️️   | TEST      | Automated tests                            |
+| ⬆️   | CI/CD     | Changes in continuous integration/delivery |
+| ⚠️   | SECURITY  | Security improvements                      |
 
 ## 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.13.0.dev2 → dotflow-0.13.2.dev1}/README.md

@@ -26,7 +26,7 @@ With Dotflow, you get a powerful and easy-to-use library designed to create exec
 
 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/).
+Start with the basics [here](https://dotflow-io.github.io/dotflow/).
 
 ## Table of Contents
 
@@ -60,8 +60,9 @@ Start with the basics [here](https://dotflow-io.github.io/dotflow/nav/getting-st
 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)
+- 📕 [Documentation](https://github.com/dotflow-io/dotflow/issues/new/choose)
 - 🚀 [Feature Request](https://github.com/dotflow-io/dotflow/issues/new/choose)
+- ⚠️ [Security Issue](https://github.com/dotflow-io/dotflow/issues/new/choose)
 - 💬 [General Question](https://github.com/dotflow-io/dotflow/issues/new/choose)
 
 ## Getting Started
@@ -233,31 +234,6 @@ D[Finish]
 
 </details>
 
-#### Sequential with Groups
-
-```python
-workflow.task.add(step=task_foo, group_name="foo")
-workflow.task.add(step=task_bar, group_name="bar")
-
-workflow.start()
-```
-
-<details>
-<summary>Click to see diagram</summary>
-
-```mermaid
-flowchart TD
-    A[Start] -->|run| C(Parallel Groups)
-    C -->|run| D[task_a]
-    C -->|run| E[task_c]
-    D -->|response| X[task_b]
-    X --> H[Finish]
-    E -->|response| Y[task_d]
-    Y --> H[Finish]
-```
-
-</details>
-
 #### Background
 
 ```python
@@ -308,6 +284,31 @@ flowchart TD
 
 </details>
 
+#### Parallel with Groups
+
+```python
+workflow.task.add(step=task_foo, group_name="foo")
+workflow.task.add(step=task_bar, group_name="bar")
+
+workflow.start()
+```
+
+<details>
+<summary>Click to see diagram</summary>
+
+```mermaid
+flowchart TD
+    A[Start] -->|run| C(Parallel Groups)
+    C -->|run| D[task_a]
+    C -->|run| E[task_c]
+    D -->|response| X[task_b]
+    X --> H[Finish]
+    E -->|response| Y[task_d]
+    Y --> H[Finish]
+```
+
+</details>
+
 ## More Examples
 
 | Example | Command |
@@ -350,17 +351,20 @@ flowchart TD
 
 ## Commit Style
 
-- ⚙️ FEATURE
-- 📝 PEP8
-- 📌 ISSUE
-- 🪲 BUG
-- 📘 DOCS
-- 📦 PyPI
-- ❤️️ TEST
-- ⬆️ CI/CD
-- ⚠️ SECURITY
+| Icon | Type      | Description                                |
+|------|-----------|--------------------------------------------|
+| ⚙️   | FEATURE   | New feature                                |
+| 📝   | PEP8      | Formatting fixes following PEP8            |
+| 📌   | ISSUE     | Reference to issue                         |
+| 🪲   | BUG       | Bug fix                                    |
+| 📘   | DOCS      | Documentation changes                      |
+| 📦   | PyPI      | PyPI releases                              |
+| ❤️️   | TEST      | Automated tests                            |
+| ⬆️   | CI/CD     | Changes in continuous integration/delivery |
+| ⚠️   | SECURITY  | Security improvements                      |
 
 ## 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.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/__init__.py

@@ -1,6 +1,6 @@
 """Dotflow __init__ module."""
 
-__version__ = "0.13.0.dev2"
+__version__ = "0.13.2.dev1"
 __description__ = "🎲 Dotflow turns an idea into flow!"
 
 from .core.action import Action as action
@@ -9,5 +9,4 @@ from .core.context import Context
 from .core.dotflow import DotFlow
 from .core.task import Task
 
-
 __all__ = ["action", "Context", "Config", "DotFlow", "Task"]

dotflow-0.13.2.dev1/dotflow/abc/api.py

@@ -0,0 +1,24 @@
+"""Abstract base for optional remote API persistence."""
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class Api(ABC):
+    """Api"""
+
+    @abstractmethod
+    def create_workflow(self, workflow: Any) -> None:
+        """Create workflow"""
+
+    @abstractmethod
+    def update_workflow(self, workflow: Any) -> None:
+        """Update workflow"""
+
+    @abstractmethod
+    def create_task(self, task: Any) -> None:
+        """Create task"""
+
+    @abstractmethod
+    def update_task(self, task: Any) -> None:
+        """Update task"""

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/file.py

@@ -4,16 +4,9 @@ from abc import ABC, abstractmethod
 
 
 class FileClient(ABC):
-
     @abstractmethod
     @classmethod
-    def write(
-        self,
-        path: str,
-        content: str,
-        mode: str,
-        encoding: str
-    ) -> None:
+    def write(self, path: str, content: str, mode: str, encoding: str) -> None:
         pass
 
     @abstractmethod

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/flow.py

@@ -2,19 +2,17 @@
 
 from abc import ABC, abstractmethod
 from uuid import UUID
-from typing import Dict, List
 
 from dotflow.core.task import Task
 
 
 class Flow(ABC):
-
     def __init__(
-            self,
-            tasks: List[Task],
-            workflow_id: UUID,
-            ignore: bool,
-            groups: Dict[str, List[Task]]
+        self,
+        tasks: list[Task],
+        workflow_id: UUID,
+        ignore: bool,
+        groups: dict[str, list[Task]],
     ) -> None:
         self.queue = None
         self.tasks = tasks
@@ -30,7 +28,7 @@ class Flow(ABC):
         self.queue = []
 
     @abstractmethod
-    def get_tasks(self) -> List[Task]:
+    def get_tasks(self) -> list[Task]:
         return self.queue
 
     @abstractmethod

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/http.py

@@ -1,11 +1,10 @@
 """HTTP ABC"""
 
 from abc import ABC, abstractmethod
-from typing import Callable
+from collections.abc import Callable
 
 
 class HTTPRequest(ABC):
-
     def __init__(self, url: str, context: Callable):
         self.url = url
         self.context = context

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/log.py

@@ -1,8 +1,7 @@
 """Notify ABC"""
 
-from typing import Any
-
 from abc import ABC, abstractmethod
+from typing import Any
 
 
 class Log(ABC):

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/notify.py

@@ -1,8 +1,7 @@
 """Notify ABC"""
 
-from typing import Any
-
 from abc import ABC, abstractmethod
+from typing import Any
 
 
 class Notify(ABC):

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/storage.py

@@ -1,7 +1,7 @@
 """Storage ABC"""
 
-from typing import Callable
 from abc import ABC, abstractmethod
+from collections.abc import Callable
 
 from dotflow.core.context import Context
 

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/abc/tcp.py

@@ -1,11 +1,10 @@
 """TCP module"""
 
 from abc import ABC, abstractmethod
-from typing import Callable
+from collections.abc import Callable
 
 
 class TCPClient(ABC):
-
     def __init__(self, url: str):
         self.url = url
         self.context = None
@@ -16,7 +15,6 @@ class TCPClient(ABC):
 
 
 class TCPServer(ABC):
-
     def __init__(self, url: str, handler: Callable):
         self.url = url
         self.handler = handler

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/cli/command.py

@@ -4,7 +4,6 @@ from abc import ABC, abstractmethod
 
 
 class Command(ABC):
-
     def __init__(self, **kwargs):
         self.params = kwargs.get("arguments")
         self.setup()

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

@@ -4,9 +4,4 @@ from dotflow.cli.commands.init import InitCommand
 from dotflow.cli.commands.log import LogCommand
 from dotflow.cli.commands.start import StartCommand
 
-
-__all__ = [
-    "InitCommand",
-    "LogCommand",
-    "StartCommand"
-]
+__all__ = ["InitCommand", "LogCommand", "StartCommand"]

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/cli/commands/init.py

@@ -4,16 +4,15 @@ from os import system
 
 from rich import print  # type: ignore
 
-from dotflow.settings import Settings as settings
 from dotflow.cli.command import Command
+from dotflow.settings import Settings as settings
 
 
 class InitCommand(Command):
-
     def setup(self):
         if settings.GITIGNORE.exists():
             system("echo '\n\n# Dotflow\n.output' >> .gitignore")
             print(
                 settings.INFO_ALERT,
-                f"Installation complete! The ({settings.GITIGNORE.resolve()}) file has been modified."
+                f"Installation complete! The ({settings.GITIGNORE.resolve()}) file has been modified.",
             )

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/cli/commands/log.py

@@ -2,20 +2,19 @@
 
 from rich import print  # type: ignore
 
-from dotflow.utils import read_file
-from dotflow.settings import Settings as settings
 from dotflow.cli.command import Command
+from dotflow.settings import Settings as settings
+from dotflow.utils import read_file
 
 
 class LogCommand(Command):
-
     def setup(self):
         if settings.LOG_PATH.exists():
             print(read_file(path=settings.LOG_PATH))
 
             print(
                 settings.INFO_ALERT,
-                f"To access all logs, open the file ({settings.LOG_PATH.resolve()})."
+                f"To access all logs, open the file ({settings.LOG_PATH.resolve()}).",
             )
         else:
             print(settings.WARNING_ALERT, "Log file not found.")

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/cli/commands/start.py

@@ -2,14 +2,13 @@
 
 from os import system
 
-from dotflow import DotFlow, Config
-from dotflow.providers import StorageDefault, StorageFile
-from dotflow.core.types.execution import TypeExecution
+from dotflow import Config, DotFlow
 from dotflow.cli.command import Command
+from dotflow.core.types.execution import TypeExecution
+from dotflow.providers import StorageDefault, StorageFile
 
 
 class StartCommand(Command):
-
     def setup(self):
         workflow = self._new_workflow()
 
@@ -28,10 +27,7 @@ class StartCommand(Command):
         if not self.params.storage:
             return DotFlow()
 
-        storage_classes = {
-            "default": StorageDefault,
-            "file": StorageFile
-        }
+        storage_classes = {"default": StorageDefault, "file": StorageFile}
 
         config = Config(
             storage=storage_classes.get(self.params.storage)(

{dotflow-0.13.0.dev2 → dotflow-0.13.2.dev1}/dotflow/cli/setup.py

@@ -2,22 +2,21 @@
 
 from rich import print  # type: ignore
 
-from dotflow import __version__, __description__
-from dotflow.logging import logger
-from dotflow.settings import Settings as settings
-from dotflow.utils.basic_functions import basic_callback
-from dotflow.core.types import TypeExecution, TypeStorage
+from dotflow import __description__, __version__
+from dotflow.cli.commands import InitCommand, LogCommand, StartCommand
 from dotflow.core.exception import (
-    MissingActionDecorator,
+    MESSAGE_UNKNOWN_ERROR,
     ExecutionModeNotExist,
     ImportModuleError,
-    MESSAGE_UNKNOWN_ERROR,
+    MissingActionDecorator,
 )
-from dotflow.cli.commands import InitCommand, LogCommand, StartCommand
+from dotflow.core.types import TypeExecution, TypeStorage
+from dotflow.logging import logger
+from dotflow.settings import Settings as settings
+from dotflow.utils.basic_functions import basic_callback
 
 
 class Command:
-
     def __init__(self, parser):
         self.parser = parser
         self.subparsers = self.parser.add_subparsers()
@@ -55,7 +54,9 @@ class Command:
         self.cmd_start.add_argument(
             "-o", "--storage", choices=[TypeStorage.DEFAULT, TypeStorage.FILE]
         )
-        self.cmd_start.add_argument("-p", "--path", default=settings.START_PATH)
+        self.cmd_start.add_argument(
+            "-p", "--path", default=settings.START_PATH
+        )
         self.cmd_start.add_argument(
             "-m",
             "--mode",
@@ -71,7 +72,9 @@ 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):

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

@@ -2,7 +2,4 @@
 
 from dotflow.cli.validators.start import StartValidator
 
-
-__all__ = [
-    "StartValidator"
-]
+__all__ = ["StartValidator"]

dotflow-0.13.2.dev1/dotflow/cli/validators/start.py

@@ -0,0 +1,13 @@
+"""Start validator module"""
+
+from pydantic import BaseModel, Field  # type: ignore
+
+from dotflow.settings import Settings as settings
+
+
+class StartValidator(BaseModel):
+    step: str
+    callable: str | None = Field(default=None)
+    initial_context: str | None = Field(default=None)
+    output: bool | None = Field(default=True)
+    path: str | None = Field(default=settings.START_PATH)

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

@@ -1,13 +1,12 @@
 """Action module"""
 
-from time import sleep
-
+from collections.abc import Callable
 from concurrent.futures import ThreadPoolExecutor
-from typing import Callable, Dict
+from time import sleep
 from types import FunctionType
 
-from dotflow.core.exception import ExecutionWithClassError
 from dotflow.core.context import Context
+from dotflow.core.exception import ExecutionWithClassError
 
 
 def is_execution_with_class_internal_error(error: Exception) -> bool:
@@ -20,7 +19,7 @@ def is_execution_with_class_internal_error(error: Exception) -> bool:
     return any(pattern in message for pattern in patterns)
 
 
-class Action(object):
+class Action:
     """
     Import:
         You can import the **action** decorator directly from dotflow:
@@ -150,11 +149,13 @@ class Action(object):
             except Exception as error:
                 last_exception = error
 
-                if is_execution_with_class_internal_error(error=last_exception):
-                    raise ExecutionWithClassError()
+                if is_execution_with_class_internal_error(
+                    error=last_exception
+                ):
+                    raise ExecutionWithClassError() from None
 
                 if attempt == self.retry:
-                    raise last_exception
+                    raise last_exception from last_exception
 
                 sleep(self.retry_delay)
                 if self.backoff:
@@ -162,24 +163,26 @@ class Action(object):
 
     def _set_params(self):
         if isinstance(self.func, FunctionType):
-            self.params = [param for param in self.func.__code__.co_varnames]
+            self.params = list(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
-                    ]
+        if (
+            type(self.func) is type
+            and hasattr(self.func, "__init__")
+            and hasattr(self.func.__init__, "__code__")
+        ):
+            self.params = list(self.func.__init__.__code__.co_varnames)
 
-    def _get_context(self, kwargs: Dict):
+    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"))
+            context["previous_context"] = Context(
+                kwargs.get("previous_context")
+            )
 
         return context
 
-    def _get_task(self, kwargs: Dict):
+    def _get_task(self, kwargs: dict):
         return kwargs.get("task")