zrb 0.9.2__py3-none-any.whl → 0.15.0__py3-none-any.whl

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 }})"

zrb/builtin/devtool/install/nvm/nvm.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_nvm = FlowTask(
+    name="nvm",
+    group=devtool_install_group,
+    description="NVM allows you to quickly install and use different versions of node via the command line",  # noqa
+    inputs=[
+        StrInput(
+            name="node-default-version",
+            description="Node default version",
+            default="node",
+        ),
+        terminal_config_file_input,
+    ],
+    steps=[
+        CmdTask(
+            name="download-nvm",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "download.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-nvm",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+        CmdTask(
+            name="finalize-nvm-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_nvm)

zrb/builtin/devtool/install/pulumi/pulumi.py

@@ -0,0 +1,38 @@
+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
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
+
+install_pulumi = FlowTask(
+    name="pulumi",
+    group=devtool_install_group,
+    description="Universal infrastructure as code",
+    inputs=[terminal_config_file_input],
+    steps=[
+        CmdTask(
+            name="install-pulumi",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-pulumi",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+    ],
+    retry=0,
+)
+runner.register(install_pulumi)

zrb/builtin/devtool/install/pyenv/pyenv.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_pyenv = FlowTask(
+    name="pyenv",
+    group=devtool_install_group,
+    description="Simple Python version management",
+    inputs=[
+        StrInput(
+            name="python-default-version",
+            description="Python default version",
+            default="3.10.0",
+        ),
+        terminal_config_file_input,
+    ],
+    steps=[
+        CmdTask(
+            name="download-pyenv",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "download.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-pyenv",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+        CmdTask(
+            name="finalize-pyenv-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_pyenv)

zrb/builtin/devtool/install/sdkman/sdkman.py

@@ -0,0 +1,61 @@
+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.bool_input import BoolInput
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
+
+install_sdkman = FlowTask(
+    name="sdkman",
+    group=devtool_install_group,
+    description="SDKMAN! is a tool for managing parallel versions of multiple Software Development Kits on most Unix based systems",  # noqa
+    inputs=[
+        BoolInput(
+            name="install-java",
+            description="Install Java",
+            prompt="Do you want to install Java?",
+            default=True,
+        ),
+        BoolInput(
+            name="install-scala",
+            description="Install Scala",
+            prompt="Do you want to install Scala?",
+            default=True,
+        ),
+        terminal_config_file_input,
+    ],
+    steps=[
+        CmdTask(
+            name="download-sdkman",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "download.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-sdkman",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+        CmdTask(
+            name="finalize-sdkman-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_sdkman)

zrb/builtin/devtool/install/selenium/selenium.py

@@ -0,0 +1,26 @@
+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_selenium = FlowTask(
+    name="selenium",
+    group=devtool_install_group,
+    description="Selenium + Chrome web driver",
+    steps=[
+        CmdTask(
+            name="install-selenium",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        )
+    ],
+)
+runner.register(install_selenium)

zrb/builtin/devtool/install/terraform/terraform.py

@@ -0,0 +1,38 @@
+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
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "..", "..", "..", "shell-scripts")
+
+install_terraform = FlowTask(
+    name="terraform",
+    group=devtool_install_group,
+    description="Open source IAC by Hashicorp",
+    inputs=[terminal_config_file_input],
+    steps=[
+        CmdTask(
+            name="install-terraform",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-terraform",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.config_file}}",
+            ),
+        ),
+    ],
+    retry=0,
+)
+runner.register(install_terraform)

zrb/builtin/devtool/install/tmux/tmux.py

@@ -0,0 +1,45 @@
+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
+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_tmux = FlowTask(
+    name="tmux",
+    group=devtool_install_group,
+    description="Terminal multiplexer",
+    inputs=[
+        StrInput(
+            name="tmux-config-file",
+            shortcut="c",
+            prompt="Tmux config file",
+            default="~/.tmux.conf",
+        )
+    ],
+    steps=[
+        CmdTask(
+            name="install-tmux",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-tmux",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.tmux_config_file}}",
+            ),
+        ),
+    ],
+    retry=0,
+)
+runner.register(install_tmux)

zrb/builtin/devtool/install/zsh/zsh.py

@@ -0,0 +1,46 @@
+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
+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_zsh = FlowTask(
+    name="zsh",
+    group=devtool_install_group,
+    description="Zsh terminal + oh-my-zsh + zdharma",
+    inputs=[
+        StrInput(
+            name="zsh-config-file",
+            shortcut="c",
+            prompt="Zsh config file",
+            default="~/.zshrc",
+        )
+    ],
+    steps=[
+        CmdTask(
+            name="install-zsh",
+            cmd_path=[
+                os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+                os.path.join(_CURRENT_DIR, "install.sh"),
+            ],
+            preexec_fn=None,
+        ),
+        Task(
+            name="configure-zsh",
+            run=write_config(
+                template_file=os.path.join(_CURRENT_DIR, "resource", "config.sh"),
+                config_file="{{input.zsh_config_file}}",
+            ),
+        ),
+    ],
+    retry=0,
+)
+runner.register(install_zsh)

zrb/builtin/docker/__init__.py

@@ -0,0 +1,5 @@
+from zrb.builtin.docker._group import docker_group
+from zrb.builtin.docker.prune import prune_docker
+
+assert docker_group
+assert prune_docker

zrb/builtin/docker/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+docker_group = Group(name="docker", description="Docker related commands")

zrb/builtin/docker/prune.py

@@ -0,0 +1,16 @@
+from zrb.builtin.docker._group import docker_group
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+
+prune_docker = CmdTask(
+    name="prune",
+    group=docker_group,
+    description="Prune unused images and volumes",
+    cmd=[
+        "docker system prune -af",
+        "docker image prune -af",
+        "docker system prune -af --volumes",
+        "docker system df",
+    ],
+)
+runner.register(prune_docker)

zrb/builtin/env/__init__.py

@@ -0,0 +1,5 @@
+from zrb.builtin.env._group import env_group
+from zrb.builtin.env.get import get_env
+
+assert env_group
+assert get_env

zrb/builtin/env/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+env_group = Group(name="env", description="Environment variable management")

zrb/builtin/env/get.py

@@ -0,0 +1,26 @@
+from zrb.builtin.env._group import env_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any, List
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task.task import Task
+
+
+@python_task(
+    name="get", group=env_group, description="Get environment values", runner=runner
+)
+async def get_env(*args: Any, **kwargs: Any):
+    task: Task = kwargs["_task"]
+    env_map = task.get_env_map()
+    names = list(env_map.keys())
+    names.sort()
+    colored_equal = colored("=", color="grey", attrs=["dark"])
+    env_lines: List[str] = []
+    for name in names:
+        value = env_map[name]
+        colored_name = colored(name, color="green", attrs=["bold"])
+        colored_value = colored(value, attrs=["bold"])
+        env_lines.append(f"{colored_name}{colored_equal}{colored_value}")
+    line_separator = "\n    "
+    task.print_out(line_separator + line_separator.join(env_lines))
+    return env_map

zrb/builtin/eval.py

@@ -3,10 +3,6 @@ from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.str_input import StrInput
 
-###############################################################################
-# Task Definitions
-###############################################################################
-
 
 @python_task(
     name="eval",

zrb/builtin/explain/__init__.py

@@ -0,0 +1,5 @@
+from zrb.builtin.explain._group import explain_group
+from zrb.builtin.explain.task import explain_tasks
+
+assert explain_group
+assert explain_tasks

zrb/builtin/explain/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+explain_group = Group(name="explain", description="Explain things")

zrb/builtin/explain/explanation/dry.md

@@ -0,0 +1,7 @@
+- D: Don't
+- R: Repeat
+- Y: Yourself
+
+Don't repeat yourself (DRY) is a principle of software development aimed at reducing repetition of information which is likely to change, replacing it with abstractions that are less likely to change, or using data normalization which avoids redundancy in the first place.
+
+Every piece of knowledge must have a single, unambiguous, authoritative representation within a system". The principle has been formulated by Andy Hunt and Dave Thomas in their book The Pragmatic Programmer.

zrb/builtin/explain/explanation/kiss.md

@@ -0,0 +1,6 @@
+- K: Keep
+- I: It
+- S: Simple
+- S: Stupid
+
+Keep it simple, stupid!", is a design principle noted by the U.S. Navy in 1960. First seen partly in American English by at least 1938, the KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.

zrb/builtin/explain/explanation/solid.md

@@ -0,0 +1,9 @@
+- S: Single Responsibility Principle
+- O: Open/Closed Principle
+- L: Liskov’s Substitution Principle
+- I: Interface Segregation Principle
+- D: Dependency Inversion Principle
+
+In software development, Object-Oriented Design plays a crucial role when it comes to writing flexible, scalable, maintainable, and reusable code. There are so many benefits of using OOD but every developer should also have the knowledge of the SOLID principle for good object-oriented design in programming. The SOLID principle was introduced by Robert C. Martin, also known as Uncle Bob and it is a coding standard in programming.
+
+The SOLID principle helps in reducing tight coupling. Tight coupling means a group of classes are highly dependent on one another which you should avoid in your code. Opposite of tight coupling is loose coupling and your code is considered as a good code when it has loosely-coupled classes. Loosely coupled classes minimize changes in your code, helps in making code more reusable, maintainable, flexible and stable.

zrb/builtin/explain/explanation/yagni.md

@@ -0,0 +1,9 @@
+- Y: You
+- A: Aren't
+- G: Gonna
+- N: Need
+- I: It
+
+YAGNI principle ("You Aren't Gonna Need It") is a practice in software development which states that features should only be added when required.
+
+As a part of the extreme programming (XP) philosophy, YAGNI trims away excess and inefficiency in development to facilitate the desired increased frequency of releases.

zrb/builtin/explain/explanation/zen-of-python.md

@@ -0,0 +1,37 @@
+Beautiful is better than ugly.
+
+Explicit is better than implicit.
+
+Simple is better than complex.
+
+Complex is better than complicated.
+
+Flat is better than nested.
+
+Sparse is better than dense.
+
+Readability counts.
+
+Special cases aren't special enough to break the rules.
+
+Although practicality beats purity.
+
+Errors should never pass silently.
+
+Unless explicitly silenced.
+
+In the face of ambiguity, refuse the temptation to guess.
+
+There should be one-- and preferably only one --obvious way to do it.
+
+Although that way may not be obvious at first unless you're Dutch.
+
+Now is better than never.
+
+Although never is often better than right now.
+
+If the implementation is hard to explain, it's a bad idea.
+
+If the implementation is easy to explain, it may be a good idea.
+
+Namespaces are one honking great idea – let's do more of those!

zrb/builtin/explain/task.py

@@ -0,0 +1,13 @@
+import os
+
+from zrb.builtin.explain._group import explain_group
+from zrb.runner import runner
+from zrb.task.wiki_task import create_wiki_tasks
+
+CURRENT_DIRECTORY = os.path.dirname(__file__)
+
+explain_tasks = create_wiki_tasks(
+    directory=os.path.join(CURRENT_DIRECTORY, "explanation"),
+    group=explain_group,
+    runner=runner,
+)

zrb/builtin/git/__init__.py

@@ -0,0 +1,7 @@
+from zrb.builtin.git._group import git_group
+from zrb.builtin.git.clear_branch import clear_git_branch
+from zrb.builtin.git.get_file_changes import get_git_file_changes
+
+assert git_group
+assert clear_git_branch
+assert get_git_file_changes

zrb/builtin/git/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+git_group = Group(name="git", description="Git related commands")

zrb/builtin/git/clear_branch.py

@@ -0,0 +1,19 @@
+from zrb.builtin.git._group import git_group
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+
+clear_git_branch = CmdTask(
+    name="clear-branch",
+    group=git_group,
+    description="Clear branches",
+    cmd=[
+        "for BRANCH in $(git branch)",
+        "do",
+        '  if [ "$BRANCH" != "main" ] && [ "$BRANCH" != "*" ]',
+        "  then",
+        "    git branch -D $BRANCH",
+        "  fi",
+        "done",
+    ],
+)
+runner.register(clear_git_branch)

zrb/builtin/git/get_file_changes.py

@@ -0,0 +1,68 @@
+from zrb.builtin.git._group import git_group
+from zrb.helper.accessories.color import colored
+from zrb.helper.git.detect_changes import get_modified_file_states
+from zrb.helper.task import show_lines
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task_input.bool_input import BoolInput
+from zrb.task_input.str_input import StrInput
+
+
+@python_task(
+    name="get-file-changes",
+    group=git_group,
+    description="Get modified files",
+    inputs=[
+        StrInput(
+            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,
+        ),
+        BoolInput(
+            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,
+        ),
+    ],
+    runner=runner,
+)
+async def get_git_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)
+    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"))
+            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"))
+            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"))
+            modified_file_keys.append(modified_file)
+            continue
+    show_lines(kwargs["_task"], *output)
+    modified_file_keys.sort()
+    return "\n".join(modified_file_keys)