zrb 0.28.0__py3-none-any.whl → 1.0.0a5__py3-none-any.whl

zrb-1.0.0a5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

zrb-1.0.0a5.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+zrb=zrb.__main__:serve_cli
+

zrb/action/runner.py

@@ -1,127 +0,0 @@
-from collections.abc import Callable, Mapping
-from typing import Any, Union
-
-import click
-
-from zrb.helper.accessories.color import colored
-from zrb.helper.asyncio_task import stop_asyncio_sync
-from zrb.helper.log import logger
-from zrb.helper.typecheck import typechecked
-from zrb.task.any_task import AnyTask
-from zrb.task_group.group import Group as TaskGroup
-
-logger.debug(colored("Loading zrb.action.runner", attrs=["dark"]))
-
-CliSubcommand = Union[click.Group, click.Command]
-
-
-@typechecked
-class Runner:
-    """
-    Runner class.
-    Any tasks registered to the runner will be accessible from the terminal
-    """
-
-    def __init__(self, env_prefix: str = ""):
-        logger.info(colored("Create runner", attrs=["dark"]))
-        self.__env_prefix = env_prefix
-        self.__tasks: list[AnyTask] = []
-        self.__registered_groups: Mapping[str, click.Group] = {}
-        self.__top_levels: list[CliSubcommand] = []
-        self.__subcommands: Mapping[str, list[click.Group]] = {}
-        self.__registered_task_cli_name: list[str] = []
-        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')
-            logger.debug(colored(f'Register task: "{cli_name}"', attrs=["dark"]))
-            self.__tasks.append(task)
-            self.__registered_task_cli_name.append(cli_name)
-            logger.debug(colored(f'Task registered: "{cli_name}"', attrs=["dark"]))
-
-    def serve(self, cli: click.Group) -> click.Group:
-        for task in self.__tasks:
-            subcommand = self.__create_cli_subcommand(task)
-            if subcommand not in self.__top_levels:
-                self.__top_levels.append(subcommand)
-                cli.add_command(subcommand)
-        return cli
-
-    def __create_cli_subcommand(
-        self, task: AnyTask
-    ) -> Union[click.Group, click.Command]:
-        subcommand: CliSubcommand = self.__create_cli_command(task)
-        task_group = task._group
-        while task_group is not None:
-            group = self.__register_sub_command(task_group, subcommand)
-            parent_group = task_group.get_parent()
-            if parent_group is None:
-                return group
-            subcommand = group
-            task_group = parent_group
-        return subcommand
-
-    def __register_sub_command(
-        self, task_group: TaskGroup, subcommand: CliSubcommand
-    ) -> click.Group:
-        task_group_id = task_group._get_full_cli_name()
-        group = self.__get_cli_group(task_group)
-        if task_group_id not in self.__subcommands:
-            self.__subcommands[task_group_id] = []
-        if subcommand not in self.__subcommands[task_group_id]:
-            group.add_command(subcommand)
-            self.__subcommands[task_group_id].append(subcommand)
-        return group
-
-    def __get_cli_group(self, task_group: TaskGroup) -> click.Group:
-        task_group_id = task_group._get_full_cli_name()
-        if task_group_id in self.__registered_groups:
-            return self.__registered_groups[task_group_id]
-        group_cli_name = task_group.get_cli_name()
-        group_description = task_group.get_description()
-        group = click.Group(name=group_cli_name, help=group_description)
-        self.__registered_groups[task_group_id] = group
-        return group
-
-    def __create_cli_command(self, task: AnyTask) -> click.Command:
-        task_inputs = task._get_combined_inputs()
-        task_cli_name = task.get_cli_name()
-        task_description = task.get_description()
-        callback = self.__get_wrapped_task_function(task)
-        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))
-        # add task inputs,
-        # if there are inputs with the same name, choose the first.
-        registered_input: Mapping[str, bool] = {}
-        for task_input in task_inputs:
-            if task_input.get_name() in registered_input:
-                continue
-            registered_input[task_input.get_name()] = True
-            param_decl = task_input.get_param_decl()
-            options = task_input.get_options()
-            command.params.append(click.Option(param_decl, **options))
-        return command
-
-    def __get_wrapped_task_function(self, task: AnyTask) -> Callable[..., Any]:
-        def wrapped_function(*args: Any, **kwargs: Any) -> Any:
-            function = task.to_function(
-                env_prefix=self.__env_prefix,
-                raise_error=True,
-                should_clear_xcom=True,
-                should_stop_looper=True,
-            )
-            try:
-                function(*args, **kwargs)
-            except Exception:
-                stop_asyncio_sync()
-            finally:
-                task.clear_xcom()
-
-        return wrapped_function

zrb/advertisement.py

@@ -1,21 +0,0 @@
-from zrb.helper.accessories.color import colored
-from zrb.helper.advertisement import Advertisement
-from zrb.helper.log import logger
-
-logger.debug(colored("Loading zrb.advertisement", attrs=["dark"]))
-
-# 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=".*",
-    ),
-]

zrb/builtin/_helper/reccuring_action.py

@@ -1,45 +0,0 @@
-from zrb.task.cmd_task import CmdTask
-from zrb.task.notifier import Notifier
-from zrb.task.task import Task
-from zrb.task_input.str_input import StrInput
-
-
-def create_recurring_action(
-    notif_title: str,
-    default_message: str = "👋",
-) -> Task:
-    # define inputs
-    message_input = StrInput(
-        name="message",
-        default=default_message,
-        prompt="Message to be shown",
-    )
-    command_input = StrInput(
-        name="command",
-        default="",
-        prompt="Command to be executed",
-    )
-    run_command = CmdTask(
-        name="run-command",
-        icon="⚙️",
-        color="blue",
-        inputs=[command_input],
-        should_execute='{{ input.command != "" }}',
-        cmd="{{ input.command }}",
-    )
-    notify = Notifier(
-        name="notify",
-        icon="📢",
-        color="green",
-        inputs=[message_input],
-        title=notif_title,
-        message="{{ input.message }}",
-        should_execute='{{ input.message != "" }}',
-    )
-    # return aggregator task
-    return Task(
-        name="recurring-action",
-        inputs=[message_input, command_input],
-        upstreams=[run_command, notify],
-        retry=0,
-    )

zrb/builtin/base64/__init__.py

@@ -1,7 +0,0 @@
-from zrb.builtin.base64._group import base64_group
-from zrb.builtin.base64.decode import decode_base64
-from zrb.builtin.base64.encode import encode_base64
-
-assert base64_group
-assert decode_base64
-assert encode_base64

zrb/builtin/base64/_group.py

@@ -1,3 +0,0 @@
-from zrb.task_group.group import Group
-
-base64_group = Group(name="base64", description="Base64 operations")

zrb/builtin/base64/_input.py

@@ -1,3 +0,0 @@
-from zrb.task_input.str_input import StrInput
-
-text_input = StrInput(name="text", shortcut="t", description="Text", default="")

zrb/builtin/base64/decode.py

@@ -1,21 +0,0 @@
-import base64
-from typing import Any
-
-from zrb.builtin.base64._group import base64_group
-from zrb.builtin.base64._input import text_input
-from zrb.runner import runner
-from zrb.task.decorator import python_task
-
-
-@python_task(
-    name="decode",
-    group=base64_group,
-    inputs=[text_input],
-    description="Decode a base64 encoded text",
-    retry=0,
-    runner=runner,
-)
-async def decode_base64(*args: str, **kwargs: Any):
-    text: str = kwargs.get("text", "")
-    encoded_text = base64.b64decode(text.encode())
-    return encoded_text.decode()

zrb/builtin/base64/encode.py

@@ -1,21 +0,0 @@
-import base64
-from typing import Any
-
-from zrb.builtin.base64._group import base64_group
-from zrb.builtin.base64._input import text_input
-from zrb.runner import runner
-from zrb.task.decorator import python_task
-
-
-@python_task(
-    name="encode",
-    group=base64_group,
-    inputs=[text_input],
-    description="Encode a text using base64 algorithm",
-    retry=0,
-    runner=runner,
-)
-async def encode_base64(*args: str, **kwargs: Any):
-    text: str = kwargs.get("text", "")
-    encoded_text = base64.b64encode(text.encode())
-    return encoded_text.decode()

zrb/builtin/devtool/__init__.py

@@ -1,37 +0,0 @@
-from zrb.builtin.devtool._group import devtool_group
-from zrb.builtin.devtool.install import (
-    devtool_install_group,
-    install_aws,
-    install_docker,
-    install_gcloud,
-    install_gvm,
-    install_helix,
-    install_helm,
-    install_kubectl,
-    install_nvm,
-    install_pulumi,
-    install_pyenv,
-    install_sdkman,
-    install_selenium,
-    install_terraform,
-    install_tmux,
-    install_zsh,
-)
-
-assert devtool_group
-assert devtool_install_group
-assert install_aws
-assert install_docker
-assert install_gcloud
-assert install_gvm
-assert install_helix
-assert install_helm
-assert install_kubectl
-assert install_nvm
-assert install_pulumi
-assert install_pyenv
-assert install_sdkman
-assert install_selenium
-assert install_terraform
-assert install_tmux
-assert install_zsh

zrb/builtin/devtool/_group.py

@@ -1,3 +0,0 @@
-from zrb.task_group.group import Group
-
-devtool_group = Group(name="devtool", description="Developer tools management")

zrb/builtin/devtool/install/__init__.py

@@ -1,33 +0,0 @@
-from zrb.builtin.devtool.install._group import devtool_install_group
-from zrb.builtin.devtool.install.aws.aws import install_aws
-from zrb.builtin.devtool.install.docker.docker import install_docker
-from zrb.builtin.devtool.install.gcloud.gcloud import install_gcloud
-from zrb.builtin.devtool.install.gvm.gvm import install_gvm
-from zrb.builtin.devtool.install.helix.helix import install_helix
-from zrb.builtin.devtool.install.helm.helm import install_helm
-from zrb.builtin.devtool.install.kubectl.kubectl import install_kubectl
-from zrb.builtin.devtool.install.nvm.nvm import install_nvm
-from zrb.builtin.devtool.install.pulumi.pulumi import install_pulumi
-from zrb.builtin.devtool.install.pyenv.pyenv import install_pyenv
-from zrb.builtin.devtool.install.sdkman.sdkman import install_sdkman
-from zrb.builtin.devtool.install.selenium.selenium import install_selenium
-from zrb.builtin.devtool.install.terraform.terraform import install_terraform
-from zrb.builtin.devtool.install.tmux.tmux import install_tmux
-from zrb.builtin.devtool.install.zsh.zsh import install_zsh
-
-assert devtool_install_group
-assert install_aws
-assert install_docker
-assert install_gcloud
-assert install_gvm
-assert install_helix
-assert install_helm
-assert install_kubectl
-assert install_nvm
-assert install_pulumi
-assert install_pyenv
-assert install_sdkman
-assert install_selenium
-assert install_terraform
-assert install_tmux
-assert install_zsh

zrb/builtin/devtool/install/_group.py

@@ -1,6 +0,0 @@
-from zrb.builtin.devtool._group import devtool_group
-from zrb.task_group.group import Group
-
-devtool_install_group = Group(
-    name="install", description="Install developer tools", parent=devtool_group
-)

zrb/builtin/devtool/install/_helper.py

@@ -1,33 +0,0 @@
-import os
-from collections.abc import Callable
-from typing import Any
-
-from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.task.task import Task
-
-
-@typechecked
-def write_config(
-    template_file: str, config_file: str, remove_old_config: bool = False
-) -> Callable[..., Any]:
-    async def set_config(*args, **kwargs):
-        task: Task = kwargs.get("_task")
-        rendered_config_file = os.path.expandvars(
-            os.path.expanduser(task.render_str(config_file))
-        )
-        rendered_template_file = os.path.expandvars(
-            os.path.expanduser(task.render_str(template_file))
-        )
-        if remove_old_config and os.path.exists(rendered_config_file):
-            task.print_out(f"Removing {rendered_config_file}")
-            os.remove(rendered_config_file)
-        additional_content = await read_text_file_async(rendered_template_file)
-        content = ""
-        if os.path.exists(rendered_config_file):
-            content = await read_text_file_async(rendered_config_file) + "\n"
-        new_content = content + additional_content
-        task.print_out(f"Writing content to {rendered_config_file}")
-        await write_text_file_async(rendered_config_file, new_content)
-
-    return set_config

zrb/builtin/devtool/install/_input.py

@@ -1,9 +0,0 @@
-from zrb.config.config import DEFAULT_SHELL
-from zrb.task_input.str_input import StrInput
-
-terminal_config_file_input = StrInput(
-    name="config-file",
-    shortcut="c",
-    prompt="Config file",
-    default="~/.zshrc" if DEFAULT_SHELL == "zsh" else "~/.bashrc",
-)

zrb/builtin/devtool/install/aws/aws.py

@@ -1,27 +0,0 @@
-import os
-
-from zrb.builtin.devtool.install._group import devtool_install_group
-from zrb.runner import runner
-from zrb.task.cmd_task import CmdTask
-from zrb.task.flow_task import FlowTask
-
-_CURRENT_DIR = os.path.dirname(__file__)
-_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
-
-install_aws = FlowTask(
-    name="aws",
-    group=devtool_install_group,
-    description="AWS CLI",
-    steps=[
-        CmdTask(
-            name="install-aws",
-            cmd_path=[
-                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
-                os.path.join(_CURRENT_DIR, "install.sh"),
-            ],
-            preexec_fn=None,
-        ),
-    ],
-    retry=0,
-)
-runner.register(install_aws)

zrb/builtin/devtool/install/aws/install.sh

@@ -1,60 +0,0 @@
-if [ ! -f "./awscliv2.zip" ]
-then
-    log_info "Download AWS CLI"
-    curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
-else
-    log_info "AWS CLI already downloaded"
-fi
-
-if command_exists unzip
-then
-    log_info "unzip is already installed."
-else
-    log_info "Installing unzip..."
-    if [ "$OS_TYPE" = "Darwin" ]
-    then
-        if command_exists brew
-        then
-            brew install unzip
-        else
-            log_info "Homebrew not found. Please install Homebrew and try again."
-            exit 1
-        fi
-    elif [ "$OS_TYPE" = "Linux" ]
-    then
-        if command_exists pkg
-        then
-            try_sudo pkg update
-            try_sudo pkg install -y unzip
-        elif command_exists apt
-        then
-            try_sudo add-apt-repository ppa:maveonair/unzip-editor -y
-            try_sudo apt update
-            try_sudo apt install -y unzip
-        elif command_exists yum
-        then
-            try_sudo yum install -y unzip
-        elif command_exists dnf
-        then
-            try_sudo dnf copr enable varlad/unzip
-            try_sudo dnf install -y unzip
-        elif command_exists pacman
-        then
-            try_sudo pacman -Syu --noconfirm unzip
-        elif command_exists snap
-        then
-            try_sudo snap install unzip
-        else
-            log_info "No known package manager found. Please install unzip manually."
-            exit 1
-        fi
-    else
-        log_info "Unsupported OS type. Please install unzip manually."
-        exit 1
-    fi
-fi
-
-log_info "Unzip AWS CLI"
-unzip awscliv2.zip
-log_info "Install AWS CLI"
-sudo ./aws/install --update

zrb/builtin/devtool/install/docker/docker.py

@@ -1,27 +0,0 @@
-import os
-
-from zrb.builtin.devtool.install._group import devtool_install_group
-from zrb.runner import runner
-from zrb.task.cmd_task import CmdTask
-from zrb.task.flow_task import FlowTask
-
-_CURRENT_DIR = os.path.dirname(__file__)
-_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
-
-install_docker = FlowTask(
-    name="docker",
-    group=devtool_install_group,
-    description="Most popular containerization platform",
-    steps=[
-        CmdTask(
-            name="install-docker",
-            cmd_path=[
-                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
-                os.path.join(_CURRENT_DIR, "install.sh"),
-            ],
-            preexec_fn=None,
-        ),
-    ],
-    retry=0,
-)
-runner.register(install_docker)

zrb/builtin/devtool/install/docker/install.sh

@@ -1,72 +0,0 @@
-# Install Docker
-if command_exists docker
-then
-    log_info "Docker is already installed."
-else
-    log_info "Installing Docker..."
-    if [ "$OS_TYPE" = "Darwin" ]
-    then
-        if command_exists brew
-        then
-            brew install --cask docker
-            log_info "Please start Docker Desktop before proceeding."
-        else
-            log_info "Homebrew not found. Please install Homebrew and try again."
-            exit 1
-        fi
-    elif [ "$OS_TYPE" = "Linux" ]
-    then
-        if command_exists apt
-        then
-            try_sudo apt update
-            try_sudo apt-get remove docker docker-engine docker.io containerd runc || true
-            try_sudo apt install -y apt-transport-https ca-certificates curl software-properties-common
-            curl -fsSL https://download.docker.com/linux/ubuntu/gpg |try_sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-            try_sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
-            log_info "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" |try_sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
-            try_sudo apt update
-            try_sudo apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
-        elif command_exists yum
-        then
-            try_sudo yum install -y docker
-            try_sudo systemctl start docker
-            try_sudo systemctl enable docker
-        elif command_exists dnf
-        then
-            try_sudo dnf install -y docker
-            try_sudo systemctl start docker
-            try_sudo systemctl enable docker
-        elif command_exists pacman
-        then
-            try_sudo pacman -Syu --noconfirm docker
-            try_sudo systemctl start docker
-            try_sudo systemctl enable docker
-        else
-            log_info "No known package manager found. Please install Docker manually."
-            exit 1
-        fi
-    else
-        log_info "Unsupported OS type. Please install Docker manually."
-        exit 1
-    fi
-fi
-
-# Install Docker Compose plugin for yum, dnf, and pacman
-if command_exists docker && ! docker compose version &> /dev/null
-then
-    log_info "Installing Docker Compose plugin..."
-    DOCKER_COMPOSE_VERSION=$(curl -s https://api.github.com/repos/docker/compose/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
-    curl -L "https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-linux-$(uname -m)" -o docker-compose
-    chmod +x docker-compose
-    mkdir -p ~/.docker/cli-plugins
-    mv docker-compose ~/.docker/cli-plugins/docker-compose
-fi
-
-# Check Docker Compose plugin installation
-if command_exists docker && docker compose version &> /dev/null
-then
-    log_info "Docker Compose plugin is already installed."
-else
-    log_info "Docker Compose plugin is not installed or Docker is not running. Please check your installation."
-    exit 1
-fi

zrb/builtin/devtool/install/gcloud/gcloud.py

@@ -1,27 +0,0 @@
-import os
-
-from zrb.builtin.devtool.install._group import devtool_install_group
-from zrb.runner import runner
-from zrb.task.cmd_task import CmdTask
-from zrb.task.flow_task import FlowTask
-
-_CURRENT_DIR = os.path.dirname(__file__)
-_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
-
-install_gcloud = FlowTask(
-    name="gcloud",
-    group=devtool_install_group,
-    description="Gcloud CLI",
-    steps=[
-        CmdTask(
-            name="install-gcloud",
-            cmd_path=[
-                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
-                os.path.join(_CURRENT_DIR, "install.sh"),
-            ],
-            preexec_fn=None,
-        ),
-    ],
-    retry=0,
-)
-runner.register(install_gcloud)

zrb/builtin/devtool/install/gcloud/install.sh

@@ -1,11 +0,0 @@
-if command_exists apt
-then
-    log_info "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" |try_sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
-    try_sudo apt install -y apt-transport-https ca-certificates gnupg
-    curl https://packages.cloud.google.com/apt/doc/apt-key.gpg |try_sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
-    try_sudo apt update &&try_sudo apt install -y google-cloud-sdk
-else
-    log_info "apt not found"
-    exit 1
-fi
-

zrb/builtin/devtool/install/gvm/download.sh

@@ -1,15 +0,0 @@
-if [ ! -d "${HOME}/.gvm" ]
-then
-    if command_exists pkg
-    then
-        try_sudo pkg update
-        try_sudo pkg install -y bison ncurses-utils
-    elif command_exists apt
-    then
-        try_sudo apt install -y bison
-    fi
-    log_info "Download GVM"
-    curl -o- https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer | bash
-else
-    log_info "GVM already exists under ${HOME}/.gvm"
-fi

zrb/builtin/devtool/install/gvm/finalize.sh

@@ -1,16 +0,0 @@
-source {{ os.path.expandvars(os.path.expanduser(input.config_file)) }}
-
-set -e
-if [ ! -d "${HOME}/.gvm/gos/{{ input.go_default_version }}" ]
-then
-    log_info "Install {{ input.go_default_version }}"
-    gvm install {{input.go_default_version}}
-else
-    log_info "{{ input.go_default_version }} already installed"
-fi
-
-log_info "Set {{ input.go_default_version }} as default"
-gvm use "{{input.go_default_version}}" --default
-
-log_info "Please reload your terminal to continue (i.e., source {{ input.config_file }})"
-log_info "Happy coding"