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

zrb/builtin/random.py

@@ -0,0 +1,61 @@
+import random
+
+from zrb.builtin.group import random_group
+from zrb.context.any_context import AnyContext
+from zrb.input.int_input import IntInput
+from zrb.input.str_input import StrInput
+from zrb.task.make_task import make_task
+
+
+@make_task(
+    name="throw-dice",
+    description="🔢 Throw dices",
+    input=[
+        StrInput(
+            name="side",
+            description="Number of sides",
+            prompt="How many sides (comma separated)",
+            default_str="6",
+        ),
+        IntInput(
+            name="num-rolls",
+            description="Number of rolls",
+            prompt="How many rolls",
+            default_str="1",
+        ),
+    ],
+    retries=0,
+    group=random_group,
+    alias="throw",
+)
+def throw_dice(ctx: AnyContext) -> str:
+    dice = [int(side.strip()) for side in ctx.input.side.split(",")]
+    num_rolls = ctx.input.num_rolls
+    str_sums = []
+    for i in range(num_rolls):
+        throw_results = [random.randint(1, sides) for sides in dice]
+        throw_results_sum = sum(throw_results)
+        throw_results_detail = ", ".join(str(num) for num in throw_results)
+        ctx.print(f"#{i+1}: {throw_results_detail} -> {throw_results_sum}")
+        str_sums.append(str(throw_results_sum))
+    return "\n".join(str_sums)
+
+
+@make_task(
+    name="shuffle",
+    description="🔀 Shuffle list",
+    input=StrInput(
+        name="values",
+        description="Value to be shuffled",
+        prompt="List of values (comma separated)",
+        default_str="🪙, 🪄, ⚔️, 🍷",
+    ),
+    retries=0,
+    group=random_group,
+    alias="shuffle",
+)
+def shuffle_values(ctx: AnyContext) -> str:
+    shuffled = [value.strip() for value in ctx.input["values"].split(",")]
+    ctx.print("Shuffling...")
+    random.shuffle(shuffled)
+    return "\n".join(shuffled)

zrb/builtin/setup/asdf/asdf.py

@@ -0,0 +1,86 @@
+import os
+
+from zrb.builtin.group import setup_group
+from zrb.builtin.setup.asdf.asdf_helper import (
+    check_inexist_asdf_dir,
+    get_install_prerequisites_cmd,
+    setup_asdf_ps_config,
+    setup_asdf_sh_config,
+)
+from zrb.builtin.setup.common_input import (
+    package_manager_input,
+    setup_bash_input,
+    setup_powershell_input,
+    setup_zsh_input,
+    use_sudo_input,
+)
+from zrb.context.any_context import AnyContext
+from zrb.task.cmd_task import CmdTask
+from zrb.task.make_task import make_task
+
+install_asdf_prerequisites = CmdTask(
+    name="install-asdf-prerequisites",
+    input=[package_manager_input, use_sudo_input],
+    cmd=get_install_prerequisites_cmd,
+)
+
+
+download_asdf = CmdTask(
+    name="download-asdf",
+    cmd="git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.14.1",
+    execute_condition=check_inexist_asdf_dir,
+)
+install_asdf_prerequisites >> download_asdf
+
+
+@make_task(
+    name="setup-asdf-on-bash",
+    input=setup_bash_input,
+    execute_condition='{ctx.input["setup-bash"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_bash(ctx: AnyContext):
+    ctx.print("Configure asdf for bash")
+    setup_asdf_sh_config(os.path.expanduser(os.path.join("~", ".bashrc")))
+
+
+@make_task(
+    name="setup-asdf-on-zsh",
+    input=setup_zsh_input,
+    execute_condition='{ctx.input["setup-zsh"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_zsh(ctx: AnyContext):
+    ctx.print("Configure asdf for zsh")
+    setup_asdf_sh_config(os.path.expanduser(os.path.join("~", ".zshrc")))
+
+
+@make_task(
+    name="setup-asdf-on-powershell",
+    input=setup_powershell_input,
+    execute_condition='{ctx.input["setup-powershell"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_powershell(ctx: AnyContext):
+    ctx.print("Configure asdf for powershell")
+    setup_asdf_ps_config(
+        os.path.expanduser(os.path.join("~", ".config", "powershell", "profile.ps1"))
+    )
+
+
+@make_task(
+    name="setup-asdf",
+    description="🧰 Setup `asdf`.",
+    group=setup_group,
+    alias="asdf",
+)
+def setup_asdf(ctx: AnyContext):
+    ctx.print("Setup complete, restart your terminal to continue")
+    ctx.print("Some useful commands:")
+    ctx.print("- asdf plugin add python")
+    ctx.print("- asdf list all python")
+    ctx.print("- asdf install python 3.12.0")
+    ctx.print("- asdf global python 3.12.0")
+
+
+setup_asdf << [setup_asdf_on_bash, setup_asdf_on_zsh, setup_asdf_on_powershell]

zrb/builtin/setup/asdf/asdf_helper.py

@@ -0,0 +1,40 @@
+import os
+
+from zrb.context.any_context import AnyContext
+from zrb.util.file import read_file, write_file
+
+
+def get_install_prerequisites_cmd(ctx: AnyContext) -> str:
+    package_manager: str = ctx.input["package-manager"]
+    if package_manager in ["brew", "spack"]:
+        cmd = f"{package_manager} install coreutils curl git"
+    elif package_manager == "pacman":
+        cmd = f"{package_manager} -S curl git"
+    else:
+        cmd = f"{package_manager} install curl git"
+    use_sudo: bool = ctx.input["use-sudo"]
+    if use_sudo:
+        return f"sudo {cmd}"
+    return cmd
+
+
+def check_inexist_asdf_dir(_: AnyContext):
+    asdf_dir = os.path.expanduser(os.path.join("~", ".asdf"))
+    return not os.path.isdir(asdf_dir)
+
+
+def setup_asdf_sh_config(file_path: str):
+    _setup_asdf_config(file_path, '. "$HOME/.asdf/asdf.sh"')
+
+
+def setup_asdf_ps_config(file_path: str):
+    _setup_asdf_config(file_path, '. "$HOME/.asdf/asdf.ps1"')
+
+
+def _setup_asdf_config(file_path: str, asdf_config: str):
+    if not os.path.isfile(file_path):
+        write_file(file_path, "")
+    content = read_file(file_path)
+    if asdf_config in content:
+        return
+    write_file(file_path, [content, asdf_config, ""])

zrb/builtin/setup/common_input.py

@@ -0,0 +1,35 @@
+from zrb.input.bool_input import BoolInput
+from zrb.input.option_input import OptionInput
+
+package_manager_input = OptionInput(
+    name="package-manager",
+    description="Your package manager",
+    prompt="Your package manager",
+    options=["apt", "dnf", "pacman", "zypper", "pkg", "brew", "spack"],
+    default_str="apt",
+)
+
+use_sudo_input = BoolInput(
+    name="use-sudo",
+    description="Use sudo or not",
+    prompt="Need sudo",
+    default_str="yes",
+)
+
+setup_bash_input = BoolInput(
+    name="setup-bash",
+    description="Setup bash",
+    prompt="Setup bash",
+    default_str="yes",
+)
+
+setup_zsh_input = BoolInput(
+    name="setup-zsh", description="Setup zsh", prompt="Setup zsh", default_str="yes"
+)
+
+setup_powershell_input = BoolInput(
+    name="setup-powershell",
+    description="Setup powershell",
+    prompt="Setup powershell",
+    default_str="no",
+)

zrb/builtin/setup/latex/ubuntu.py

@@ -0,0 +1,18 @@
+from zrb.builtin.group import setup_latex_group
+from zrb.builtin.setup.ubuntu import setup_ubuntu
+from zrb.task.cmd_task import CmdTask
+
+setup_latex_on_ubuntu = setup_latex_group.add_task(
+    CmdTask(
+        name="setup-latex-on-ubuntu",
+        description="🐧 Setup LaTeX on Ubuntu",
+        cmd=[
+            "sudo apt install -y \\",
+            "texlive-full texlive-latex-base texlive-fonts-recommended \\",
+            "texlive-fonts-extra texlive-latex-extra",
+        ],
+        render_cmd=False,
+    ),
+    alias="ubuntu",
+)
+setup_ubuntu >> setup_latex_on_ubuntu

zrb/builtin/setup/tmux/tmux.py

@@ -0,0 +1,45 @@
+import os
+
+from zrb.builtin.group import setup_group
+from zrb.builtin.setup.common_input import package_manager_input, use_sudo_input
+from zrb.builtin.setup.tmux.tmux_helper import get_install_tmux_cmd
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.task.cmd_task import CmdTask
+from zrb.task.make_task import make_task
+from zrb.util.file import read_file, write_file
+
+install_tmux = CmdTask(
+    name="install-tmux",
+    input=[package_manager_input, use_sudo_input],
+    cmd=get_install_tmux_cmd,
+)
+
+
+@make_task(
+    name="setup-tmux",
+    input=StrInput(
+        name="tmux-config",
+        description="Tmux config file",
+        prompt="Tmux config file",
+        default_str="~/.tmux.conf",
+    ),
+    description="📺 Setup `tmux`.",
+    group=setup_group,
+    alias="tmux",
+)
+def setup_tmux(ctx: AnyContext):
+    tmux_config = read_file(os.path.join(os.path.dirname(__file__), "tmux_config.sh"))
+    tmux_config_file = os.path.expanduser(ctx.input["tmux-config"])
+    # Make sure config file exists
+    if not os.path.isfile(tmux_config_file):
+        write_file(tmux_config_file, "")
+    content = read_file(tmux_config_file)
+    if tmux_config in content:
+        return
+    # Write config
+    write_file(tmux_config_file, [content, tmux_config, ""])
+    ctx.print("Setup complete, restart your terminal to continue")
+
+
+install_tmux >> setup_tmux

zrb/builtin/setup/tmux/tmux_helper.py

@@ -0,0 +1,13 @@
+from zrb.context.any_context import AnyContext
+
+
+def get_install_tmux_cmd(ctx: AnyContext) -> str:
+    package_manager: str = ctx.input["package-manager"]
+    if package_manager == "pacman":
+        cmd = f"{package_manager} -S tmux"
+    else:
+        cmd = f"{package_manager} install tmux"
+    use_sudo: bool = ctx.input["use-sudo"]
+    if use_sudo:
+        return f"sudo {cmd}"
+    return cmd

zrb/builtin/setup/ubuntu.py

@@ -0,0 +1,28 @@
+from zrb.builtin.group import setup_group
+from zrb.task.cmd_task import CmdTask
+
+update_ubuntu = CmdTask(name="update-ubuntu", cmd="sudo apt update", render_cmd=False)
+
+upgrade_todo = CmdTask(
+    name="upgrade-ubuntu", cmd="sudo apt upgrade -y", render_cmd=False
+)
+update_ubuntu >> upgrade_todo
+
+setup_ubuntu = setup_group.add_task(
+    CmdTask(
+        name="setup-ubuntu",
+        description="🐧 Setup ubuntu",
+        cmd=[
+            "sudo apt install -y \\",
+            "build-essential python3-distutils libssl-dev zlib1g-dev \\"
+            "libbz2-dev libreadline-dev libsqlite3-dev libpq-dev python3-dev \\",
+            "llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev \\",
+            "liblzma-dev python3-openssl libblas-dev liblapack-dev rustc \\",
+            "golang gfortran fd-find ripgrep wget curl git ncat zip unzip \\",
+            "cmake make tree tmux zsh neovim xdotool xsel",
+        ],
+        render_cmd=False,
+    ),
+    alias="ubuntu",
+)
+upgrade_todo >> setup_ubuntu

zrb/builtin/setup/zsh/zsh.py

@@ -0,0 +1,55 @@
+import os
+
+from zrb.builtin.group import setup_group
+from zrb.builtin.setup.common_input import package_manager_input, use_sudo_input
+from zrb.builtin.setup.zsh.zsh_helper import get_install_zsh_cmd
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.task.cmd_task import CmdTask
+from zrb.task.make_task import make_task
+from zrb.util.file import read_file, write_file
+
+install_zsh = CmdTask(
+    name="install-zsh",
+    input=[package_manager_input, use_sudo_input],
+    cmd=get_install_zsh_cmd,
+)
+
+install_omz = CmdTask(
+    name="install-omz",
+    cmd='sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"',  # noqa
+    upstream=install_zsh,
+)
+
+install_zinit = CmdTask(
+    name="install-zinit",
+    cmd='bash -c "$(curl --fail --show-error --silent --location https://raw.githubusercontent.com/zdharma-continuum/zinit/HEAD/scripts/install.sh)"',  # noqa
+    upstream=install_zsh,
+)
+
+
+@make_task(
+    name="setup-zsh",
+    input=StrInput(
+        name="zsh-config",
+        description="zsh config file",
+        prompt="zsh config file",
+        default_str="~/.zshrc",
+    ),
+    upstream=[install_omz, install_zinit],
+    description="💻 Setup `zsh`.",
+    group=setup_group,
+    alias="zsh",
+)
+def setup_zsh(ctx: AnyContext):
+    zsh_config = read_file(os.path.join(os.path.dirname(__file__), "zsh_config.sh"))
+    zsh_config_file = os.path.expanduser(ctx.input["zsh-config"])
+    # Make sure config file exists
+    if not os.path.isfile(zsh_config_file):
+        write_file(zsh_config_file, "")
+    content = read_file(zsh_config_file)
+    if zsh_config in content:
+        return
+    # Write config
+    write_file(zsh_config_file, [content, zsh_config, ""])
+    ctx.print("Setup complete, restart your terminal to continue")

zrb/builtin/setup/zsh/zsh_config.sh

@@ -0,0 +1,133 @@
+# If you come from bash you might have to change your $PATH.
+# export PATH=$HOME/bin:/usr/local/bin:$PATH
+
+# Path to your oh-my-zsh installation.
+export ZSH="$HOME/.oh-my-zsh"
+
+# Set name of the theme to load --- if set to "random", it will
+# load a random theme each time oh-my-zsh is loaded, in which case,
+# to know which specific one was loaded, run: echo $RANDOM_THEME
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+ZSH_THEME="candy"
+
+# Set list of themes to pick from when loading at random
+# Setting this variable when ZSH_THEME=random will cause zsh to load
+# a theme from this variable instead of looking in $ZSH/themes/
+# If set to an empty array, this variable will have no effect.
+# ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" )
+
+# Uncomment the following line to use case-sensitive completion.
+# CASE_SENSITIVE="true"
+
+# Uncomment the following line to use hyphen-insensitive completion.
+# Case-sensitive completion must be off. _ and - will be interchangeable.
+# HYPHEN_INSENSITIVE="true"
+
+# Uncomment one of the following lines to change the auto-update behavior
+# zstyle ':omz:update' mode disabled  # disable automatic updates
+# zstyle ':omz:update' mode auto      # update automatically without asking
+# zstyle ':omz:update' mode reminder  # just remind me to update when it's time
+
+# Uncomment the following line to change how often to auto-update (in days).
+# zstyle ':omz:update' frequency 13
+
+# Uncomment the following line if pasting URLs and other text is messed up.
+# DISABLE_MAGIC_FUNCTIONS="true"
+
+# Uncomment the following line to disable colors in ls.
+# DISABLE_LS_COLORS="true"
+
+# Uncomment the following line to disable auto-setting terminal title.
+# DISABLE_AUTO_TITLE="true"
+
+# Uncomment the following line to enable command auto-correction.
+# ENABLE_CORRECTION="true"
+
+# Uncomment the following line to display red dots whilst waiting for completion.
+# You can also set it to another string to have that shown instead of the default red dots.
+# e.g. COMPLETION_WAITING_DOTS="%F{yellow}waiting...%f"
+# Caution: this setting can cause issues with multiline prompts in zsh < 5.7.1 (see #5765)
+# COMPLETION_WAITING_DOTS="true"
+
+# Uncomment the following line if you want to disable marking untracked files
+# under VCS as dirty. This makes repository status check for large repositories
+# much, much faster.
+# DISABLE_UNTRACKED_FILES_DIRTY="true"
+
+# Uncomment the following line if you want to change the command execution time
+# stamp shown in the history command output.
+# You can set one of the optional three formats:
+# "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd"
+# or set a custom format using the strftime function format specifications,
+# see 'man strftime' for details.
+# HIST_STAMPS="mm/dd/yyyy"
+
+# Would you like to use another custom folder than $ZSH/custom?
+# ZSH_CUSTOM=/path/to/new-custom-folder
+
+# Which plugins would you like to load?
+# Standard plugins can be found in $ZSH/plugins/
+# Custom plugins may be added to $ZSH_CUSTOM/plugins/
+# Example format: plugins=(rails git textmate ruby lighthouse)
+# Add wisely, as too many plugins slow down shell startup.
+plugins=(
+  git
+  kubectl
+)
+
+source $ZSH/oh-my-zsh.sh
+
+# User configuration
+
+# export MANPATH="/usr/local/man:$MANPATH"
+
+# You may need to manually set your language environment
+# export LANG=en_US.UTF-8
+
+# Preferred editor for local and remote sessions
+# if [[ -n $SSH_CONNECTION ]]; then
+#   export EDITOR='vim'
+# else
+#   export EDITOR='mvim'
+# fi
+
+# Compilation flags
+# export ARCHFLAGS="-arch x86_64"
+
+# Set personal aliases, overriding those provided by oh-my-zsh libs,
+# plugins, and themes. Aliases can be placed here, though oh-my-zsh
+# users are encouraged to define aliases within the ZSH_CUSTOM folder.
+# For a full list of active aliases, run `alias`.
+#
+# Example aliases
+# alias zshconfig="mate ~/.zshrc"
+# alias ohmyzsh="mate ~/.oh-my-zsh"
+
+source "$HOME/.local/share/zinit/zinit.git/zinit.zsh"
+autoload -Uz _zinit
+(( ${+_comps} )) && _comps[zinit]=_zinit
+
+# Load a few important annexes, without Turbo
+# (this is currently required for annexes)
+zinit light-mode for \
+    zdharma-continuum/zinit-annex-as-monitor \
+    zdharma-continuum/zinit-annex-bin-gem-node \
+    zdharma-continuum/zinit-annex-patch-dl \
+    zdharma-continuum/zinit-annex-rust
+### End of Zinit's installer chunk
+
+# Plugin history-search-multi-word loaded with investigating.
+zinit load zdharma-continuum/history-search-multi-word
+
+# Two regular plugins loaded without investigating.
+zinit light zsh-users/zsh-autosuggestions
+zinit light zdharma-continuum/fast-syntax-highlighting
+
+zinit light jonmosco/kube-ps1
+KUBE_PS1_SYMBOL_ENABLE=false
+KUBE_PS1_PREFIX=''
+KUBE_PS1_SUFFIX=' '
+KUBE_PS1_CTX_COLOR=cyan
+PROMPT='$(kube_ps1)'$PROMPT
+
+export COLORTERM=truecolor

zrb/builtin/setup/zsh/zsh_helper.py

@@ -0,0 +1,13 @@
+from zrb.context.any_context import AnyContext
+
+
+def get_install_zsh_cmd(ctx: AnyContext) -> str:
+    package_manager: str = ctx.input["package-manager"]
+    if package_manager == "pacman":
+        cmd = f"{package_manager} -S zsh"
+    else:
+        cmd = f"{package_manager} install zsh"
+    use_sudo: bool = ctx.input["use-sudo"]
+    if use_sudo:
+        return f"sudo {cmd}"
+    return cmd

zrb/builtin/shell/autocomplete/bash.py

@@ -0,0 +1,40 @@
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.task.make_task import make_task
+
+_COMPLETION_SCRIPT = """
+# Bash dynamic completion script
+_zrb_complete() {
+    local cur cmd_input subcmd_output
+    local -a subcommands
+
+    # Get the current word being completed
+    cur="${COMP_WORDS[COMP_CWORD]}"
+
+    # Build the command input dynamically (excluding the current word being typed)
+    cmd_input="zrb shell autocomplete subcmd ${COMP_WORDS[@]:0:$COMP_CWORD}"
+
+    # Fetch the subcommands dynamically
+    subcmd_output=$(eval "$cmd_input 2>/dev/null")
+
+    # Split the output into an array of subcommands using whitespace
+    IFS=' ' read -r -a subcommands <<< "$subcmd_output"
+
+    # Generate completion suggestions if subcommands is not empty
+    COMPREPLY=( $(compgen -W "${subcommands[*]}" -- "$cur") )
+}
+
+# Register the completion function for zrb
+complete -F _zrb_complete zrb
+
+"""
+
+
+@make_task(
+    name="make-bash-autocomplete",
+    description="Create Zrb autocomplete script for bash",
+    group=shell_autocomplete_group,
+    alias="bash",
+)
+def make_bash_autocomplete(ctx: Context):
+    return _COMPLETION_SCRIPT

zrb/builtin/shell/autocomplete/subcmd.py

@@ -0,0 +1,19 @@
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.runner.cli import cli
+from zrb.task.make_task import make_task
+from zrb.util.cli.subcommand import get_group_subcommands
+
+
+@make_task(
+    name="get-shell-subcommands",
+    description="Get subcommand of any Zrb command",
+    group=shell_autocomplete_group,
+    alias="subcmd",
+)
+def get_shell_subcommands(ctx: Context):
+    subcommands = get_group_subcommands(cli)
+    for subcommand in subcommands:
+        if subcommand.paths == ctx.args:
+            return " ".join(subcommand.nexts)
+    return ""

zrb/builtin/shell/autocomplete/zsh.py

@@ -0,0 +1,37 @@
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.task.make_task import make_task
+
+_COMPLETION_SCRIPT = """
+# Zsh dynamic completion script
+_zrb_complete() {
+    local -a subcommands
+    local cmd_input
+    local subcmd_output
+
+    # Build the command input based on the current words
+    cmd_input="zrb shell autocomplete subcmd ${words[1,CURRENT-1]}"
+
+    # Fetch the subcommands dynamically and store them in a variable
+    subcmd_output=$(eval "$cmd_input 2>/dev/null")
+
+    # Split the output into an array using spaces or newlines as separators
+    subcommands=(${=subcmd_output})
+
+    # Provide the completion suggestions
+    _describe 'subcommand' subcommands
+}
+
+# Register the completion function
+compdef _zrb_complete zrb
+"""
+
+
+@make_task(
+    name="make-zsh-autocomplete",
+    description="Create Zrb autocomplete script for zsh",
+    group=shell_autocomplete_group,
+    alias="zsh",
+)
+def make_zsh_autocomplete(ctx: Context):
+    return _COMPLETION_SCRIPT