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

zrb/builtin/__init__.py

@@ -1,37 +1,131 @@
-from zrb.builtin import (
-    base64,
-    devtool,
-    docker,
-    env,
-    eval,
-    explain,
-    generator,
-    git,
-    md5,
-    process,
-    project,
-    say,
-    schedule,
-    ubuntu,
-    update,
-    version,
-    watch_changes,
+from zrb.builtin.base64 import base64_group, decode_base64, encode_base64
+from zrb.builtin.devtool import (
+    devtool_group,
+    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,
 )
+from zrb.builtin.docker import docker_group, prune_docker
+from zrb.builtin.env import env_group, get_env
+from zrb.builtin.eval import evaluate
+from zrb.builtin.explain import explain_group, explain_tasks
+from zrb.builtin.git import clear_git_branch, get_git_file_changes, git_group
+from zrb.builtin.md5 import hash_text_md5, md5_group, sum_file_md5
+from zrb.builtin.process import (
+    get_process_pid_by_name,
+    get_process_pid_by_port,
+    process_group,
+    process_pid_group,
+)
+from zrb.builtin.project import (
+    add_cmd_task,
+    add_docker_compose_task,
+    add_fastapp_application,
+    add_fastapp_crud,
+    add_fastapp_field,
+    add_fastapp_module,
+    add_plugin,
+    add_project_tasks,
+    add_python_app,
+    add_python_task,
+    create_project,
+    project_add_app_group,
+    project_add_fastapp_group,
+    project_add_group,
+    project_add_task_group,
+    project_group,
+)
+from zrb.builtin.say import say
+from zrb.builtin.schedule import schedule
+from zrb.builtin.ubuntu import (
+    install_ubuntu_all,
+    install_ubuntu_essentials,
+    install_ubuntu_tex,
+    install_ubuntu_toys,
+    ubuntu_group,
+    ubuntu_install_group,
+    update_ubuntu,
+)
+from zrb.builtin.update import update_zrb
+from zrb.builtin.version import get_version
+from zrb.builtin.watch_changes import watch_changes
 
-assert base64
-assert devtool
-assert docker
-assert env
-assert eval
-assert explain
-assert generator
-assert git
-assert md5
-assert process
-assert project
-assert ubuntu
-assert update
+assert base64_group
+assert decode_base64
+assert encode_base64
+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
+assert docker_group
+assert prune_docker
+assert env_group
+assert get_env
+assert git_group
+assert clear_git_branch
+assert get_git_file_changes
+assert md5_group
+assert hash_text_md5
+assert sum_file_md5
+assert process_group
+assert process_pid_group
+assert get_process_pid_by_name
+assert get_process_pid_by_port
+assert project_group
+assert project_add_group
+assert project_add_app_group
+assert project_add_fastapp_group
+assert project_add_task_group
+assert create_project
+assert add_plugin
+assert add_fastapp_application
+assert add_fastapp_crud
+assert add_fastapp_module
+assert add_fastapp_field
+assert add_python_app
+assert add_project_tasks
+assert add_cmd_task
+assert add_docker_compose_task
+assert add_python_task
+assert ubuntu_group
+assert ubuntu_install_group
+assert update_ubuntu
+assert ubuntu_install_group
+assert install_ubuntu_all
+assert install_ubuntu_essentials
+assert install_ubuntu_tex
+assert install_ubuntu_toys
+assert explain_group
+assert explain_tasks
+assert evaluate
 assert say
 assert schedule
-assert version
+assert update_zrb
+assert get_version
 assert watch_changes

zrb/builtin/base64/__init__.py

@@ -0,0 +1,7 @@
+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

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

zrb/builtin/base64/_input.py

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

zrb/builtin/base64/decode.py

@@ -0,0 +1,21 @@
+import base64
+
+from zrb.builtin.base64._group import base64_group
+from zrb.builtin.base64._input import text_input
+from zrb.helper.typing import Any
+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

@@ -0,0 +1,21 @@
+import base64
+
+from zrb.builtin.base64._group import base64_group
+from zrb.builtin.base64._input import text_input
+from zrb.helper.typing import Any
+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,4 +1,6 @@
-from zrb.builtin.devtool.devtool_install import (
+from zrb.builtin.devtool._group import devtool_group
+from zrb.builtin.devtool.install import (
+    devtool_install_group,
     install_aws,
     install_docker,
     install_gcloud,
@@ -10,22 +12,26 @@ from zrb.builtin.devtool.devtool_install import (
     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_pyenv
+assert install_helix
+assert install_helm
+assert install_kubectl
 assert install_nvm
-assert install_sdkman
 assert install_pulumi
-assert install_aws
-assert install_gcloud
+assert install_pyenv
+assert install_sdkman
+assert install_selenium
+assert install_terraform
 assert install_tmux
 assert install_zsh
-assert install_kubectl
-assert install_helm
-assert install_docker
-assert install_terraform
-assert install_helix

zrb/builtin/devtool/_group.py

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

zrb/builtin/devtool/install/__init__.py

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,32 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Callable
+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

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

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

@@ -0,0 +1,27 @@
+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/docker/docker.py

@@ -0,0 +1,27 @@
+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/gcloud/gcloud.py

@@ -0,0 +1,27 @@
+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/gvm/gvm.py

@@ -0,0 +1,54 @@
+import os
+
+from zrb.builtin.devtool.install._group import devtool_install_group
+from zrb.builtin.devtool.install._helper import write_config
+from zrb.builtin.devtool.install._input import terminal_config_file_input
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task.flow_task import FlowTask
+from zrb.task.task import Task
+from zrb.task_input.str_input import StrInput
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
+
+install_gvm = FlowTask(
+    name="gvm",
+    group=devtool_install_group,
+    description="GVM provides interface to manage go version",
+    inputs=[
+        StrInput(
+            name="go-default-version",
+            description="Go default version",
+            default="go1.21",
+        ),
+        terminal_config_file_input,
+    ],
+    steps=[
+        CmdTask(
+            name="download-gvm",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "download.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-gvm",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+        CmdTask(
+            name="finalize-gvm-installation",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "finalize.sh"),
+            ],
+            preexec_fn=None,
+        ),
+    ],
+    retry=0,
+)
+runner.register(install_gvm)

zrb/builtin/devtool/install/helix/helix.py

@@ -0,0 +1,63 @@
+import os
+
+from zrb.builtin.devtool.install._group import devtool_install_group
+from zrb.builtin.devtool.install._helper import write_config
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task.flow_task import FlowTask
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
+
+install_helix = FlowTask(
+    name="helix",
+    group=devtool_install_group,
+    description="Post modern text editor",
+    steps=[
+        CmdTask(
+            name="install-helix",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        [
+            Task(
+                name="create-helix-theme",
+                run=write_config(
+                    template_file=os.path.join(
+                        _CURRENT_DIR,
+                        "helix",
+                        "resource",
+                        "themes",
+                        "gruvbox_transparent.toml",  # noqa
+                    ),
+                    config_file="~/.config/helix/themes/gruvbox_transparent.toml",  # noqa
+                    remove_old_config=True,
+                ),
+            ),
+            Task(
+                name="configure-helix",
+                run=write_config(
+                    template_file=os.path.join(
+                        _CURRENT_DIR, "helix", "resource", "config.toml"
+                    ),
+                    config_file="~/.config/helix/config.toml",
+                    remove_old_config=True,
+                ),
+            ),
+            CmdTask(
+                name="install-language-server",
+                cmd_path=[
+                    os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                    os.path.join(_CURRENT_DIR, "install-language-server.sh"),
+                ],
+                preexec_fn=None,
+            ),
+        ],
+    ],
+    retry=0,
+)
+runner.register(install_helix)

zrb/builtin/devtool/install/helm/helm.py

@@ -0,0 +1,27 @@
+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_helm = FlowTask(
+    name="helm",
+    group=devtool_install_group,
+    description="Package manager for kubernetes",
+    steps=[
+        CmdTask(
+            name="install-helm",
+            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_helm)

zrb/builtin/devtool/install/kubectl/kubectl.py

@@ -0,0 +1,27 @@
+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_kubectl = FlowTask(
+    name="kubectl",
+    group=devtool_install_group,
+    description="Kubernetes CLI tool",
+    steps=[
+        CmdTask(
+            name="install-kubectl",
+            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_kubectl)

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

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