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

zrb/builtin/generator/simple_python_app/template/_automate/snake_zrb_app_name/image.py

@@ -1,18 +1,17 @@
 from zrb import DockerComposeTask, Env, StrInput, runner
 from zrb.builtin.group import project_group
-from ._common import (
-    RESOURCE_DIR, local_input
-)
+
+from ._common import RESOURCE_DIR, local_input
 
 ###############################################################################
 # 🔤 Input Definitions
 ###############################################################################
 
 image_input = StrInput(
-    name='kebab-zrb-app-name-image',
+    name="kebab-zrb-app-name-image",
     description='Image name of "kebab-zrb-app-name"',
     prompt='Image name of "kebab-zrb-app-name"',
-    default='zrb-app-image-name:latest'
+    default="zrb-app-image-name:latest",
 )
 
 
@@ -21,9 +20,9 @@ image_input = StrInput(
 ###############################################################################
 
 image_env = Env(
-    name='IMAGE',
-    os_name='CONTAINER_ZRB_ENV_PREFIX_IMAGE',
-    default='{{input.snake_zrb_app_name_image}}'
+    name="IMAGE",
+    os_name="CONTAINER_ZRB_ENV_PREFIX_IMAGE",
+    default="{{input.snake_zrb_app_name_image}}",
 )
 
 ###############################################################################
@@ -31,22 +30,20 @@ image_env = Env(
 ###############################################################################
 
 build_snake_zrb_app_name_image = DockerComposeTask(
-    icon='🏭',
-    name='build-kebab-zrb-app-name-image',
-    description='Build human readable zrb app name image',
+    icon="🏭",
+    name="build-kebab-zrb-app-name-image",
+    description="Build human readable zrb app name image",
     group=project_group,
     inputs=[
         local_input,
         image_input,
     ],
     envs=[image_env],
-    should_execute='{{ input.local_snake_zrb_app_name}}',
+    should_execute="{{ input.local_snake_zrb_app_name}}",
     cwd=RESOURCE_DIR,
-    compose_cmd='build',
-    compose_flags=[
-        '--no-cache'
-    ],
-    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_cmd="build",
+    compose_flags=["--no-cache"],
+    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
 )
 runner.register(build_snake_zrb_app_name_image)
 
@@ -55,9 +52,9 @@ runner.register(build_snake_zrb_app_name_image)
 ###############################################################################
 
 push_snake_zrb_app_name_image = DockerComposeTask(
-    icon='📰',
-    name='push-kebab-zrb-app-name-image',
-    description='Push human readable zrb app name image',
+    icon="📰",
+    name="push-kebab-zrb-app-name-image",
+    description="Push human readable zrb app name image",
     group=project_group,
     inputs=[
         local_input,
@@ -66,7 +63,7 @@ push_snake_zrb_app_name_image = DockerComposeTask(
     envs=[image_env],
     upstreams=[build_snake_zrb_app_name_image],
     cwd=RESOURCE_DIR,
-    compose_cmd='push',
-    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_cmd="push",
+    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
 )
 runner.register(push_snake_zrb_app_name_image)

zrb/builtin/generator/simple_python_app/template/_automate/snake_zrb_app_name/local.py

@@ -1,48 +1,46 @@
+import os
+
 from zrb import CmdTask, Env, EnvFile, HTTPChecker, runner
 from zrb.builtin.group import project_group
+
 from ._common import (
-    CURRENT_DIR, APP_DIR, APP_TEMPLATE_ENV_FILE_NAME,
-    local_input, host_input, https_input
+    APP_DIR,
+    APP_TEMPLATE_ENV_FILE_NAME,
+    CURRENT_DIR,
+    host_input,
+    https_input,
+    local_input,
 )
-import os
 
 ###############################################################################
 # ⚙️ kebab-zrb-task-name
 ###############################################################################
 
 start_snake_zrb_app_name = CmdTask(
-    icon='🚤',
-    name='start-kebab-zrb-app-name',
-    description='Start human readable zrb app name',
+    icon="🚤",
+    name="start-kebab-zrb-app-name",
+    description="Start human readable zrb app name",
     group=project_group,
-    inputs=[
-        local_input,
-        host_input,
-        https_input
-    ],
-    should_execute='{{ input.local_snake_zrb_app_name}}',
+    inputs=[local_input, host_input, https_input],
+    should_execute="{{ input.local_snake_zrb_app_name}}",
     cwd=APP_DIR,
-    env_files=[
-        EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX')
-    ],
+    env_files=[EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="ZRB_ENV_PREFIX")],
     envs=[
         Env(
-            name='APP_PORT',
-            os_name='ZRB_ENV_PREFIX_APP_PORT',
-            default='zrbAppHttpPort'
+            name="APP_PORT", os_name="ZRB_ENV_PREFIX_APP_PORT", default="zrbAppHttpPort"
         )
     ],
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'app-activate-venv.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'app-start.sh'),
+        os.path.join(CURRENT_DIR, "cmd", "app-activate-venv.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "app-start.sh"),
     ],
     checkers=[
         HTTPChecker(
-            name='check-kebab-zrb-app-name',
-            host='{{input.snake_zrb_app_name_host}}',
-            port='{{env.APP_PORT}}',
-            is_https='{{input.snake_zrb_app_name_https}}'
+            name="check-kebab-zrb-app-name",
+            host="{{input.snake_zrb_app_name_host}}",
+            port="{{env.APP_PORT}}",
+            is_https="{{input.snake_zrb_app_name_https}}",
         )
-    ]
+    ],
 )
 runner.register(start_snake_zrb_app_name)

zrb/builtin/generator/simple_python_app/template/src/kebab-zrb-app-name/deployment/__main__.py

@@ -1,24 +1,25 @@
-'''A Kubernetes Python Pulumi program to deploy kebab-zrb-app-name'''
+"""A Kubernetes Python Pulumi program to deploy kebab-zrb-app-name"""
+
+import os
 
-from dotenv import dotenv_values
 import pulumi
 import pulumi_kubernetes as k8s
-import os
+from dotenv import dotenv_values
 
 CURRENT_DIR = os.path.dirname(__file__)
-APP_DIR = os.path.abspath(os.path.join(CURRENT_DIR, '..', 'src'))
-TEMPLATE_ENV_FILE_NAME = os.path.join(APP_DIR, 'template.env')
+APP_DIR = os.path.abspath(os.path.join(CURRENT_DIR, "..", "src"))
+TEMPLATE_ENV_FILE_NAME = os.path.join(APP_DIR, "template.env")
 
-image = os.getenv('IMAGE', 'kebab-zrb-app-name:latest')
-replica = int(os.getenv('REPLICA', '1'))
-app_labels = {'app': 'kebab-zrb-app-name'}
+image = os.getenv("IMAGE", "kebab-zrb-app-name:latest")
+replica = int(os.getenv("REPLICA", "1"))
+app_labels = {"app": "kebab-zrb-app-name"}
 env_map = dotenv_values(TEMPLATE_ENV_FILE_NAME)
-app_port = int(os.getenv('APP_PORT', env_map.get('APP_PORT', '8080')))
+app_port = int(os.getenv("APP_PORT", env_map.get("APP_PORT", "8080")))
 
 # Pulumi deployment docs:
 # https://www.pulumi.com/registry/packages/kubernetes/api-docs/apps/v1/deployment/
 deployment = k8s.apps.v1.Deployment(
-    resource_name='kebab-zrb-app-name',
+    resource_name="kebab-zrb-app-name",
     spec=k8s.apps.v1.DeploymentSpecArgs(
         selector=k8s.meta.v1.LabelSelectorArgs(match_labels=app_labels),
         replicas=replica,
@@ -27,41 +28,32 @@ deployment = k8s.apps.v1.Deployment(
             spec=k8s.core.v1.PodSpecArgs(
                 containers=[
                     k8s.core.v1.ContainerArgs(
-                        name='kebab-zrb-app-name',
+                        name="kebab-zrb-app-name",
                         image=image,
                         env=[
                             k8s.core.v1.EnvVarArgs(
-                                name=env_name,
-                                value=os.getenv(env_name, default_value)
+                                name=env_name, value=os.getenv(env_name, default_value)
                             )
                             for env_name, default_value in env_map.items()
                         ],
-                        ports=[
-                            k8s.core.v1.ContainerPortArgs(
-                                container_port=app_port
-                            )
-                        ],
+                        ports=[k8s.core.v1.ContainerPortArgs(container_port=app_port)],
                         liveness_probe=k8s.core.v1.ProbeArgs(
-                            http_get=k8s.core.v1.HTTPGetActionArgs(
-                                port=app_port
-                            )
+                            http_get=k8s.core.v1.HTTPGetActionArgs(port=app_port)
                         ),
                         readiness_probe=k8s.core.v1.ProbeArgs(
-                            http_get=k8s.core.v1.HTTPGetActionArgs(
-                                port=app_port
-                            )
+                            http_get=k8s.core.v1.HTTPGetActionArgs(port=app_port)
                         ),
                     )
                 ]
-            )
-        )
-    )
+            ),
+        ),
+    ),
 )
 
 # Pulumi services docs:
 # https://www.pulumi.com/registry/packages/kubernetes/api-docs/core/v1/service/
 service = k8s.core.v1.Service(
-    resource_name='kebab-zrb-app-name',
+    resource_name="kebab-zrb-app-name",
     spec=k8s.core.v1.ServiceSpecArgs(
         selector=app_labels,
         ports=[
@@ -71,9 +63,9 @@ service = k8s.core.v1.Service(
                 target_port=app_port,
             )
         ],
-        type='LoadBalancer',
-    )
+        type="LoadBalancer",
+    ),
 )
 
-pulumi.export('deployment-name', deployment.metadata['name'])
-pulumi.export('service-name', service.metadata['name'])
+pulumi.export("deployment-name", deployment.metadata["name"])
+pulumi.export("service-name", service.metadata["name"])

zrb/builtin/generator/simple_python_app/template/src/kebab-zrb-app-name/src/main.py

@@ -1,20 +1,24 @@
 import os
 
-MESSAGE = os.getenv('APP_MESSAGE', 'Hello, world!')
-PORT = int(os.getenv('APP_PORT', '8000'))
+MESSAGE = os.getenv("APP_MESSAGE", "Hello, world!")
+PORT = int(os.getenv("APP_PORT", "8000"))
 
 
 async def app(scope, receive, send):
-    assert scope['type'] == 'http'
+    assert scope["type"] == "http"
 
-    await send({
-        'type': 'http.response.start',
-        'status': 200,
-        'headers': [
-            [b'content-type', b'text/plain'],
-        ],
-    })
-    await send({
-        'type': 'http.response.body',
-        'body': bytes(MESSAGE, 'utf-8'),
-    })
+    await send(
+        {
+            "type": "http.response.start",
+            "status": 200,
+            "headers": [
+                [b"content-type", b"text/plain"],
+            ],
+        }
+    )
+    await send(
+        {
+            "type": "http.response.body",
+            "body": bytes(MESSAGE, "utf-8"),
+        }
+    )

zrb/builtin/git.py

@@ -1,89 +1,89 @@
-from zrb.helper.typing import Any
 from zrb.builtin.group import git_group
-from zrb.task.decorator import python_task
-from zrb.task.cmd_task import CmdTask
-from zrb.task_input.str_input import StrInput
-from zrb.task_input.bool_input import BoolInput
-from zrb.runner import runner
-from zrb.helper.git.detect_changes import get_modified_file_states
 from zrb.helper.accessories.color import colored
+from zrb.helper.git.detect_changes import get_modified_file_states
 from zrb.helper.python_task import show_lines
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task.decorator import python_task
+from zrb.task_input.bool_input import BoolInput
+from zrb.task_input.str_input import StrInput
 
 ###############################################################################
 # Task Definitions
 ###############################################################################
 
 clear_branch = CmdTask(
-    name='clear-branch',
+    name="clear-branch",
     group=git_group,
-    description='Clear branches',
+    description="Clear branches",
     cmd=[
-        'for BRANCH in $(git branch)',
-        'do',
+        "for BRANCH in $(git branch)",
+        "do",
         '  if [ "$BRANCH" != "main" ]',
-        '  then',
-        '    git branch -D $BRANCH',
-        '  fi',
-        'done',
-    ]
+        "  then",
+        "    git branch -D $BRANCH",
+        "  fi",
+        "done",
+    ],
 )
 runner.register(clear_branch)
 
 
 @python_task(
-    name='get-file-changes',
+    name="get-file-changes",
     group=git_group,
-    description='Get modified files',
+    description="Get modified files",
     inputs=[
         StrInput(
-            name='commit',
-            shortcut='c',
-            description='commit hash/tag',
-            prompt='Commit hash/Tag',
-            default='HEAD'
+            name="commit",
+            shortcut="c",
+            description="commit hash/tag",
+            prompt="Commit hash/Tag",
+            default="HEAD",
         ),
         BoolInput(
-            name='include-new',
-            description='include new files',
-            prompt='Include new files',
-            default=True
+            name="include-new",
+            description="include new files",
+            prompt="Include new files",
+            default=True,
         ),
         BoolInput(
-            name='include-removed',
-            description='include removed file',
-            prompt='Include removed file',
-            default=True
-        ), 
+            name="include-removed",
+            description="include removed file",
+            prompt="Include removed file",
+            default=True,
+        ),
         BoolInput(
-            name='include-updated',
-            description='include updated file',
-            prompt='Include updated file',
-            default=True
+            name="include-updated",
+            description="include updated file",
+            prompt="Include updated file",
+            default=True,
         ),
     ],
-    runner=runner
+    runner=runner,
 )
 async def get_file_changes(*args: Any, **kwargs: Any):
-    commit = kwargs.get('commit', 'HEAD')
-    include_new = kwargs.get('include_new', True)
-    include_removed = kwargs.get('include_removed', True)
-    include_updated = kwargs.get('include_updated', True)
+    commit = kwargs.get("commit", "HEAD")
+    include_new = kwargs.get("include_new", True)
+    include_removed = kwargs.get("include_removed", True)
+    include_updated = kwargs.get("include_updated", True)
     modified_file_states = get_modified_file_states(commit)
     modified_file_keys = []
     output = []
     for modified_file, state in modified_file_states.items():
         if include_updated and state.minus and state.plus:
-            output.append(colored(f'+- {modified_file}', color='yellow'))
+            output.append(colored(f"+- {modified_file}", color="yellow"))
             modified_file_keys.append(modified_file)
             continue
         if include_removed and state.minus and not state.plus:
-            output.append(colored(f'-- {modified_file}', color='red'))
+            output.append(colored(f"-- {modified_file}", color="red"))
             modified_file_keys.append(modified_file)
             continue
         if include_new and state.plus and not state.minus:
-            output.append(colored(f'++ {modified_file}', color='green'))
+            output.append(colored(f"++ {modified_file}", color="green"))
             modified_file_keys.append(modified_file)
             continue
-    show_lines(kwargs['_task'], *output)
+    show_lines(kwargs["_task"], *output)
     modified_file_keys.sort()
-    return '\n'.join(modified_file_keys)
+    return "\n".join(modified_file_keys)

zrb/builtin/group.py

@@ -1,42 +1,21 @@
 from zrb.task_group.group import Group
 
-project_group = Group(
-    name='project', description='Project management'
-)
+project_group = Group(name="project", description="Project management")
 project_add_group = Group(
-    name='add', description='Add resources to project', parent=project_group
-)
-env_group = Group(
-    name='env', description='Environment variable management'
-)
-ubuntu_group = Group(
-    name='ubuntu', description='Ubuntu related commands'
+    name="add", description="Add resources to project", parent=project_group
 )
+env_group = Group(name="env", description="Environment variable management")
+ubuntu_group = Group(name="ubuntu", description="Ubuntu related commands")
 ubuntu_install_group = Group(
-    name='install', description='Install things on ubuntu', parent=ubuntu_group
-)
-explain_group = Group(
-    name='explain', description='Explain things'
-)
-base64_group = Group(
-    name='base64', description='Base64 operations'
-)
-md5_group = Group(
-    name='md5', description='MD5 operations'
-)
-dev_tool_group = Group(
-    name='devtool', description='Developer tools management'
+    name="install", description="Install things on ubuntu", parent=ubuntu_group
 )
+explain_group = Group(name="explain", description="Explain things")
+base64_group = Group(name="base64", description="Base64 operations")
+md5_group = Group(name="md5", description="MD5 operations")
+dev_tool_group = Group(name="devtool", description="Developer tools management")
 dev_tool_install_group = Group(
-    name='install', description='Install developer tools',
-    parent=dev_tool_group
-)
-git_group = Group(
-    name='git', description='Git related commands'
-)
-process_group = Group(
-    name='process', description='Process related commands'
-)
-plugin_group = Group(
-    name='plugin', description='Plugin related command'
+    name="install", description="Install developer tools", parent=dev_tool_group
 )
+git_group = Group(name="git", description="Git related commands")
+process_group = Group(name="process", description="Process related commands")
+plugin_group = Group(name="plugin", description="Plugin related command")

zrb/builtin/helper/reccuring_action.py

@@ -1,8 +1,8 @@
 from zrb.helper.typing import Any
-from zrb.task.task import Task
-from zrb.task.decorator import python_task
 from zrb.task.cmd_task import CmdTask
+from zrb.task.decorator import python_task
 from zrb.task.notifier import Notifier
+from zrb.task.task import Task
 from zrb.task_input.str_input import StrInput
 
 
@@ -10,62 +10,59 @@ def create_recurring_action(
     notif_title: str,
     trigger_caption: str,
     trigger_xcom_key: str,
-    default_message: str = '👋'
+    default_message: str = "👋",
 ) -> Task:
     # define inputs
     message_input = StrInput(
-        name='message',
+        name="message",
         default=default_message,
-        prompt='Message to be shown',
+        prompt="Message to be shown",
     )
     command_input = StrInput(
-        name='command',
-        default='',
-        prompt='Command to be executed',
+        name="command",
+        default="",
+        prompt="Command to be executed",
     )
     # define tasks
     show_trigger_info = _create_show_trigger_info(
-        trigger_caption=trigger_caption,
-        trigger_xcom_key=trigger_xcom_key
+        trigger_caption=trigger_caption, trigger_xcom_key=trigger_xcom_key
     )
     run_command = CmdTask(
-        name='run-command',
-        icon='⚙️',
-        color='blue',
+        name="run-command",
+        icon="⚙️",
+        color="blue",
         inputs=[command_input],
         upstreams=[show_trigger_info],
         should_execute='{{ input.command != "" }}',
-        cmd='{{ input.command }}'
+        cmd="{{ input.command }}",
     )
     notify = Notifier(
-        name='notify',
-        icon='📢',
-        color='green',
+        name="notify",
+        icon="📢",
+        color="green",
         inputs=[message_input],
         title=notif_title,
-        message='{{ input.message }}',
+        message="{{ input.message }}",
         upstreams=[show_trigger_info],
         should_execute='{{ input.message != "" }}',
     )
     # return aggregator task
     return Task(
-        name='recurring-action',
+        name="recurring-action",
         inputs=[message_input, command_input],
         upstreams=[run_command, notify],
-        retry=0
+        retry=0,
     )
 
 
-def _create_show_trigger_info(
-    trigger_caption: str,
-    trigger_xcom_key: str
-) -> Task:
+def _create_show_trigger_info(trigger_caption: str, trigger_xcom_key: str) -> Task:
     @python_task(
-        name='show-trigger-info',
-        icon='🔍',
-        color='magenta',
+        name="show-trigger-info",
+        icon="🔍",
+        color="magenta",
     )
     def show_trigger_info(*args: Any, **kwargs: Any):
-        task: Task = kwargs.get('_task')
-        task.print_out(f'{trigger_caption}: {task.get_xcom(trigger_xcom_key)}')
+        task: Task = kwargs.get("_task")
+        task.print_out(f"{trigger_caption}: {task.get_xcom(trigger_xcom_key)}")
+
     return show_trigger_info