zrb 1.0.0a5__py3-none-any.whl → 1.0.0a10__py3-none-any.whl

zrb/__main__.py

@@ -1,12 +1,18 @@
 import sys
 
+from zrb.config import INIT_MODULES, INIT_SCRIPTS
 from zrb.runner.cli import cli
 from zrb.util.cli.style import stylize_error, stylize_warning
 from zrb.util.group import NodeNotFoundError
+from zrb.util.load import load_file, load_module
 
 
 def serve_cli():
     try:
+        for init_module in INIT_MODULES:
+            load_module(init_module)
+        for init_script in INIT_SCRIPTS:
+            load_file(init_script, -1)
         cli.run(sys.argv[1:])
     except KeyboardInterrupt:
         print(stylize_warning("\nStopped"), file=sys.stderr)

zrb/builtin/__init__.py

@@ -12,10 +12,14 @@ from zrb.builtin.md5 import hash_md5, sum_md5
 from zrb.builtin.project.add.fastapp import add_fastapp_to_project
 from zrb.builtin.project.create.create import create_project
 from zrb.builtin.python import format_python_code
+from zrb.builtin.setup.dev.asdf import setup_asdf
+from zrb.builtin.setup.dev.tmux import setup_tmux
+from zrb.builtin.setup.system.latex.ubuntu import setup_latex_on_ubuntu
+from zrb.builtin.setup.system.ubuntu import setup_ubuntu
 from zrb.builtin.shell.autocomplete.bash import make_bash_autocomplete
 from zrb.builtin.shell.autocomplete.subcmd import get_shell_subcommands
 from zrb.builtin.shell.autocomplete.zsh import make_zsh_autocomplete
-from zrb.builtin.todo import todo_add, todo_complete, todo_edit, todo_list, todo_log
+from zrb.builtin.todo import add_todo, complete_todo, edit_todo, list_todo, log_todo
 
 assert create_project
 assert add_fastapp_to_project
@@ -36,8 +40,12 @@ assert git_push
 assert git_add_subtree
 assert git_pull_subtree
 assert git_push_subtree
-assert todo_list
-assert todo_add
-assert todo_edit
-assert todo_complete
-assert todo_log
+assert list_todo
+assert add_todo
+assert edit_todo
+assert complete_todo
+assert log_todo
+assert setup_ubuntu
+assert setup_latex_on_ubuntu
+assert setup_asdf
+assert setup_tmux

zrb/builtin/git.py

@@ -11,6 +11,7 @@ from zrb.util.git import (
     get_branches,
     get_current_branch,
     get_diff,
+    get_repo_dir,
     pull,
     push,
 )
@@ -55,7 +56,8 @@ from zrb.util.git import (
     alias="diff",
 )
 def get_git_diff(ctx: AnyContext):
-    diff = get_diff(ctx.input.source, ctx.input.current)
+    repo_dir = get_repo_dir()
+    diff = get_diff(repo_dir, ctx.input.source, ctx.input.current)
     result = []
     decorated = []
     if ctx.input.created and diff.created:
@@ -82,14 +84,15 @@ def get_git_diff(ctx: AnyContext):
     alias="prune",
 )
 def prune_local_branches(ctx: AnyContext):
-    branches = get_branches()
-    current_branch = get_current_branch()
+    repo_dir = get_repo_dir()
+    branches = get_branches(repo_dir)
+    current_branch = get_current_branch(repo_dir)
     for branch in branches:
         if branch == current_branch or branch == "main" or branch == "master":
             continue
         ctx.print(stylize_yellow(f"Removing local branch: {branch}"))
         try:
-            delete_branch(branch)
+            delete_branch(repo_dir, branch)
         except Exception as e:
             ctx.log_error(e)
 
@@ -107,13 +110,11 @@ def prune_local_branches(ctx: AnyContext):
     alias="commit",
 )
 def git_commit(ctx: AnyContext):
+    repo_dir = get_repo_dir()
     ctx.print("Add changes to staging")
-    add()
+    add(repo_dir)
     ctx.print("Commit changes")
-    try:
-        commit(ctx.input.message)
-    except Exception as e:
-        ctx.log_error(e)
+    commit(repo_dir, ctx.input.message)
 
 
 @make_task(
@@ -130,10 +131,11 @@ def git_commit(ctx: AnyContext):
     alias="pull",
 )
 def git_pull(ctx: AnyContext):
+    repo_dir = get_repo_dir()
     remote = ctx.input.remote
-    current_branch = get_current_branch()
+    current_branch = get_current_branch(repo_dir)
     ctx.print(f"Pulling from {remote}/{current_branch}")
-    pull(remote, current_branch)
+    pull(repo_dir, remote, current_branch)
 
 
 @make_task(
@@ -150,7 +152,8 @@ def git_pull(ctx: AnyContext):
     alias="push",
 )
 def git_push(ctx: AnyContext):
+    repo_dir = get_repo_dir()
     remote = ctx.input.remote
-    current_branch = get_current_branch()
+    current_branch = get_current_branch(repo_dir)
     ctx.print(f"Pushing to {remote}/{current_branch}")
-    push(remote, current_branch)
+    push(repo_dir, remote, current_branch)

zrb/builtin/git_subtree.py

@@ -3,6 +3,7 @@ from zrb.builtin.group import git_subtree_group
 from zrb.context.any_context import AnyContext
 from zrb.input.str_input import StrInput
 from zrb.task.make_task import make_task
+from zrb.util.git import get_repo_dir
 from zrb.util.git_subtree import add_subtree, load_config, pull_subtree, push_subtree
 
 
@@ -32,7 +33,9 @@ from zrb.util.git_subtree import add_subtree, load_config, pull_subtree, push_su
     alias="add",
 )
 def git_add_subtree(ctx: AnyContext):
+    repo_dir = get_repo_dir()
     add_subtree(
+        repo_dir=repo_dir,
         name=ctx.input.name,
         repo_url=ctx.input["repo-url"],
         branch=ctx.input["repo-branch"],
@@ -48,14 +51,20 @@ def git_add_subtree(ctx: AnyContext):
     alias="pull",
 )
 def git_pull_subtree(ctx: AnyContext):
-    config = load_config()
+    repo_dir = get_repo_dir()
+    config = load_config(repo_dir)
     if not config.data:
         raise ValueError("No subtree config found")
     first_err: Exception | None = None
     for name, detail in config.data.items():
         try:
             ctx.print(f"Pull from subtree {name}")
-            pull_subtree(detail.prefix, detail.repo_url, detail.branch)
+            pull_subtree(
+                repo_dir=repo_dir,
+                prefix=detail.prefix,
+                repo_url=detail.repo_url,
+                branch=detail.branch,
+            )
         except Exception as e:
             if first_err is None:
                 first_err = e
@@ -72,14 +81,20 @@ def git_pull_subtree(ctx: AnyContext):
     alias="push",
 )
 def git_push_subtree(ctx: AnyContext):
-    config = load_config()
+    repo_dir = get_repo_dir()
+    config = load_config(repo_dir)
     if not config.data:
         raise ValueError("No subtree config found")
     first_err: Exception | None = None
     for name, detail in config.data.items():
         try:
             ctx.print(f"Push to subtree {name}")
-            push_subtree(detail.prefix, detail.repo_url, detail.branch)
+            push_subtree(
+                repo_dir=repo_dir,
+                prefix=detail.prefix,
+                repo_url=detail.repo_url,
+                branch=detail.branch,
+            )
         except Exception as e:
             if first_err is None:
                 first_err = e

zrb/builtin/group.py

@@ -32,3 +32,8 @@ add_to_project_group = project_group.add_group(
 add_fastapp_to_project_group = add_to_project_group.add_group(
     Group(name="fastapp", description="🚀 Add Fastapp resources")
 )
+
+setup_group = cli.add_group(Group(name="setup", description="🔧 Setup"))
+setup_latex_group = setup_group.add_group(
+    Group(name="latex", description="✍️ Setup LaTeX")
+)

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/dev/asdf.py

@@ -0,0 +1,86 @@
+import os
+
+from zrb.builtin.group import setup_group
+from zrb.builtin.setup.common_input import (
+    package_manager_input,
+    setup_bash_input,
+    setup_powershell_input,
+    setup_zsh_input,
+    use_sudo_input,
+)
+from zrb.builtin.setup.dev.asdf_helper import (
+    check_inexist_asdf_dir,
+    get_install_prerequisites_cmd,
+    setup_asdf_ps_config,
+    setup_asdf_sh_config,
+)
+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/dev/asdf_helper.py

@@ -0,0 +1,44 @@
+import os
+
+from zrb.context.any_context import AnyContext
+
+
+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):
+    dir_path = os.path.dirname(file_path)
+    os.makedirs(dir_path, exist_ok=True)
+    if not os.path.isfile(file_path):
+        with open(file_path, "w") as f:
+            f.write("")
+    with open(file_path, "r") as f:
+        content = f.read()
+    if asdf_config in content:
+        return
+    with open(file_path, "a") as f:
+        f.write(f"\n{asdf_config}\n")

zrb/builtin/setup/dev/tmux.py

@@ -0,0 +1,50 @@
+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.dev.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
+
+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):
+    with open(os.path.join(os.path.dirname(__file__), "tmux_config.sh"), "r") as f:
+        tmux_config_template = f.read()
+    tmux_config_file = os.path.expanduser(ctx.input["tmux-config"])
+    tmux_config_dir = os.path.dirname(tmux_config_file)
+    # Make sure config file exists
+    os.makedirs(tmux_config_dir, exist_ok=True)
+    if not os.path.isfile(tmux_config_file):
+        with open(tmux_config_file, "w") as f:
+            f.write("")
+    with open(tmux_config_file, "r") as f:
+        # config file already contain the config
+        if tmux_config_template in f.read():
+            return
+    # Write config
+    with open(tmux_config_file, "a") as f:
+        f.write(f"\n{tmux_config_template}\n")
+    ctx.print("Setup complete, restart your terminal to continue")
+
+
+install_tmux >> setup_tmux

zrb/builtin/setup/dev/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/system/latex/ubuntu.py

@@ -0,0 +1,18 @@
+from zrb.builtin.group import setup_latex_group
+from zrb.builtin.setup.system.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/system/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/todo.py

@@ -51,7 +51,7 @@ from zrb.util.todo import (
     group=todo_group,
     alias="add",
 )
-def todo_add(ctx: AnyContext):
+def add_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -81,7 +81,7 @@ def todo_add(ctx: AnyContext):
 
 
 @make_task(name="todo-list", description="📋 List todo", group=todo_group, alias="list")
-def todo_list(ctx: AnyContext):
+def list_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_tasks: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -96,7 +96,7 @@ def todo_list(ctx: AnyContext):
     group=todo_group,
     alias="complete",
 )
-def todo_complete(ctx: AnyContext):
+def complete_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -142,7 +142,7 @@ def todo_complete(ctx: AnyContext):
     group=todo_group,
     alias="log",
 )
-def todo_log(ctx: AnyContext):
+def log_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -156,7 +156,6 @@ def todo_log(ctx: AnyContext):
     todo_task = cascade_todo_task(todo_task)
     current_duration = todo_task.keyval.get("duration", "0")
     todo_task.keyval["duration"] = add_durations(current_duration, ctx.input.duration)
-    print(current_duration, todo_task.keyval)
     # Save todo list
     save_todo_list(todo_file_path, todo_list)
     # Add log work
@@ -197,7 +196,7 @@ def _get_default_start() -> str:
     group=todo_group,
     alias="edit",
 )
-def todo_edit(ctx: AnyContext):
+def edit_todo(ctx: AnyContext):
     todo_list = [
         cascade_todo_task(line_to_todo_task(line))
         for line in ctx.input.text.split("\n")

zrb/config.py

@@ -49,6 +49,9 @@ LOGGING_LEVEL = _get_log_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
 LOAD_BUILTIN = to_boolean(os.getenv("ZRB_LOAD_BUILTIN", "1"))
 ENV_PREFIX = os.getenv("ZRB_ENV", "")
 SHOW_PROMPT = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
+WARN_UNRECOMMENDED_COMMAND = to_boolean(
+    os.getenv("ZRB_WARN_UNRECOMMENDED_COMMAND", "1")
+)
 SESSION_LOG_DIR = os.getenv(
     "ZRB_SESSION_LOG_DIR", os.path.expanduser(os.path.join("~", ".zrb-session"))
 )
@@ -77,7 +80,7 @@ BANNER = f"""
    zzzzz rr     bbbbbb   {VERSION} Janggala
    _ _ . .  . _ .  _ . . .
 
-A Framework to Enhance Your Workflow
+Your Automation Powerhouse
 
 ☕ Donate at: https://stalchmst.com/donation
 🐙 Submit issues/PR at: https://github.com/state-alchemists/zrb

zrb/runner/web_app.py

@@ -142,9 +142,3 @@ def create_app(root_group: AnyGroup, port: int = WEB_HTTP_PORT):
             raise HTTPException(status_code=500, detail=str(e))
 
     return app
-
-
-# async def run_web_server(app: FastAPI, port: int = WEB_HTTP_PORT):
-#     config = Config(app=app, host="0.0.0.0", port=port, loop="asyncio")
-#     server = Server(config)
-#     await server.serve()

zrb/task/any_task.py

@@ -74,6 +74,12 @@ class AnyTask(ABC):
         """Task fallbacks"""
         pass
 
+    @property
+    @abstractmethod
+    def successors(self) -> list["AnyTask"]:
+        """Task successors"""
+        pass
+
     @property
     @abstractmethod
     def readiness_checks(self) -> list["AnyTask"]:
@@ -81,8 +87,38 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def append_upstreams(self, upstreams: "AnyTask" | list["AnyTask"]):
-        """Sets the upstream tasks that this task depends on.
+    def append_fallback(self, fallbacks: "AnyTask" | list["AnyTask"]):
+        """Add the fallback tasks.
+
+        Args:
+            fallbacks (AnyTask | list[AnyTask]): A single fallback task or
+                a list of fallback tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_successor(self, successors: "AnyTask" | list["AnyTask"]):
+        """Add the successor tasks.
+
+        Args:
+            successors (AnyTask | list[AnyTask]): A single successor task or
+                a list of successor tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_readiness_check(self, readiness_checks: "AnyTask" | list["AnyTask"]):
+        """Add the readiness_check tasks.
+
+        Args:
+            readiness_checks (AnyTask | list[AnyTask]): A single readiness_check task or
+                a list of readiness_check tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_upstream(self, upstreams: "AnyTask" | list["AnyTask"]):
+        """Add the upstream tasks that this task depends on.
 
         Args:
             upstreams (AnyTask | list[AnyTask]): A single upstream task or