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

zrb/builtin/generator/app_generator/template/build-custom-image/_automate/generate_snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/deployment.py

@@ -1,28 +1,32 @@
+import os
+
 from zrb import CmdTask, Env, EnvFile, IntInput, StrInput, runner
 from zrb.builtin.group import project_group
-from .image import push_snake_zrb_app_name_image, image_input, image_env
+
 from ._common import (
-    CURRENT_DIR, DEPLOYMENT_DIR, APP_TEMPLATE_ENV_FILE_NAME,
-    DEPLOYMENT_TEMPLATE_ENV_FILE_NAME
+    APP_TEMPLATE_ENV_FILE_NAME,
+    CURRENT_DIR,
+    DEPLOYMENT_DIR,
+    DEPLOYMENT_TEMPLATE_ENV_FILE_NAME,
 )
-import os
+from .image import image_env, image_input, push_snake_zrb_app_name_image
 
 ###############################################################################
 # 🔤 Input Definitions
 ###############################################################################
 
 replica_input = IntInput(
-    name='kebab-zrb-app-name-replica',
+    name="kebab-zrb-app-name-replica",
     description='Replica of "kebab-zrb-app-name"',
     prompt='Replica of "kebab-zrb-app-name"',
     default=1,
 )
 
 pulumi_stack_input = StrInput(
-    name='kebab-zrb-app-name-pulumi-stack',
+    name="kebab-zrb-app-name-pulumi-stack",
     description='Pulumi stack name for "kebab-zrb-app-name"',
     prompt='Pulumi stack name for "kebab-zrb-app-name"',
-    default=os.getenv('ZRB_ENV', 'dev')
+    default=os.getenv("ZRB_ENV", "dev"),
 )
 
 ###############################################################################
@@ -30,13 +34,11 @@ pulumi_stack_input = StrInput(
 ###############################################################################
 
 deployment_app_env_file = EnvFile(
-    path=APP_TEMPLATE_ENV_FILE_NAME,
-    prefix='DEPLOYMENT_APP_ZRB_ENV_PREFIX'
+    path=APP_TEMPLATE_ENV_FILE_NAME, prefix="DEPLOYMENT_APP_ZRB_ENV_PREFIX"
 )
 
 deployment_config_env_file = EnvFile(
-    path=DEPLOYMENT_TEMPLATE_ENV_FILE_NAME,
-    prefix='DEPLOYMENT_CONFIG_ZRB_ENV_PREFIX'
+    path=DEPLOYMENT_TEMPLATE_ENV_FILE_NAME, prefix="DEPLOYMENT_CONFIG_ZRB_ENV_PREFIX"
 )
 
 ###############################################################################
@@ -44,21 +46,21 @@ deployment_config_env_file = EnvFile(
 ###############################################################################
 
 pulumi_backend_url_env = Env(
-    name='PULUMI_BACKEND_URL',
-    os_name='PULUMI_ZRB_ENV_PREFIX_BACKEND_URL',
-    default=f'file://{DEPLOYMENT_DIR}/state'
+    name="PULUMI_BACKEND_URL",
+    os_name="PULUMI_ZRB_ENV_PREFIX_BACKEND_URL",
+    default=f"file://{DEPLOYMENT_DIR}/state",
 )
 
 pulumi_config_passphrase_env = Env(
-    name='PULUMI_CONFIG_PASSPHRASE',
-    os_name='PULUMI_ZRB_ENV_PREFIX_CONFIG_PASSPHRASE',
-    default='secret'
+    name="PULUMI_CONFIG_PASSPHRASE",
+    os_name="PULUMI_ZRB_ENV_PREFIX_CONFIG_PASSPHRASE",
+    default="secret",
 )
 
 deployment_replica_env = Env(
-    name='REPLICA',
-    os_name='DEPLOYMENT_ZRB_ENV_PREFIX',
-    default='{{input.snake_zrb_app_name_replica}}'
+    name="REPLICA",
+    os_name="DEPLOYMENT_ZRB_ENV_PREFIX",
+    default="{{input.snake_zrb_app_name_replica}}",
 )
 
 ###############################################################################
@@ -66,9 +68,9 @@ deployment_replica_env = Env(
 ###############################################################################
 
 deploy_snake_zrb_app_name = CmdTask(
-    icon='🚧',
-    name='deploy-kebab-zrb-app-name',
-    description='Deploy human readable zrb app name',
+    icon="🚧",
+    name="deploy-kebab-zrb-app-name",
+    description="Deploy human readable zrb app name",
     group=project_group,
     inputs=[
         image_input,
@@ -88,9 +90,9 @@ deploy_snake_zrb_app_name = CmdTask(
         deployment_replica_env,
     ],
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-init-stack.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-up.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "pulumi-init-stack.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "pulumi-up.sh"),
+    ],
 )
 runner.register(deploy_snake_zrb_app_name)
 
@@ -99,9 +101,9 @@ runner.register(deploy_snake_zrb_app_name)
 ###############################################################################
 
 destroy_snake_zrb_app_name = CmdTask(
-    icon='💨',
-    name='destroy-kebab-zrb-app-name',
-    description='Remove human readable zrb app name deployment',
+    icon="💨",
+    name="destroy-kebab-zrb-app-name",
+    description="Remove human readable zrb app name deployment",
     group=project_group,
     inputs=[
         pulumi_stack_input,
@@ -118,8 +120,8 @@ destroy_snake_zrb_app_name = CmdTask(
         deployment_replica_env,
     ],
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-init-stack.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-destroy.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "pulumi-init-stack.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "pulumi-destroy.sh"),
+    ],
 )
 runner.register(destroy_snake_zrb_app_name)

zrb/builtin/generator/app_generator/template/build-custom-image/_automate/generate_snake_zrb_meta_template_name/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/app_generator/template/build-custom-image/_automate/generate_snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/local.py

@@ -1,48 +1,48 @@
+import os
+
 from zrb import CmdTask, Env, EnvFile, runner
 from zrb.builtin.group import project_group
+
+from ._checker import snake_zrb_app_name_checker
 from ._common import (
-    CURRENT_DIR, APP_DIR, APP_TEMPLATE_ENV_FILE_NAME, local_input, host_input
+    APP_DIR,
+    APP_TEMPLATE_ENV_FILE_NAME,
+    CURRENT_DIR,
+    host_input,
+    local_input,
 )
-from ._checker import snake_zrb_app_name_checker
-import os
 
 ###############################################################################
 # 🌳 Env File Definitions
 ###############################################################################
 
-app_env_file = EnvFile(
-    path=APP_TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX'
-)
+app_env_file = EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="ZRB_ENV_PREFIX")
 
 ###############################################################################
 # ⚙️ start_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,
     ],
-    should_execute='{{input.local_snake_zrb_app_name}}',
+    should_execute="{{input.local_snake_zrb_app_name}}",
     cwd=APP_DIR,
     env_files=[app_env_file],
     envs=[
-        Env(
-            name='APP_PORT',
-            os_name='ZRB_ENV_PREFIX_APP_PORT',
-            default='zrbAppPort'
-        )
+        Env(name="APP_PORT", os_name="ZRB_ENV_PREFIX_APP_PORT", default="zrbAppPort")
     ],
     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=[
         snake_zrb_app_name_checker,
-    ]
+    ],
 )
 runner.register(start_snake_zrb_app_name)

zrb/builtin/generator/app_generator/template/http-port/_automate/generate_snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/_checker.py

@@ -1,17 +1,17 @@
 from zrb import HTTPChecker
 
 snake_zrb_app_name_checker = HTTPChecker(
-    name='check-kebab-zrb-app-name',
-    is_https='{{input.snake_zrb_app_name_https}}',
-    host='{{input.snake_zrb_app_name_host}}',
-    port='{{env.APP_PORT}}',
-    url='/'
+    name="check-kebab-zrb-app-name",
+    is_https="{{input.snake_zrb_app_name_https}}",
+    host="{{input.snake_zrb_app_name_host}}",
+    port="{{env.APP_PORT}}",
+    url="/",
 )
 
 snake_zrb_app_name_container_checker = HTTPChecker(
-    name='check-kebab-zrb-app-name',
-    is_https='{{input.snake_zrb_app_name_https}}',
-    host='{{input.snake_zrb_app_name_host}}',
-    port='{{env.HOST_PORT}}',
-    url='/'
+    name="check-kebab-zrb-app-name",
+    is_https="{{input.snake_zrb_app_name_https}}",
+    host="{{input.snake_zrb_app_name_host}}",
+    port="{{env.HOST_PORT}}",
+    url="/",
 )

zrb/builtin/generator/app_generator/template/http-port-build-custom-image/_automate/generate_snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/local.py

@@ -1,50 +1,50 @@
+import os
+
 from zrb import CmdTask, Env, EnvFile, runner
 from zrb.builtin.group import project_group
+
+from ._checker import snake_zrb_app_name_checker
 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,
 )
-from ._checker import snake_zrb_app_name_checker
-import os
 
 ###############################################################################
 # 🌳 Env File Definitions
 ###############################################################################
 
-app_env_file = EnvFile(
-    path=APP_TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX'
-)
+app_env_file = EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="ZRB_ENV_PREFIX")
 
 ###############################################################################
 # Task Definitions
 ###############################################################################
 
 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}}',
+    should_execute="{{ input.local_snake_zrb_app_name}}",
     cwd=APP_DIR,
     env_files=[app_env_file],
     envs=[
-        Env(
-            name='APP_PORT',
-            os_name='ZRB_ENV_PREFIX_APP_PORT',
-            default='zrbAppPort'
-        )
+        Env(name="APP_PORT", os_name="ZRB_ENV_PREFIX_APP_PORT", default="zrbAppPort")
     ],
     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=[
         snake_zrb_app_name_checker,
-    ]
+    ],
 )
 runner.register(start_snake_zrb_app_name)

zrb/builtin/generator/app_generator/template/use-helm/_automate/generate_snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/deployment/__main__.py

@@ -1,25 +1,23 @@
-'''A Kubernetes Python Pulumi program to deploy kebab-zrb-app-name'''
+"""A Kubernetes Python Pulumi program to deploy kebab-zrb-app-name"""
 
-from pulumi_kubernetes.helm.v3 import Chart, LocalChartOpts
-import pulumi
 import os
 
+import pulumi
+from pulumi_kubernetes.helm.v3 import Chart, LocalChartOpts
+
 CURRENT_DIR = os.path.dirname(__file__)
-NAMESPACE = os.getenv('NAMESPACE', 'default')
+NAMESPACE = os.getenv("NAMESPACE", "default")
 
-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"}
 
 # https://www.pulumi.com/registry/packages/kubernetes/api-docs/helm/v3/chart/#local-chart-directory  # noqa
 release = Chart(
-    'kebab-zrb-app-name',
+    "kebab-zrb-app-name",
     LocalChartOpts(
-        path='./helm-charts/kebab-zrb-app-name',
-        namespace=NAMESPACE,
-        values={
-        }
-    )
+        path="./helm-charts/kebab-zrb-app-name", namespace=NAMESPACE, values={}
+    ),
 )
 
-pulumi.export('helm-release', release.resources)
+pulumi.export("helm-release", release.resources)

zrb/builtin/generator/cmd_task/add.py

@@ -1,16 +1,17 @@
-from zrb.helper.typing import Any
-from zrb.builtin.generator.common.task_input import project_dir_input, task_name_input
+import os
+
 from zrb.builtin.generator.common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
+    validate_existing_project_dir,
+    validate_inexisting_automation,
 )
 from zrb.builtin.generator.common.task_factory import create_register_module
+from zrb.builtin.generator.common.task_input import project_dir_input, task_name_input
 from zrb.builtin.group import project_add_group
-from zrb.task.task import Task
+from zrb.helper.typing import Any
+from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.resource_maker import ResourceMaker
-from zrb.runner import runner
-
-import os
+from zrb.task.task import Task
 
 CURRENT_DIR = os.path.dirname(__file__)
 
@@ -20,49 +21,46 @@ CURRENT_DIR = os.path.dirname(__file__)
 
 
 @python_task(
-    name='validate',
+    name="validate",
     inputs=[
         project_dir_input,
         task_name_input,
-    ]
+    ],
 )
 async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get('project_dir')
+    project_dir = kwargs.get("project_dir")
     validate_existing_project_dir(project_dir)
-    task_name = kwargs.get('task_name')
+    task_name = kwargs.get("task_name")
     validate_inexisting_automation(project_dir, task_name)
 
 
 copy_resource = ResourceMaker(
-    name='copy-resource',
+    name="copy-resource",
     inputs=[
         project_dir_input,
         task_name_input,
     ],
     upstreams=[validate],
     replacements={
-        'zrbTaskName': '{{input.task_name}}',
+        "zrbTaskName": "{{input.task_name}}",
     },
-    template_path=os.path.join(CURRENT_DIR, 'template'),
-    destination_path='{{ input.project_dir }}',
+    template_path=os.path.join(CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
     excludes=[
-        '*/__pycache__',
-    ]
+        "*/__pycache__",
+    ],
 )
 
 register_module = create_register_module(
-    module_path='_automate.{{util.to_snake_case(input.task_name)}}',
+    module_path="_automate.{{util.to_snake_case(input.task_name)}}",
     inputs=[task_name_input],
-    upstreams=[copy_resource]
+    upstreams=[copy_resource],
 )
 
 
 @python_task(
-    name='cmd-task',
-    group=project_add_group,
-    upstreams=[register_module],
-    runner=runner
+    name="cmd-task", group=project_add_group, upstreams=[register_module], runner=runner
 )
 async def add_cmd_task(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get('_task')
-    task.print_out('Success')
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

zrb/builtin/generator/cmd_task/template/_automate/snake_zrb_task_name.py

@@ -6,11 +6,9 @@ from zrb.builtin.group import project_group
 ###############################################################################
 
 snake_zrb_task_name = CmdTask(
-    name='kebab-zrb-task-name',
-    description='human readable zrb task name',
+    name="kebab-zrb-task-name",
+    description="human readable zrb task name",
     group=project_group,
-    cmd=[
-        'echo human readable zrb task name'
-    ]
+    cmd=["echo human readable zrb task name"],
 )
 runner.register(snake_zrb_task_name)

zrb/builtin/generator/common/helper.py

@@ -1,16 +1,17 @@
-from zrb.helper.typing import Optional
-from zrb.helper.typecheck import typechecked
+import os
+
+from zrb.helper import util
 from zrb.helper.codemod.add_assert_resource import add_assert_resource
 from zrb.helper.codemod.add_import_module import add_import_module
 from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper import util
-import os
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Optional
 
 
 @typechecked
 def validate_existing_project_dir(project_dir: str):
-    if not os.path.isfile(os.path.join(project_dir, 'zrb_init.py')):
-        raise Exception(f'Not a project: {project_dir}')
+    if not os.path.isfile(os.path.join(project_dir, "zrb_init.py")):
+        raise Exception(f"Not a project: {project_dir}")
 
 
 @typechecked
@@ -20,38 +21,32 @@ def validate_inexisting_automation(project_dir: str, automation_name: str):
 
 
 @typechecked
-def validate_inexisting_automation_package(
-    project_dir: str, package_name: str
-):
+def validate_inexisting_automation_package(project_dir: str, package_name: str):
     package_dir = os.path.join(
-        project_dir, '_automate', f'{util.to_snake_case(package_name)}'
+        project_dir, "_automate", f"{util.to_snake_case(package_name)}"
     )
     if os.path.exists(package_dir):
-        raise Exception(f'Automation package already exists: {package_dir}')
+        raise Exception(f"Automation package already exists: {package_dir}")
 
 
 @typechecked
 def validate_inexisting_automation_module(project_dir: str, module_name: str):
     module_file = os.path.join(
-        project_dir, '_automate', f'{util.to_snake_case(module_name)}.py'
+        project_dir, "_automate", f"{util.to_snake_case(module_name)}.py"
     )
     if os.path.exists(module_file):
-        raise Exception(f'Automation module already exists: {module_file}')
+        raise Exception(f"Automation module already exists: {module_file}")
 
 
 @typechecked
 async def register_module_to_project(
     project_dir: str, module_path: str, alias: Optional[str] = None
 ):
-    zrb_init_path = os.path.join(project_dir, 'zrb_init.py')
+    zrb_init_path = os.path.join(project_dir, "zrb_init.py")
     code = await read_text_file_async(zrb_init_path)
     if alias is None:
-        alias = module_path.split('.')[-1]
-    code = add_import_module(
-        code=code,
-        module_path=module_path,
-        alias=alias
-    )
+        alias = module_path.split(".")[-1]
+    code = add_import_module(code=code, module_path=module_path, alias=alias)
     code = add_assert_resource(code, alias)
     await write_text_file_async(zrb_init_path, code)
     return True