zrb 0.17.2__py3-none-any.whl → 0.17.3__py3-none-any.whl

zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/messagebus/caller.py

@@ -15,7 +15,7 @@ class MessagebusCaller(Caller):
         publisher: Publisher,
         consumer_factory: Callable[[], Consumer],
         timeout: float = 30,
-        check_reply_interval: float = 0.1,
+        check_reply_interval: float = 0.05,
     ):
         self.logger = logger
         self.admin = admin

zrb/task/any_task.py

@@ -25,11 +25,11 @@ TAnyTask = TypeVar("TAnyTask", bound="AnyTask")
 
 class AnyTask(ABC):
     """
-    Contract/interface for all Zrb Task.
+    Abstraction for Zrb Task.
 
-    This class acts as a template for creating new Zrb Task types.
+    This class acts as a template for creating new Task type.
 
-    To define a new Zrb Task, you should extend this class and implement all its methods.
+    To define a new Task type, you should extend this class and implement all its methods.
     The easiest way to do so is by extending `Task`
     """
 

zrb/task/base_remote_cmd_task.py

@@ -91,7 +91,7 @@ class SingleBaseRemoteCmdTask(CmdTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,
@@ -235,7 +235,7 @@ class BaseRemoteCmdTask(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,

zrb/task/base_task/base_task.py

@@ -37,8 +37,44 @@ from zrb.task_input.any_input import AnyInput
 @typechecked
 class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     """
-    Base class for all tasks.
-    Every task definition should be extended from this class.
+    Base class for all Tasks.
+    Every Task definition should be extended from this class.
+
+    Task is the smallest Zrb automation unit.
+
+    You can configure a Task by using several interfaces:
+    - `inputs`: interfaces to read user input at the beginning of the execution.
+    - `envs`: interfaces to read and use OS Environment Variables.
+    - `env_files`: interfaces to read and use Environment Files.
+
+    Moreover, you can define Task dependencies by specifying it's `upstreams` or by using shift-right operator.
+
+    Every Task has its own life-cycle state:
+    - `Triggered`: The Task is triggered.
+    - `Waiting`: The Task is waiting for all it's upstreams to be ready.
+    - `Skipped`: The Task is not executed and will immediately enter the `Ready` state.
+    - `Started`: The Task execution is started.
+    - `Failed`: The Task execution is failed. It will enter the `Retry` state if the current attempt is less than the maximum attempt.
+    - `Retry`: The task will be restarted.
+    - `Ready`: The task is ready.
+
+    There are several configurations related to Task's life cycle:
+    - `retry`: How many retries should be attempted.
+    - `retry_interval`: How long to wait before the next retry attempt.
+    - `fallbacks`: What to do if the Task is failed and no retry attempt will be performed.
+    - `checkers`: How to determine if a Task is `Ready`.
+    - `checking_interval`: How long to wait before checking for Task's readiness.
+    - `run`: What a Task should do.
+    - `on_triggered`: What to do when a Task is `Triggered`.
+    - `on_waiting`: What to do when a Task is `Waiting`.
+    - `on_skipped`: What to do when a Task is `Skipped`.
+    - `on_started`: What to do when a Task is `Started`.
+    - `on_ready`: What to do when a Task is `Ready`.
+    - `on_retry`: What to do when a Task is `Retry`.
+    - `on_failed`: What to do when a Task is `Failed`.
+    - `should_execute`: Whether a Task should be `Started` or not (`Skipped`).
+
+    Finally, you can put related Tasks under the same `group`.
     """
 
     __running_tasks: List[AnyTask] = []
@@ -58,7 +94,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         run: Optional[Callable[..., Any]] = None,
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
@@ -72,7 +108,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     ):
         # init properties
         retry_interval = retry_interval if retry_interval >= 0 else 0
-        checking_interval = checking_interval if checking_interval > 0 else 0.05
+        checking_interval = checking_interval if checking_interval > 0 else 0
         retry = retry if retry >= 0 else 0
         # init parent classes
         FinishTracker.__init__(self, checking_interval=checking_interval)
@@ -273,15 +309,14 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             new_args = copy.deepcopy(args)
             if len(args) == 0 and "_args" in kwargs:
                 new_args = kwargs["_args"]
-            new_kwargs["_args"] = new_args
-            # inject self as input_map['_task']
-            new_kwargs["_task"] = self
             self._set_args(new_args)
             self._set_kwargs(new_kwargs)
             # run the task
             coroutines = [
                 asyncio.create_task(self._loop_check(show_done_info=show_done_info)),
-                asyncio.create_task(self._run_all(*new_args, **new_kwargs)),
+                asyncio.create_task(
+                    self._run_all(*new_args, _args=new_args, _task=self, **new_kwargs)
+                ),
             ]
             results = await asyncio.gather(*coroutines)
             result = results[-1]

zrb/task/base_task/component/base_task_model.py

@@ -58,7 +58,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         run: Optional[Callable[..., Any]] = None,
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,

zrb/task/base_task/component/common_task_model.py

@@ -49,7 +49,7 @@ class CommonTaskModel:
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         run: Optional[Callable[..., Any]] = None,
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,

zrb/task/checker.py

@@ -44,7 +44,7 @@ class Checker(BaseTask):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 30,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,

zrb/task/cmd_task.py

@@ -125,7 +125,7 @@ class CmdTask(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,

zrb/task/decorator.py

@@ -43,7 +43,7 @@ def python_task(
     on_retry: Optional[OnRetry] = None,
     on_failed: Optional[OnFailed] = None,
     checkers: Iterable[AnyTask] = [],
-    checking_interval: Union[float, int] = 0,
+    checking_interval: Union[float, int] = 0.05,
     retry: int = 2,
     retry_interval: Union[float, int] = 1,
     should_execute: Union[bool, str, Callable[..., bool]] = True,

zrb/task/docker_compose_task.py

@@ -115,7 +115,7 @@ class DockerComposeTask(CmdTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,

zrb/task/flow_task.py

@@ -45,9 +45,9 @@ class FlowTask(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: float = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
-        retry_interval: float = 1,
+        retry_interval: Union[float, int] = 1,
         steps: List[Union[AnyTask, List[AnyTask]]] = [],
         should_execute: Union[bool, str, Callable[..., bool]] = True,
         return_upstream_result: bool = False,

zrb/task/http_checker.py

@@ -87,7 +87,7 @@ class HTTPChecker(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,

zrb/task/notifier.py

@@ -58,7 +58,7 @@ class Notifier(BaseTask):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         should_execute: Union[bool, str, Callable[..., bool]] = True,

zrb/task/path_checker.py

@@ -56,7 +56,7 @@ class PathChecker(Checker):
         on_failed: Optional[OnFailed] = None,
         path: JinjaTemplate = "",
         ignored_path: Union[JinjaTemplate, Iterable[JinjaTemplate]] = [],
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,

zrb/task/path_watcher.py

@@ -72,7 +72,7 @@ class PathWatcher(Watcher):
         on_failed: Optional[OnFailed] = None,
         path: JinjaTemplate = "",
         ignored_path: Union[JinjaTemplate, Iterable[JinjaTemplate]] = [],
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 30,
         watch_new_files: bool = True,
         watch_modified_files: bool = True,

zrb/task/port_checker.py

@@ -66,7 +66,7 @@ class PortChecker(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,

zrb/task/recurring_task.py

@@ -76,7 +76,7 @@ class RecurringTask(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: float = 0,
+        checking_interval: float = 0.05,
         retry: int = 0,
         retry_interval: float = 1,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
@@ -185,7 +185,7 @@ class RecurringTask(BaseTask):
     async def __run_from_queue(self):
         while True:
             if len(self._run_configs) == 0:
-                await asyncio.sleep(0.1)
+                await asyncio.sleep(0.05)
                 continue
             if self._single_execution:
                 # Drain the queue, leave only the latest task

zrb/task/remote_cmd_task.py

@@ -66,7 +66,7 @@ class RemoteCmdTask(BaseRemoteCmdTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,

zrb/task/resource_maker.py

@@ -123,7 +123,7 @@ class ResourceMaker(BaseTask):
             on_retry=on_retry,
             on_failed=on_failed,
             checkers=[],
-            checking_interval=0.1,
+            checking_interval=0.05,
             retry=0,
             retry_interval=0,
             should_execute=should_execute,

zrb/task/rsync_task.py

@@ -69,7 +69,7 @@ class RsyncTask(BaseRemoteCmdTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: Union[float, int] = 0,
+        checking_interval: Union[float, int] = 0.05,
         retry: int = 2,
         retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,

zrb/task/server.py

@@ -1,4 +1,5 @@
 import asyncio
+import copy
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.accessories.name import get_random_name
@@ -61,25 +62,25 @@ class Controller:
     def get_sub_env_files(self) -> Iterable[EnvFile]:
         env_files = []
         for trigger in self._triggers:
-            env_files += trigger.copy()._get_env_files()
+            env_files += trigger._get_env_files()
         for action in self._actions:
-            env_files += action.copy()._get_env_files()
+            env_files += action._get_env_files()
         return env_files
 
     def get_sub_envs(self) -> Iterable[Env]:
         envs = []
         for trigger in self._triggers:
-            envs += trigger.copy()._get_envs()
+            envs += trigger._get_envs()
         for action in self._actions:
-            envs += action.copy()._get_envs()
+            envs += action._get_envs()
         return envs
 
     def get_sub_inputs(self) -> Iterable[AnyInput]:
         inputs = []
         for trigger in self._triggers:
-            inputs += trigger.copy()._get_combined_inputs()
+            inputs += trigger._get_combined_inputs()
         for action in self._actions:
-            inputs += action.copy()._get_combined_inputs()
+            inputs += action._get_combined_inputs()
         return inputs
 
     def to_function(self) -> Callable[..., Any]:
@@ -141,17 +142,18 @@ class Server(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: float = 0,
+        checking_interval: Union[int, float] = 0.05,
         retry: int = 0,
-        retry_interval: float = 1,
+        retry_interval: Union[int, float] = 1,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
         return_upstream_result: bool = False,
     ):
         inputs, envs, env_files = list(inputs), list(envs), list(env_files)
         for controller in controllers:
-            inputs += controller.get_sub_inputs()
-            envs += controller.get_sub_envs()
-            env_files += controller.get_sub_env_files()
+            controller_cp = copy.deepcopy(controller)
+            inputs += controller_cp.get_sub_inputs()
+            envs += controller_cp.get_sub_envs()
+            env_files += controller_cp.get_sub_env_files()
         BaseTask.__init__(
             self,
             name=name,
@@ -181,11 +183,12 @@ class Server(BaseTask):
         self._controllers = controllers
 
     async def run(self, *args: Any, **kwargs: Any):
-        for controller in self._controllers:
+        controllers = [copy.deepcopy(controller) for controller in self._controllers]
+        for controller in controllers:
             controller.set_envs(self._get_envs())
             controller.set_env_files(self._get_env_files())
             controller.set_inputs(self._get_inputs())
             controller.set_args(args)
             controller.set_kwargs(kwargs)
-        functions = [controller.to_function() for controller in self._controllers]
+        functions = [controller.to_function() for controller in controllers]
         await asyncio.gather(*[fn() for fn in functions])

zrb/task/task.py

@@ -9,7 +9,41 @@ logger.debug(colored("Loading zrb.task.task", attrs=["dark"]))
 @typechecked
 class Task(BaseTask):
     """
-    Alias for BaseTask.
+    Task is the smallest Zrb automation unit.
+
+    You can configure a Task by using several interfaces:
+    - `inputs`: interfaces to read user input at the beginning of the execution.
+    - `envs`: interfaces to read and use OS Environment Variables.
+    - `env_files`: interfaces to read and use Environment Files.
+
+    Moreover, you can define Task dependencies by specifying it's `upstreams` or by using shift-right operator.
+
+    Every Task has its own life-cycle state:
+    - `Triggered`: The Task is triggered.
+    - `Waiting`: The Task is waiting for all it's upstreams to be ready.
+    - `Skipped`: The Task is not executed and will immediately enter the `Ready` state.
+    - `Started`: The Task execution is started.
+    - `Failed`: The Task execution is failed. It will enter the `Retry` state if the current attempt is less than the maximum attempt.
+    - `Retry`: The task will be restarted.
+    - `Ready`: The task is ready.
+
+    There are several configurations related to Task's life cycle:
+    - `retry`: How many retries should be attempted.
+    - `retry_interval`: How long to wait before the next retry attempt.
+    - `fallbacks`: What to do if the Task is failed and no retry attempt will be performed.
+    - `checkers`: How to determine if a Task is `Ready`.
+    - `checking_interval`: How long to wait before checking for Task's readiness.
+    - `run`: What a Task should do.
+    - `on_triggered`: What to do when a Task is `Triggered`.
+    - `on_waiting`: What to do when a Task is `Waiting`.
+    - `on_skipped`: What to do when a Task is `Skipped`.
+    - `on_started`: What to do when a Task is `Started`.
+    - `on_ready`: What to do when a Task is `Ready`.
+    - `on_retry`: What to do when a Task is `Retry`.
+    - `on_failed`: What to do when a Task is `Failed`.
+    - `should_execute`: Whether a Task should be `Started` or not (`Skipped`).
+
+    Finally, you can put related Tasks under the same `group`.
     """
 
     pass

zrb/task/time_watcher.py

@@ -68,7 +68,7 @@ class TimeWatcher(Watcher):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         schedule: JinjaTemplate = "",
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 30,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,
     ):

zrb/task/watcher.py

@@ -2,6 +2,7 @@ import asyncio
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.accessories.name import get_random_name
+from zrb.helper.callable import run_async
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Callable, Iterable, Optional, Union
@@ -48,7 +49,7 @@ class Watcher(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0,
+        checking_interval: Union[int, float] = 0.05,
         progress_interval: Union[int, float] = 30,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
@@ -85,7 +86,9 @@ class Watcher(Checker):
     async def run(self, *args: Any, **kwargs: Any) -> bool:
         if not looper.is_registered(self._identifier):
             asyncio.create_task(
-                looper.register(self._identifier, self.create_loop_inspector())
+                run_async(
+                    looper.register, self._identifier, self.create_loop_inspector()
+                )
             )
         return await super().run(*args, **kwargs)
 

zrb/task_env/env.py

@@ -15,8 +15,9 @@ logger.debug(colored("Loading zrb.task_env.env", attrs=["dark"]))
 @typechecked
 class Env:
     """
-    Env Represents an environment configuration for a task, encapsulating details such as environment name, OS-specific
-    environment name, default values, and rendering behavior.
+    Env is an interface for a Task to read and use OS Environment Variable.
+
+    Env encapsulating details such as environment name, OS environment name, default values, and rendering behavior.
 
     Attributes:
         name (str): Environment name as recognized by the task.
@@ -77,7 +78,7 @@ class Env:
 
     def should_render(self) -> bool:
         """
-        Determines whether the environment value should be rendered.
+        Retrieves whether the environment value should be rendered.
 
         Returns:
             bool: True if the environment value should be rendered, False otherwise.

zrb/task_env/env_file.py

@@ -16,8 +16,9 @@ logger.debug(colored("Loading zrb.task_env.env_file", attrs=["dark"]))
 @typechecked
 class EnvFile:
     """
-    Represents a handler for an environment file, facilitating the creation and management of environment variables
-    (Env objects) based on the contents of the specified environment file.
+    Env is an interface for a Task to read and use OS Environment File.
+
+    Under the hood, EnvFile creates list of Env based on its `path` property.
 
     Attributes:
         path (str): The path to the environment file.

zrb/task_group/group.py

@@ -15,7 +15,7 @@ TGroup = TypeVar("TGroup", bound="Group")
 @typechecked
 class Group:
     """
-    Represents a group of tasks and subgroups, facilitating organization and hierarchy.
+    Group is an umbrella of several related Tasks or sub-groups, facilitating organization and hierarchy.
 
     This class allows the creation of a hierarchical structure by grouping tasks and
     other task groups together. It provides methods to add tasks, retrieve tasks,

zrb/task_input/any_input.py

@@ -11,10 +11,12 @@ logger.debug(colored("Loading zrb.task_input.any_input", attrs=["dark"]))
 
 class AnyInput(ABC):
     """
-    Abstract base class representing a generalized input specification.
-    This class serves as a template for creating various input types,
-    providing a standardized interface for input handling and processing.
+    Abstraction for Zrb Input.
 
+    This class acts as a template for creating new Inputs.
+
+    To define a new Input type, you should extend this class and implement all its methods.
+    The easiest way to do so is by extending `Input`
     """
 
     @abstractmethod

zrb/task_input/base_input.py

@@ -14,9 +14,9 @@ logger.debug(colored("Loading zrb.task_input.base_input", attrs=["dark"]))
 @typechecked
 class BaseInput(AnyInput):
     """
-    A concrete implementation of the AnyInput abstract base class, representing a specific type of task input.
-    This class allows for the creation of interactive and configurable inputs for tasks, with various attributes
-    to customize its behavior and appearance.
+    Base class for all Input.
+
+    Input is an interface for a Task to read user input at the beginning of the execution.
 
     Attributes:
         name (str): The name of the input, used as a unique identifier.

zrb/task_input/task_input.py

@@ -9,7 +9,7 @@ logger.debug(colored("Loading zrb.task_input.task_input", attrs=["dark"]))
 
 class Input(BaseInput):
     """
-    Alias for BaseInput
+    Input is an interface for a Task to read user input at the beginning of the execution.
 
     Attributes:
         name (str): The name of the input, used as a unique identifier.

{zrb-0.17.2.dist-info → zrb-0.17.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.17.2
+Version: 0.17.3
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
 ![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
 
 
-[🫰 Installation](https://github.com/state-alchemists/zrb/blob/main/docs/installation.md) | [📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Common Mistakes](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
+[🫰 Installation](https://github.com/state-alchemists/zrb/blob/main/docs/installation.md) | [📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Common Mistakes](https://github.com/state-alchemists/zrb/blob/main/docs/common-mistakes/README.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
 
 # 🤖 Zrb: A Framework to Enhance Your Workflow
@@ -43,11 +43,12 @@ Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) autom
 - __Automate__ day-to-day tasks.
 - __Generate__ projects or applications.
 - __Prepare__, __run__, and __deploy__ your applications with a single command.
-- Etc.
+- Deliver __faster__ with __fewer human errors__.
 
-You can also write custom task definitions in [Python](https://www.python.org/), enhancing Zrb's base capabilities. Defining your tasks in Zrb gives you several advantages because:
+Zrb allows you to write custom task definitions in [Python](https://www.python.org/), further enhancing Zrb's capabilities. Defining your tasks in Zrb gives you several advantages because:
 
-- Every task has a __retry mechanism__.
+- Every Zrb Task has a __retry mechanism__.
+- Every Zrb Task is __configurable__ via __environment variables__ or __user inputs__.
 - Zrb handles your __task dependencies__ automatically.
 - Zrb runs your task dependencies __concurrently__.
 
@@ -85,7 +86,9 @@ Download Datasets ──┘
        ⬇️
 ```
 
-You can create a file named `zrb_init.py` and define the tasks as follows:
+Zrb Task is the smallest automation unit. You can configure a Zrb Task using user input (`inputs`) or environment variables (`envs` or `env_files`). Every Zrb Task has a configurable `retry` mechanism. Moreover, you can also define Zrb Task dependencies using the shift right operator `>>` or `upstreams` parameter.
+
+You can create a file named `zrb_init.py` and define your Zrb Tasks as follows:
 
 ```python
 # File name: zrb_init.py
@@ -129,7 +132,7 @@ def show_stats(*args, **kwargs):
 # Define dependencies: `show_stat` depends on both, `download_dataset` and `install_pandas`
 Parallel(download_dataset, install_pandas) >> show_stats
 
-# Register the tasks so that they are accessbie from the CLI
+# Register the tasks so that they are accessble from the CLI
 runner.register(install_pandas, download_dataset, show_stats)
 ```
 
@@ -286,15 +289,15 @@ Visit [our tutorials](https://github.com/state-alchemists/zrb/blob/main/docs/tut
 - [🫰 Installation](https://github.com/state-alchemists/zrb/blob/main/docs/installation.md)
 - [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md)
 - [📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md)
-- [💃 Common Mistakes](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md)
+- [💃 Common Mistakes](https://github.com/state-alchemists/zrb/blob/main/docs/common-mistakes/README.md)
 - [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
 # 🐞 Bug Report + Feature Request
 
-You can submit bug report and feature request by creating a new [issue](https://github.com/state-alchemists/zrb/issues) on Zrb Github Repositories. When reporting a bug or requesting a feature, please be sure to:
+You can submit bug reports and feature requests by creating a new [issue](https://github.com/state-alchemists/zrb/issues) on Zrb's GitHub Repositories. When reporting a bug or requesting a feature, please be sure to:
 
 - Include the version of Zrb you are using (i.e., `zrb version`)
-- Tell us what you have try
+- Tell us what you have tried
 - Tell us what you expect
 - Tell us what you get
 
@@ -326,7 +329,7 @@ We are thankful for the following libraries and services. They accelerate Zrb de
     - [Jsons](https://pypi.org.project/jsons/): Parse JSON. This package should be part of the standard library.
     - [Libcst](https://pypi.org/project/libcst/): Turn Python code into a Concrete Syntax Tree.
     - [Croniter](https://pypi.org/project/croniter/): Parse cron pattern.
-    - [Flit](https://pypi.org/project/flit), [Twine](https://pypi.org/project/twine/), and many more. See the complete list of Zrb's requirements.txt
+    - [Poetry](https://pypi.org/project/poetry), [flake8](https://pypi.org/project/flake8/), [black](https://pypi.org/project/black), [isort](https://pypi.org/project/isort), and many more. See the complete list of Zrb's requirements.txt
 - Services
     - [asciiflow.com](https://asciiflow.com/): Creates beautiful ASCII-based diagrams.
     - [emojipedia.org](https://emojipedia.org/): Find emoji.

{zrb-0.17.2.dist-info → zrb-0.17.3.dist-info}/RECORD

@@ -965,7 +965,7 @@ zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/componen
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/repo/search_filter.py,sha256=lYquQLR4_qr43AlKGNBBNzcGOEOASQHteuLdiewOBoE,147
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/__init__.py,sha256=i5QOPDiwAwp0EskPSVwJDuVH6pq_DWRi3XN1hMFFw4A,244
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/messagebus/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/messagebus/caller.py,sha256=4C6bDNUm-cL-G_5R-GdaSCXht_bJM5q8lelnVftCdaQ,3201
+zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/messagebus/caller.py,sha256=P90X3d6et457EwD4NohOsPNIcz9lFQmzqTbZubmR9aA,3202
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/messagebus/server.py,sha256=KFVErPpkRDetDokMAR16thaKtOTqk_xRp4lmM1iQNFo,2197
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/rpc/rpc.py,sha256=obJ8ksA9Io5nRpGoTQE506hj82dPwRZIUWTq2JEOLRo,1625
 zrb/builtin/project/add/fastapp/app/template/src/kebab-zrb-app-name/src/component/schema/__init__.py,sha256=g1CrqtQukcTOnNaKFLj6j-iVaNQ_cvpmdzROtbeteck,127
@@ -1355,46 +1355,46 @@ zrb/shell-scripts/notify.ps1,sha256=6_xPoIwuxARpYljcjVV-iRJS3gJqGfx-B6kj719cJ9o,
 zrb/shell-scripts/rsync-util.sh,sha256=QzdhSBvUNMxB4U2B4m0Dxg9czGckRjB7Vk4A1ObG0-k,353
 zrb/shell-scripts/ssh-util.sh,sha256=9lXDzw6oO8HuA4vdbfps_uQMMwKyNYX9fZkZgpK52g8,401
 zrb/task/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task/any_task.py,sha256=lzCbrpm6Mo_isNW7KuHK7Rq0t59_9z0oOLAtaJYCEdg,39214
+zrb/task/any_task.py,sha256=hrgsYikSe_C6JDSWeHNGCCvefNrkVioJWUunrqSFGLE,39199
 zrb/task/any_task_event_handler.py,sha256=AjTC6lIcprutRusNBGl83EifQe4TbZzxdlVIR4ndWN4,524
-zrb/task/base_remote_cmd_task.py,sha256=tZi3jODMXfTkDAmWiFR2YdA-b4-TDTP1uLtO0ulmM34,10101
+zrb/task/base_remote_cmd_task.py,sha256=WHBT_mLEGDEyB28EeK9Qwqqe4B0JboyuQopC6DtnZqE,10107
 zrb/task/base_task/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task/base_task/base_task.py,sha256=3kwrxjz5EPRpBp2HAhdRHdgRDgyDTak01C6fQMjU1Pw,20446
+zrb/task/base_task/base_task.py,sha256=nQw61BsW6Si7X1Hu1HwqcD9BNq02NlQNoVYQkdtjOGY,22319
 zrb/task/base_task/component/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task/base_task/component/base_task_model.py,sha256=YlEuvYSzlrK83Kds07bu2drKSw3rKyl7qIR1qwIPNZk,10376
-zrb/task/base_task/component/common_task_model.py,sha256=JoAAf8EvuPx31fCK_TBxX_TBeHZrZyFDjLeK8ts0w3A,12285
+zrb/task/base_task/component/base_task_model.py,sha256=i6TrtTusZ71ZnOnx8yM0aJl8uF6R1hKdAf62bEdpdCs,10379
+zrb/task/base_task/component/common_task_model.py,sha256=h81BGqplsaWJCQl0Zigl24LLkCUKPEfJikSbITREQnM,12288
 zrb/task/base_task/component/pid_model.py,sha256=RjJIqOpavucDssnd3q3gT4q8QnP8I9SUdlv1b9pR7kU,292
 zrb/task/base_task/component/renderer.py,sha256=9wP2IW811Ta81IoPWmeQ7yVc7eG-uaSnOVbEyeaOIuk,4439
 zrb/task/base_task/component/trackers.py,sha256=c5xhZ6agICxKPI5Va1sn66_9OqC92ebF5CNhcwVUNUE,2074
-zrb/task/checker.py,sha256=Y8WnIZM23fGqZpxHw2Bnk5jb0MmEMS598WZiEB8OUFU,3381
-zrb/task/cmd_task.py,sha256=_wjF9MbKGA0EAr_df47AMC0lROCiaJTUyxT-AFQKKJo,14181
-zrb/task/decorator.py,sha256=WInQrxuVlejvZEGIiBMfkiMa0I5rT9lWRGjyyLu_hzw,3061
-zrb/task/docker_compose_task.py,sha256=Cgk9ROW_xSnSYV0x1E2Xo1AphFoota-omrtLPocDaOU,14908
-zrb/task/flow_task.py,sha256=QIIZgq9C7e-kvTRJ0Y1Slb5AQyy15N9H4NZxdFR3FI8,4867
-zrb/task/http_checker.py,sha256=mStzoRlcDWCyeIP4sRAQSns_U_nEp19qYYE-DONZaA8,5690
+zrb/task/checker.py,sha256=raYNBHgeyEqkyfBRsPPgSV7ukEfMlJOCUn97WQNl6mU,3384
+zrb/task/cmd_task.py,sha256=Bfu29x5Cy10gCazIItCEOzrafU7r7z5WlWS4_wD7Znk,14184
+zrb/task/decorator.py,sha256=stxrl6aXbuUDK83lVf8m8uni3Ii6egLl0TCR0vxslUQ,3064
+zrb/task/docker_compose_task.py,sha256=hUKF7W3GwxFuEWmlPPFxa7h8npEnig2sm7KjlidHFBI,14911
+zrb/task/flow_task.py,sha256=Lwbg-vCFSde4b-QR-sJGm28dpjKZFXl2Hbj2rEd0jwE,4894
+zrb/task/http_checker.py,sha256=y0cWa2t4YtGQr6FWno5sZ6Ej9gQiLDF-Z1kLU1rijRw,5693
 zrb/task/looper.py,sha256=0eM3wEIC_RbThg60MRbK4Az16vt81O5p12cORAYTfnI,1430
-zrb/task/notifier.py,sha256=19E4EcFgFZ0thU9p2P1dGUYR04721pa0K3lqsj6a4Xc,6217
+zrb/task/notifier.py,sha256=GbvnndQ-3-1vfGpOIIQ0IMS1ddqDxzgTSYThs_zg1xU,6220
 zrb/task/parallel.py,sha256=-coMuiFlS29GpBgW6plPVaCLesgzzD0bYib29OvhXFg,1193
-zrb/task/path_checker.py,sha256=Jn7tnaUiPUbWOPAH3TUgzaa9_uiU0dPkpKCkr2Tlruc,4671
-zrb/task/path_watcher.py,sha256=xoQxfgsGDxzywPPFS2RirtwrK9-cnm_TCTabZRhZr84,7418
-zrb/task/port_checker.py,sha256=KE1fr0NBiUCLplDOHot8RzPBP1h_BvxFzHIZiEOuGaM,4590
-zrb/task/recurring_task.py,sha256=FNxV7n4h9AzUCU8oKXwAS_A9j1newS-esWjmMsC33vE,7430
-zrb/task/remote_cmd_task.py,sha256=rmLB5uCcbbfZBy8-nAZI8mgnNd-J2d4SBemLEDwSlV4,3951
-zrb/task/resource_maker.py,sha256=jQSO7PVIuTZi__JcrpRC4Ni_xmuJszJiMAxH_qfJPhs,7644
-zrb/task/rsync_task.py,sha256=bgCeZQTG-4isvjZGGs_05oOEkkwGc930NTyuUYUm_cg,4187
-zrb/task/server.py,sha256=w0gO73tt9PLWXVtgY-oe6qzvODtxVcizBGCUjRrhp5w,6478
-zrb/task/task.py,sha256=dHv4cmnd0QFPT9PwrfmHpxTaXj86mm8xf7_jAj_engI,329
-zrb/task/time_watcher.py,sha256=m0OKCtYHzO8nz-bmp-PuaHpmGwhPzy2riikjol-_7ZA,5119
-zrb/task/watcher.py,sha256=2dxWgwSK8CrhiNF2JF1S9Pe_BXZPlfxU88n495vlIuY,3250
+zrb/task/path_checker.py,sha256=SHpwtlS5YbO1jFGNnP7SuswkuDNHMOy52Fr4IzdIG98,4674
+zrb/task/path_watcher.py,sha256=x2SdgdgaZm2wiAyfBJoMVa625ufHtf8oHKmKhhEqAQk,7421
+zrb/task/port_checker.py,sha256=Za02E0xzR7xvHEujxuPszaydJCpwl_hJa1S9U4j25XQ,4593
+zrb/task/recurring_task.py,sha256=6JN7YkAY-NQ_zU2EAzqaQAxvfkGssbxvzNtL_foNA3Q,7434
+zrb/task/remote_cmd_task.py,sha256=DzAt5Vq8YekqAfu9PflGP0XcdLWX_gLKI64dGVgtL6s,3954
+zrb/task/resource_maker.py,sha256=wvq8Gv11epA_OYeLY071hIfFYkJ0rMcmcnXUAbd3TRg,7645
+zrb/task/rsync_task.py,sha256=kusVfttM1H0OEpNpLuU1I25MqChYaJeZDNZiXWtuVbA,4190
+zrb/task/server.py,sha256=zWHHafsXvpUPmdwYxOt6THhJb124yyRmvvKJJdnws_c,6612
+zrb/task/task.py,sha256=AyF0U40Ub4zj1S5sOQE0TffGRWpU0CDx8TFCkrB3Tos,2241
+zrb/task/time_watcher.py,sha256=D3_rr5Dlaw8xOg9iZMAGzPiEC2VDvIIvNTluQsZeBHo,5122
+zrb/task/watcher.py,sha256=7yDAS7kxST4Gd_PLyg_7XU6uXed5qbojE-B5X5z9EY4,3344
 zrb/task/wiki_task.py,sha256=Mcugk_6Pd7pzubi2ZP4eegJs8e9niYKh-9mCrNHXE_g,4330
 zrb/task_env/constant.py,sha256=ySdHv2dawWE-UoeBHl8FEOmrBl4vfkRI67TIBdkK6l8,220
-zrb/task_env/env.py,sha256=C9IzavEtWlpap4C92XONi1ID-RK9gDDLQKl5rYGBsyc,5195
-zrb/task_env/env_file.py,sha256=NkPOjxi8lrvBjB13kc9LU3ODvjGsdw3sSGOyC9-GnzE,3087
+zrb/task_env/env.py,sha256=WoxPlUgD33p6-y2EJU0oXAXBAnPL65k55hAbv6kO-Zs,5206
+zrb/task_env/env_file.py,sha256=D5cHJBY1DFcBa3KI3ujTe7Gxk7y_WB1zXCzkZNlDexE,3047
 zrb/task_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task_group/group.py,sha256=RmYpnh1UGiCi0vKYoqLwlCmJzC5-VKkMgDrVR2y3wsk,6091
+zrb/task_group/group.py,sha256=uF3tyLABTyyBNyE9FUCfJeYSDnaLFQCis3tuEn5FYho,6109
 zrb/task_input/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task_input/any_input.py,sha256=cZ2v8qjJ3B-L-jZgAz5EhpZii5sMoepwan5jAbJE0cM,2067
-zrb/task_input/base_input.py,sha256=qNifwst3ArwAbQ9XBDoyo6whMeS2IP-VZ3Pw0vf8efE,5643
+zrb/task_input/any_input.py,sha256=-uOq1ONXdhW20FRkC3pzqX081tbfmWjvCc_-d-gCNGY,2087
+zrb/task_input/base_input.py,sha256=kxt2184s8ppC2dsa69J2uLUOUqsdCmXEJiNUIJxKcuQ,5495
 zrb/task_input/bool_input.py,sha256=xlWjqPvHi52TLiFP13wB1SayJlbzmxv31AS-sZJ0jw4,4040
 zrb/task_input/choice_input.py,sha256=GU28ATSayZsmqCW-euAPoWyA-Kh6d5Wf6FwWLXffk5w,4290
 zrb/task_input/constant.py,sha256=VEsnrI0BDdCJ1Z58EJgxXUhZBe5CA8TfURo0cNu5CaQ,200
@@ -1402,9 +1402,9 @@ zrb/task_input/float_input.py,sha256=rtaowHp8RpiQS8a24ULgtydRu6wkYT1Q7Q_IRcCPD7s
 zrb/task_input/int_input.py,sha256=d2fXcm5fCo09472eMAm6PdzLQD82ZBV9ARq5CjKepAo,4198
 zrb/task_input/password_input.py,sha256=g_g8ZWAzDaHx4h2EHY3UCGvTigC6esAUBzXU0T9nDUk,4192
 zrb/task_input/str_input.py,sha256=BNflOhrJvST9bWK0rGdCi7C7y-QDvHj9ISQMRmujIWU,4200
-zrb/task_input/task_input.py,sha256=x1sGHsoSYAYMdQBrCLmcvZa_ZmGggMPj3goAQzewUKI,2181
-zrb-0.17.2.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
-zrb-0.17.2.dist-info/METADATA,sha256=NNFpLM-mizatYOhAfnsi30eujgnhCA-KPs0KeCP4cRw,16460
-zrb-0.17.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-zrb-0.17.2.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
-zrb-0.17.2.dist-info/RECORD,,
+zrb/task_input/task_input.py,sha256=DcHgKie5Oo1sUxj41t1ZQjCIK1aAfTgGzaKr7_ap7ZI,2248
+zrb-0.17.3.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
+zrb-0.17.3.dist-info/METADATA,sha256=ICpcf7AIoV-FxXKbALeApOKizXtmK5mOhpbLItC3McM,17010
+zrb-0.17.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+zrb-0.17.3.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
+zrb-0.17.3.dist-info/RECORD,,