zrb 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

zrb/__init__.py

@@ -1,40 +1,44 @@
+from zrb.helper.default_env import inject_default_env
 from zrb.runner import runner
-from zrb.task.decorator import python_task
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
-    OnTriggered, OnWaiting, OnSkipped, OnStarted, OnReady, OnRetry, OnFailed
+    OnFailed,
+    OnReady,
+    OnRetry,
+    OnSkipped,
+    OnStarted,
+    OnTriggered,
+    OnWaiting,
 )
-from zrb.task.parallel import AnyParallel, Parallel
-from zrb.task.task import Task
-from zrb.task.cmd_task import CmdTask
-from zrb.task.docker_compose_task import DockerComposeTask, ServiceConfig
 from zrb.task.base_remote_cmd_task import BaseRemoteCmdTask, RemoteConfig
-from zrb.task.remote_cmd_task import RemoteCmdTask
-from zrb.task.rsync_task import RsyncTask
-from zrb.task.notifier import Notifier
 from zrb.task.checker import Checker
+from zrb.task.cmd_task import CmdTask
+from zrb.task.decorator import python_task
+from zrb.task.docker_compose_task import DockerComposeTask, ServiceConfig
+from zrb.task.flow_task import FlowTask
 from zrb.task.http_checker import HTTPChecker
-from zrb.task.port_checker import PortChecker
+from zrb.task.notifier import Notifier
+from zrb.task.parallel import AnyParallel, Parallel
 from zrb.task.path_checker import PathChecker
 from zrb.task.path_watcher import PathWatcher
-from zrb.task.time_watcher import TimeWatcher
-from zrb.task.resource_maker import (
-    ResourceMaker, Replacement, ReplacementMutator
-)
-from zrb.task.flow_task import FlowTask
+from zrb.task.port_checker import PortChecker
 from zrb.task.recurring_task import RecurringTask
+from zrb.task.remote_cmd_task import RemoteCmdTask
+from zrb.task.resource_maker import Replacement, ReplacementMutator, ResourceMaker
+from zrb.task.rsync_task import RsyncTask
+from zrb.task.task import Task
+from zrb.task.time_watcher import TimeWatcher
+from zrb.task_env.env import Env
+from zrb.task_env.env_file import EnvFile
+from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
-from zrb.task_input.task_input import Input
 from zrb.task_input.bool_input import BoolInput
 from zrb.task_input.choice_input import ChoiceInput
 from zrb.task_input.float_input import FloatInput
 from zrb.task_input.int_input import IntInput
 from zrb.task_input.password_input import PasswordInput
 from zrb.task_input.str_input import StrInput
-from zrb.task_env.env import Env
-from zrb.task_env.env_file import EnvFile
-from zrb.task_group.group import Group
-from zrb.helper.default_env import inject_default_env
+from zrb.task_input.task_input import Input
 
 assert runner
 assert AnyTask

zrb/__main__.py

@@ -1,15 +1,15 @@
+import logging
+
 from zrb.config.config import logging_level
+from zrb.helper.accessories.color import colored
 from zrb.helper.cli import create_cli
 from zrb.helper.default_env import inject_default_env
 from zrb.helper.log import logger
-from zrb.helper.accessories.color import colored
-
-import logging
 
 inject_default_env()
 if logging_level <= logging.INFO:
-    logger.info(colored('Create CLI instance', attrs=['dark']))
+    logger.info(colored("Create CLI instance", attrs=["dark"]))
 cli = create_cli()
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     cli()

zrb/action/runner.py

@@ -1,28 +1,29 @@
+import logging
+import sys
+
+import click
+
 from zrb.config.config import logging_level
-from zrb.helper.typing import Any, Callable, List, Mapping, Union
-from zrb.helper.typecheck import typechecked
-from zrb.helper.log import logger
 from zrb.helper.accessories.color import colored
-from zrb.task_group.group import Group as TaskGroup
+from zrb.helper.log import logger
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Callable, List, Mapping, Union
 from zrb.task.any_task import AnyTask
-
-import click
-import logging
-import sys
+from zrb.task_group.group import Group as TaskGroup
 
 CliSubcommand = Union[click.Group, click.Command]
 
 
 @typechecked
-class Runner():
-    '''
+class Runner:
+    """
     Runner class.
     Any tasks registered to the runner will be accessible from the terminal
-    '''
+    """
 
-    def __init__(self, env_prefix: str = ''):
+    def __init__(self, env_prefix: str = ""):
         if logging_level <= logging.INFO:
-            logger.info(colored('Create runner', attrs=['dark']))
+            logger.info(colored("Create runner", attrs=["dark"]))
         self.__env_prefix = env_prefix
         self.__tasks: List[AnyTask] = []
         self.__registered_groups: Mapping[str, click.Group] = {}
@@ -30,26 +31,20 @@ class Runner():
         self.__subcommands: Mapping[str, List[click.Group]] = {}
         self.__registered_task_cli_name: List[str] = []
         if logging_level <= logging.INFO:
-            logger.info(colored('Runner created', attrs=['dark']))
+            logger.info(colored("Runner created", attrs=["dark"]))
 
     def register(self, *tasks: AnyTask):
         for task in tasks:
             task._set_has_cli_interface()
             cli_name = task._get_full_cli_name()
             if cli_name in self.__registered_task_cli_name:
-                raise RuntimeError(
-                    f'Task "{cli_name}" has already been registered'
-                )
+                raise RuntimeError(f'Task "{cli_name}" has already been registered')
             if logging_level <= logging.DEBUG:
-                logger.debug(
-                    colored(f'Register task: "{cli_name}"', attrs=['dark'])
-                )
+                logger.debug(colored(f'Register task: "{cli_name}"', attrs=["dark"]))
             self.__tasks.append(task)
             self.__registered_task_cli_name.append(cli_name)
             if logging_level <= logging.DEBUG:
-                logger.debug(
-                    colored(f'Task registered: "{cli_name}"', attrs=['dark'])
-                )
+                logger.debug(colored(f'Task registered: "{cli_name}"', attrs=["dark"]))
 
     def serve(self, cli: click.Group) -> click.Group:
         for task in self.__tasks:
@@ -99,15 +94,13 @@ class Runner():
         task_inputs = task._get_combined_inputs()
         task_cli_name = task.get_cli_name()
         task_description = task.get_description()
-        task_function = task.to_function(
-            env_prefix=self.__env_prefix, raise_error=True
-        )
+        task_function = task.to_function(env_prefix=self.__env_prefix, raise_error=True)
         callback = self.__wrap_task_function(task_function)
         command = click.Command(
             callback=callback, name=task_cli_name, help=task_description
         )
         # by default, add an argument named _args
-        command.params.append(click.Argument(['_args'], nargs=-1))
+        command.params.append(click.Argument(["_args"], nargs=-1))
         # add task inputs,
         # if there are inputs with the same name, choose the first.
         registered_input: Mapping[str, bool] = {}
@@ -120,12 +113,11 @@ class Runner():
             command.params.append(click.Option(param_decl, **options))
         return command
 
-    def __wrap_task_function(
-        self, function: Callable[..., Any]
-    ) -> Callable[..., Any]:
+    def __wrap_task_function(self, function: Callable[..., Any]) -> Callable[..., Any]:
         def wrapped_function(*args: Any, **kwargs: Any) -> Any:
             try:
                 function(*args, **kwargs)
             except Exception:
                 sys.exit(1)
+
         return wrapped_function

zrb/advertisement.py

@@ -1,17 +1,18 @@
-from zrb.helper.typing import List
 from zrb.helper.advertisement import Advertisement
+from zrb.helper.typing import List
 
 # flake8: noqa E501
 
 advertisements: List[Advertisement] = [
     Advertisement(
-        content='\n'.join([
-            'Support zrb growth and development!',
-            '☕ Donate at: https://stalchmst.com/donation',
-            '🐙 Submit issues/PR at: https://github.com/state-alchemists/zrb',
-            '🐤 Follow us at: https://twitter.com/zarubastalchmst'
-        ]),
-        time_pattern='.*'
+        content="\n".join(
+            [
+                "Support zrb growth and development!",
+                "☕ Donate at: https://stalchmst.com/donation",
+                "🐙 Submit issues/PR at: https://github.com/state-alchemists/zrb",
+                "🐤 Follow us at: https://twitter.com/zarubastalchmst",
+            ]
+        ),
+        time_pattern=".*",
     ),
 ]
-

zrb/builtin/__init__.py

@@ -1,19 +1,21 @@
-from zrb.builtin import base64
-from zrb.builtin import env
-from zrb.builtin import eval
-from zrb.builtin import git
-from zrb.builtin import md5
-from zrb.builtin import explain
-from zrb.builtin import project
-from zrb.builtin import ubuntu
-from zrb.builtin import update
-from zrb.builtin import version
-from zrb.builtin import devtool
-from zrb.builtin import generator
-from zrb.builtin import process
-from zrb.builtin import say
-from zrb.builtin import watch_changes
-from zrb.builtin import schedule
+from zrb.builtin import (
+    base64,
+    devtool,
+    env,
+    eval,
+    explain,
+    generator,
+    git,
+    md5,
+    process,
+    project,
+    say,
+    schedule,
+    ubuntu,
+    update,
+    version,
+    watch_changes,
+)
 
 assert base64
 assert env

zrb/builtin/base64.py

@@ -1,21 +1,16 @@
-from zrb.helper.typing import Any
+import base64
+
 from zrb.builtin.group import base64_group
+from zrb.helper.typing import Any
+from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.str_input import StrInput
-from zrb.runner import runner
-
-import base64
 
 ###############################################################################
 # 🔤 Input Definitions
 ###############################################################################
 
-text_input = StrInput(
-    name='text',
-    shortcut='t',
-    description='Text',
-    default=''
-)
+text_input = StrInput(name="text", shortcut="t", description="Text", default="")
 
 ###############################################################################
 # Task Definitions
@@ -23,28 +18,28 @@ text_input = StrInput(
 
 
 @python_task(
-    name='encode',
+    name="encode",
     group=base64_group,
     inputs=[text_input],
-    description='Encode a text using base64 algorithm',
+    description="Encode a text using base64 algorithm",
     retry=0,
-    runner=runner
+    runner=runner,
 )
 async def encode(*args: str, **kwargs: Any):
-    text: str = kwargs.get('text', '')
+    text: str = kwargs.get("text", "")
     encoded_text = base64.b64encode(text.encode())
     return encoded_text.decode()
 
 
 @python_task(
-    name='decode',
+    name="decode",
     group=base64_group,
     inputs=[text_input],
-    description='Decode a base64 encoded text',
+    description="Decode a base64 encoded text",
     retry=0,
-    runner=runner
+    runner=runner,
 )
 async def decode(*args: str, **kwargs: Any):
-    text: str = kwargs.get('text', '')
+    text: str = kwargs.get("text", "")
     encoded_text = base64.b64decode(text.encode())
     return encoded_text.decode()

zrb/builtin/devtool/__init__.py

@@ -1,7 +1,18 @@
 from zrb.builtin.devtool.devtool_install import (
-    install_gvm, install_pyenv, install_nvm, install_sdkman, install_pulumi,
-    install_aws, install_gcloud, install_tmux, install_zsh, install_kubectl,
-    install_helm, install_docker, install_terraform, install_helix
+    install_aws,
+    install_docker,
+    install_gcloud,
+    install_gvm,
+    install_helix,
+    install_helm,
+    install_kubectl,
+    install_nvm,
+    install_pulumi,
+    install_pyenv,
+    install_sdkman,
+    install_terraform,
+    install_tmux,
+    install_zsh,
 )
 
 assert install_gvm