zrb 0.10.0__py3-none-any.whl → 0.11.2__py3-none-any.whl

zrb/builtin/project/add/plugin/plugin.py

@@ -0,0 +1,97 @@
+import os
+
+from zrb.builtin.project._helper import (
+    create_register_module,
+    validate_existing_project_dir,
+    validate_inexisting_automation,
+)
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add._group import project_add_group
+from zrb.builtin.project.add.plugin._input import (
+    package_author_email_input,
+    package_author_name_input,
+    package_description_input,
+    package_documentation_input,
+    package_homepage_input,
+    package_name_input,
+    package_repository_input,
+)
+from zrb.builtin.project.add.project_task import add_project_tasks
+from zrb.config.config import version
+from zrb.helper.accessories.color import colored
+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.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(name="validate", inputs=[project_dir_input, package_name_input])
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    package_name = kwargs.get("package_name")
+    validate_inexisting_automation(project_dir, package_name)
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        package_name_input,
+        package_description_input,
+        package_homepage_input,
+        package_repository_input,
+        package_documentation_input,
+        package_author_name_input,
+        package_author_email_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbPackageName": "{{input.package_name}}",
+        "zrbPackageDescription": "{{input.package_description}}",
+        "zrbPackageHomepage": "{{input.package_homepage}}",
+        "zrbPackageRepository": "{{input.package_repository}}",
+        "zrbPackageDocumentation": "{{input.package_documentation}}",
+        "zrbPackageAuthorName": "{{input.package_author_name}}",
+        "zrbPackageAuthorEmail": "{{input.package_author_email}}",
+        "zrbVersion": version,
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+register_plugin = create_register_module(
+    module_path="_automate.{{util.to_snake_case(input.package_name)}}",
+    alias="_automate_{{util.to_snake_case(input.package_name)}}",
+    inputs=[package_name_input],
+    upstreams=[copy_resource, add_project_tasks],
+    task_name="register-plugin",
+)
+
+
+@python_task(
+    name="plugin",
+    group=project_add_group,
+    description="Add plugin to project",
+    upstreams=[register_plugin],
+    inputs=[
+        project_dir_input,
+        package_name_input,
+        package_description_input,
+        package_homepage_input,
+        package_repository_input,
+        package_documentation_input,
+        package_author_name_input,
+        package_author_email_input,
+    ],
+    runner=runner,
+)
+async def add_plugin(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Plugin added", color="yellow"))

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/__init__.py

@@ -0,0 +1,22 @@
+import os
+import sys
+
+from ._group import snake_zrb_package_name_group
+from .build import build_snake_zrb_package_name
+from .prepare_venv.prepare_venv import prepare_snake_zrb_package_name_venv
+from .publish.publish import publish_snake_zrb_package_name
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_AUTOMATE_DIR = os.path.dirname(_CURRENT_DIR)
+_PROJECT_DIR = os.path.dirname(_AUTOMATE_DIR)
+_PLUGIN_SRC_DIR = os.path.join(_PROJECT_DIR, "src", "kebab-zrb-package-name", "src")
+if os.path.isdir(_PLUGIN_SRC_DIR):
+    sys.path.append(_PLUGIN_SRC_DIR)
+    import snake_zrb_package_name
+
+    assert snake_zrb_package_name
+
+assert snake_zrb_package_name_group
+assert build_snake_zrb_package_name
+assert prepare_snake_zrb_package_name_venv
+assert publish_snake_zrb_package_name

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/_group.py

@@ -0,0 +1,8 @@
+from zrb import Group
+from zrb.builtin import project_group
+
+snake_zrb_package_name_group = Group(
+    name="snake_zrb_package_name",
+    parent=project_group,
+    description="Manage human readable zrb package name",
+)

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/build/__init__.py

@@ -0,0 +1,3 @@
+from .build import build_snake_zrb_package_name
+
+assert build_snake_zrb_package_name

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/build/build.py

@@ -0,0 +1,27 @@
+import os
+
+from zrb import CmdTask, runner
+from ..._project import build_project
+from .._group import snake_zrb_package_name_group
+from ..prepare_venv import prepare_snake_zrb_package_name_venv
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_PKG_AUTOMATE_DIR = os.path.dirname(_CURRENT_DIR)
+_PROJECT_DIR = os.path.dirname(os.path.dirname(_PKG_AUTOMATE_DIR))
+_PKG_RESOURCE_DIR = os.path.join(_PROJECT_DIR, "src", "kebab-zrb-package-name")
+
+build_snake_zrb_package_name = CmdTask(
+    name="build",
+    description="Build human readable zrb package name",
+    group=snake_zrb_package_name_group,
+    upstreams=[prepare_snake_zrb_package_name_venv],
+    cwd=_PKG_RESOURCE_DIR,
+    cmd_path=[
+        os.path.join(_PKG_AUTOMATE_DIR, "activate-venv.sh"),
+        os.path.join(_CURRENT_DIR, "build.sh"),
+    ],
+)
+
+build_snake_zrb_package_name >> build_project
+
+runner.register(build_snake_zrb_package_name)

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/prepare_venv/__init__.py

@@ -0,0 +1,3 @@
+from .prepare_venv import prepare_snake_zrb_package_name_venv
+
+assert prepare_snake_zrb_package_name_venv

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/prepare_venv/prepare_venv.py

@@ -0,0 +1,22 @@
+import os
+
+from zrb import CmdTask, runner
+
+from .._group import snake_zrb_package_name_group
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_PKG_AUTOMATE_DIR = os.path.dirname(_CURRENT_DIR)
+_PROJECT_DIR = os.path.dirname(os.path.dirname(_PKG_AUTOMATE_DIR))
+_PKG_RESOURCE_DIR = os.path.join(_PROJECT_DIR, "src", "kebab-zrb-package-name")
+
+prepare_snake_zrb_package_name_venv = CmdTask(
+    name="prepare-venv",
+    description="Prepare human readable zrb package name venv",
+    group=snake_zrb_package_name_group,
+    cwd=_PKG_RESOURCE_DIR,
+    cmd_path=[
+        os.path.join(_PKG_AUTOMATE_DIR, "activate-venv.sh"),
+        os.path.join(_CURRENT_DIR, "prepare-venv.sh"),
+    ],
+)
+runner.register(prepare_snake_zrb_package_name_venv)

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/publish/__init__.py

@@ -0,0 +1,3 @@
+from .publish import publish_snake_zrb_package_name
+
+assert publish_snake_zrb_package_name

zrb/builtin/project/add/plugin/template/_automate/snake_zrb_package_name/publish/publish.py

@@ -0,0 +1,28 @@
+import os
+
+from zrb import CmdTask, runner
+
+from ..._project import publish_project
+from .._group import snake_zrb_package_name_group
+from ..build import build_snake_zrb_package_name
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_PKG_AUTOMATE_DIR = os.path.dirname(_CURRENT_DIR)
+_PROJECT_DIR = os.path.dirname(os.path.dirname(_PKG_AUTOMATE_DIR))
+_PKG_RESOURCE_DIR = os.path.join(_PROJECT_DIR, "src", "kebab-zrb-package-name")
+
+publish_snake_zrb_package_name = CmdTask(
+    name="publish",
+    description="Publish human readable zrb package name",
+    group=snake_zrb_package_name_group,
+    upstreams=[build_snake_zrb_package_name],
+    cwd=_PKG_RESOURCE_DIR,
+    cmd_path=[
+        os.path.join(_PKG_AUTOMATE_DIR, "activate-venv.sh"),
+        os.path.join(_CURRENT_DIR, "publish.sh"),
+    ],
+)
+
+publish_snake_zrb_package_name >> publish_project
+
+runner.register(publish_snake_zrb_package_name)

zrb/builtin/project/add/project_task/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.project_task.add import add_project_tasks
+
+assert add_project_tasks

zrb/builtin/project/add/project_task/add.py

@@ -0,0 +1,37 @@
+import os
+
+from zrb.builtin.project._input import project_dir_input
+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.copy_tree import copy_tree
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typing import Any
+from zrb.task.decorator import python_task
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(
+    name="add-project-tasks",
+    inputs=[project_dir_input],
+)
+async def add_project_tasks(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    project_dir = kwargs.get("project_dir", ".")
+    task.print_out("Create project tasks if not exist")
+    if os.path.exists(os.path.join(project_dir, "_automate", "_project")):
+        return
+    await copy_tree(
+        src=os.path.join(_CURRENT_DIR, "template"),
+        dst=project_dir,
+        excludes=["*/__pycache__"],
+    )
+    zrb_init_path = os.path.join(project_dir, "zrb_init.py")
+    code = await read_text_file_async(zrb_init_path)
+    import_alias = "_automate_project"
+    code = add_import_module(
+        code=code, module_path="_automate._project", alias="_automate_project"
+    )
+    code = add_assert_resource(code, import_alias)
+    await write_text_file_async(zrb_init_path, code)

zrb/builtin/project/add/project_task/template/_automate/_project/__init__.py

@@ -0,0 +1,27 @@
+from .build import build_project
+from .container import (
+    project_container_group,
+    remove_project_containers,
+    start_project_containers,
+    stop_project_containers,
+)
+from .deploy import deploy_project
+from .destroy import destroy_project
+from .get_env import get_project_env
+from .image import build_project_images, project_image_group, push_project_images
+from .publish import publish_project
+from .start import start_project
+
+assert project_container_group
+assert project_image_group
+assert remove_project_containers
+assert start_project_containers
+assert stop_project_containers
+assert build_project_images
+assert push_project_images
+assert build_project
+assert deploy_project
+assert destroy_project
+assert get_project_env
+assert publish_project
+assert start_project

zrb/builtin/project/add/project_task/template/_automate/_project/_group.py

@@ -0,0 +1,3 @@
+from zrb import Group
+
+project_group = Group(name="project")

zrb/builtin/project/add/project_task/template/_automate/_project/build.py

@@ -0,0 +1,15 @@
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+
+@python_task(
+    name="build",
+    group=project_group,
+    description="Build project artifacts",
+    runner=runner,
+)
+def build_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project artifact built", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/container/__init__.py

@@ -0,0 +1,9 @@
+from ._group import project_container_group
+from .remove import remove_project_containers
+from .start import start_project_containers
+from .stop import stop_project_containers
+
+assert project_container_group
+assert remove_project_containers
+assert start_project_containers
+assert stop_project_containers

zrb/builtin/project/add/project_task/template/_automate/_project/container/_group.py

@@ -0,0 +1,6 @@
+from zrb import Group
+from zrb.builtin import project_group
+
+project_container_group = Group(
+    name="container", parent=project_group, description="Manage project containers"
+)

zrb/builtin/project/add/project_task/template/_automate/_project/container/remove.py

@@ -0,0 +1,16 @@
+from zrb import Task, python_task, runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+from ._group import project_container_group
+
+
+@python_task(
+    name="remove",
+    group=project_container_group,
+    description="Remove project containers",
+    runner=runner,
+)
+def remove_project_containers(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project containers removed", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/container/start.py

@@ -0,0 +1,16 @@
+from zrb import Task, python_task, runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+from ._group import project_container_group
+
+
+@python_task(
+    name="start",
+    group=project_container_group,
+    description="Start project containers",
+    runner=runner,
+)
+def start_project_containers(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project containers started", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/container/stop.py

@@ -0,0 +1,16 @@
+from zrb import Task, python_task, runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+from ._group import project_container_group
+
+
+@python_task(
+    name="stop",
+    group=project_container_group,
+    description="Stop project containers",
+    runner=runner,
+)
+def stop_project_containers(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project containers stoped", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/deploy.py

@@ -0,0 +1,12 @@
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+
+@python_task(
+    name="deploy", group=project_group, description="Deploy project", runner=runner
+)
+def deploy_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project deployed", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/destroy.py

@@ -0,0 +1,15 @@
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+
+@python_task(
+    name="destroy",
+    group=project_group,
+    description="Destroy project deployment",
+    runner=runner,
+)
+def destroy_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project deployment destroyed", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/get_env.py

@@ -0,0 +1,28 @@
+from zrb import BoolInput, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.env_map.fetch import fetch_env_map_from_group
+from zrb.helper.typing import Any, Mapping
+
+
+@python_task(
+    name="get-env",
+    description="Get default values for project environments",
+    inputs=[
+        BoolInput(
+            name="export",
+            shortcut="e",
+            description="Whether add export statement or not",
+            default=True,
+        )
+    ],
+    group=project_group,
+    runner=runner,
+)
+async def get_project_env(*args: Any, **kwargs: Any) -> str:
+    env_map: Mapping[str, str] = {}
+    env_map = fetch_env_map_from_group(env_map, project_group)
+    env_keys = list(env_map.keys())
+    env_keys.sort()
+    should_export = kwargs.get("export", True)
+    export_prefix = "export " if should_export else ""
+    return "\n".join([f"{export_prefix}{key}={env_map[key]}" for key in env_keys])

zrb/builtin/project/add/project_task/template/_automate/_project/image/__init__.py

@@ -0,0 +1,7 @@
+from ._group import project_image_group
+from .build import build_project_images
+from .push import push_project_images
+
+assert project_image_group
+assert build_project_images
+assert push_project_images

zrb/builtin/project/add/project_task/template/_automate/_project/image/_group.py

@@ -0,0 +1,6 @@
+from zrb import Group
+from zrb.builtin import project_group
+
+project_image_group = Group(
+    name="image", parent=project_group, description="Manage project images"
+)

zrb/builtin/project/add/project_task/template/_automate/_project/image/build.py

@@ -0,0 +1,16 @@
+from zrb import Task, python_task, runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+from ._group import project_image_group
+
+
+@python_task(
+    name="build",
+    group=project_image_group,
+    description="Build project images",
+    runner=runner,
+)
+def build_project_images(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project images built", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/image/push.py

@@ -0,0 +1,16 @@
+from zrb import Task, python_task, runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+from ._group import project_image_group
+
+
+@python_task(
+    name="push",
+    group=project_image_group,
+    description="Push project images",
+    runner=runner,
+)
+def push_project_images(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project images pushed", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/publish.py

@@ -0,0 +1,15 @@
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+
+@python_task(
+    name="publish",
+    group=project_group,
+    description="Publish project artifacts",
+    runner=runner,
+)
+def publish_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project artifact published", color="yellow"))

zrb/builtin/project/add/project_task/template/_automate/_project/start.py

@@ -0,0 +1,12 @@
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+
+
+@python_task(
+    name="start", group=project_group, description="Start project", runner=runner
+)
+def start_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project started", color="yellow"))

zrb/builtin/project/add/task/__init__.py

@@ -0,0 +1,9 @@
+from zrb.builtin.project.add.task._group import project_add_task_group
+from zrb.builtin.project.add.task.cmd import add_cmd_task
+from zrb.builtin.project.add.task.docker_compose import add_docker_compose_task
+from zrb.builtin.project.add.task.python import add_python_task
+
+assert project_add_task_group
+assert add_cmd_task
+assert add_docker_compose_task
+assert add_python_task

zrb/builtin/project/add/task/_group.py

@@ -0,0 +1,6 @@
+from zrb.builtin.project.add._group import project_add_group
+from zrb.task_group.group import Group
+
+project_add_task_group = Group(
+    name="task", description="Add task to project", parent=project_add_group
+)

zrb/builtin/project/add/task/_input.py

@@ -0,0 +1,10 @@
+from zrb.helper.accessories.name import get_random_name
+from zrb.task_input.str_input import StrInput
+
+task_name_input = StrInput(
+    name="task-name",
+    shortcut="t",
+    description="Task name",
+    prompt="Task name",
+    default=f"run-{get_random_name()}",
+)

zrb/builtin/project/add/task/cmd/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.task.cmd.add import add_cmd_task
+
+assert add_cmd_task

zrb/builtin/project/add/task/cmd/add.py

@@ -0,0 +1,64 @@
+import os
+
+from zrb.builtin.project._helper import (
+    create_register_module,
+    validate_existing_project_dir,
+    validate_inexisting_automation,
+)
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.task._group import project_add_task_group
+from zrb.builtin.project.add.task._input import task_name_input
+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.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(
+    name="validate",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+    ],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    task_name = kwargs.get("task_name")
+    validate_inexisting_automation(project_dir, task_name)
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbTaskName": "{{input.task_name}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+register_module = create_register_module(
+    module_path="_automate.{{util.to_snake_case(input.task_name)}}",
+    alias="_automate_{{util.to_snake_case(input.task_name)}}",
+    inputs=[task_name_input],
+    upstreams=[copy_resource],
+)
+
+
+@python_task(
+    name="cmd", group=project_add_task_group, upstreams=[register_module], runner=runner
+)
+async def add_cmd_task(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

zrb/builtin/project/add/task/cmd/template/_automate/snake_zrb_task_name.py

@@ -0,0 +1,10 @@
+from zrb import CmdTask, runner
+from zrb.builtin import project_group
+
+snake_zrb_task_name = CmdTask(
+    name="kebab-zrb-task-name",
+    description="human readable zrb task name",
+    group=project_group,
+    cmd=["echo human readable zrb task name"],
+)
+runner.register(snake_zrb_task_name)

zrb/builtin/project/add/task/docker_compose/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.task.docker_compose.add import add_docker_compose_task
+
+assert add_docker_compose_task