zrb 1.0.0a2__py3-none-any.whl → 1.0.0a3__py3-none-any.whl

zrb/__init__.py

@@ -1,4 +1,4 @@
-from .attr.type import (
+from zrb.attr.type import (
     AnyAttr,
     BoolAttr,
     FloatAttr,
@@ -7,44 +7,50 @@ from .attr.type import (
     StrDictAttr,
     fstring,
 )
-from .callback.any_callback import AnyCallback
-from .callback.callback import Callback
-from .cmd.cmd_result import CmdResult
-from .cmd.cmd_val import Cmd, CmdPath
-from .config import SHOULD_LOAD_BUILTIN
-from .content_transformer.any_content_transformer import AnyContentTransformer
-from .content_transformer.content_transformer import ContentTransformer
-from .context.any_context import AnyContext
-from .context.any_shared_context import AnySharedContext
-from .context.context import Context
-from .context.shared_context import SharedContext
-from .env.any_env import AnyEnv
-from .env.env import Env
-from .env.env_file import EnvFile
-from .env.env_map import EnvMap
-from .group.any_group import AnyGroup
-from .group.group import Group
-from .input.any_input import AnyInput
-from .input.base_input import BaseInput
-from .input.int_input import IntInput
-from .input.password_input import PasswordInput
-from .input.str_input import StrInput
-from .input.text_input import TextInput
-from .runner.cli import cli
-from .session.session import Session
-from .task.any_task import AnyTask
-from .task.base_task import BaseTask
-from .task.base_trigger import BaseTrigger
-from .task.cmd_task import CmdTask
-from .task.http_check import HttpCheck
-from .task.make_task import make_task
-from .task.rsync_task import RsyncTask
-from .task.scaffolder import Scaffolder
-from .task.scheduler import Scheduler
-from .task.task import Task
-from .task.tcp_check import TcpCheck
-from .xcom.xcom import Xcom
+from zrb.callback.any_callback import AnyCallback
+from zrb.callback.callback import Callback
+from zrb.cmd.cmd_result import CmdResult
+from zrb.cmd.cmd_val import Cmd, CmdPath
+from zrb.config import SHOULD_LOAD_BUILTIN
+from zrb.content_transformer.any_content_transformer import AnyContentTransformer
+from zrb.content_transformer.content_transformer import ContentTransformer
+from zrb.context.any_context import AnyContext
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.context.context import Context
+from zrb.context.shared_context import SharedContext
+from zrb.env.any_env import AnyEnv
+from zrb.env.env import Env
+from zrb.env.env_file import EnvFile
+from zrb.env.env_map import EnvMap
+from zrb.group.any_group import AnyGroup
+from zrb.group.group import Group
+from zrb.input.any_input import AnyInput
+from zrb.input.base_input import BaseInput
+from zrb.input.bool_input import BoolInput
+from zrb.input.int_input import IntInput
+from zrb.input.option_input import OptionInput
+from zrb.input.password_input import PasswordInput
+from zrb.input.str_input import StrInput
+from zrb.input.text_input import TextInput
+from zrb.runner.cli import cli
+from zrb.session.session import Session
+from zrb.task.any_task import AnyTask
+from zrb.task.base_task import BaseTask
+from zrb.task.base_trigger import BaseTrigger
+from zrb.task.cmd_task import CmdTask
+from zrb.task.http_check import HttpCheck
+from zrb.task.llm_task import LLMTask
+from zrb.task.make_task import make_task
+from zrb.task.rsync_task import RsyncTask
+from zrb.task.scaffolder import Scaffolder
+from zrb.task.scheduler import Scheduler
+from zrb.task.task import Task
+from zrb.task.tcp_check import TcpCheck
+from zrb.util.load import load_file, load_module
+from zrb.xcom.xcom import Xcom
 
+assert load_file
+assert load_module
 assert fstring
 assert AnyAttr
 assert BoolAttr
@@ -60,6 +66,7 @@ assert EnvFile
 assert EnvMap
 assert AnyInput
 assert BaseInput
+assert BoolInput
 assert Cmd
 assert CmdPath
 assert CmdResult
@@ -67,6 +74,7 @@ assert CmdTask
 assert HttpCheck
 assert TcpCheck
 assert IntInput
+assert OptionInput
 assert PasswordInput
 assert StrInput
 assert TextInput
@@ -77,6 +85,7 @@ assert BaseTask
 assert BaseTrigger
 assert RsyncTask
 assert Task
+assert LLMTask
 assert Session
 assert AnyContext
 assert Context
@@ -91,6 +100,6 @@ assert cli
 assert Xcom
 
 if SHOULD_LOAD_BUILTIN:
-    from . import builtin
+    from zrb import builtin
 
     assert builtin

zrb/__main__.py

@@ -1,8 +1,8 @@
 import sys
 
-from .runner.cli import cli
-from .util.cli.style import stylize_error
-from .util.group import NodeNotFoundError
+from zrb.runner.cli import cli
+from zrb.util.cli.style import stylize_error
+from zrb.util.group import NodeNotFoundError
 
 
 def serve_cli():

zrb/attr/type.py

@@ -1,6 +1,6 @@
 from typing import Any, Callable
 
-from ..context.any_shared_context import AnySharedContext
+from zrb.context.any_shared_context import AnySharedContext
 
 fstring = str
 AnyAttr = Any | fstring | Callable[[AnySharedContext], Any]
@@ -9,3 +9,4 @@ BoolAttr = bool | fstring | Callable[[AnySharedContext], bool]
 IntAttr = int | fstring | Callable[[AnySharedContext], int]
 FloatAttr = float | fstring | Callable[[AnySharedContext], float]
 StrDictAttr = dict[str, StrAttr] | Callable[[AnySharedContext], dict[str, Any]]
+StrListAttr = list[StrAttr] | Callable[[AnySharedContext], list[str]]

zrb/builtin/__init__.py

@@ -1,3 +1,41 @@
-from . import shell
+from zrb.builtin.base64 import decode_base64, encode_base64
+from zrb.builtin.git import (
+    get_git_diff,
+    git_commit,
+    git_pull,
+    git_push,
+    prune_local_branches,
+)
+from zrb.builtin.git_subtree import git_add_subtree, git_pull_subtree, git_push_subtree
+from zrb.builtin.llm import llm_chat
+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.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_edit, todo_list
 
-assert shell
+assert create_project
+assert add_fastapp_to_project
+assert get_shell_subcommands
+assert make_bash_autocomplete
+assert make_zsh_autocomplete
+assert encode_base64
+assert decode_base64
+assert llm_chat
+assert hash_md5
+assert sum_md5
+assert get_git_diff
+assert prune_local_branches
+assert format_python_code
+assert git_commit
+assert git_pull
+assert git_push
+assert git_add_subtree
+assert git_pull_subtree
+assert git_push_subtree
+assert todo_list
+assert todo_add
+assert todo_edit

zrb/builtin/base64.py

@@ -0,0 +1,32 @@
+import base64
+
+from zrb.builtin.group import base64_group
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.task.make_task import make_task
+
+
+@make_task(
+    name="encode-base64",
+    input=StrInput(name="text", description="Text", prompt="Text to encode"),
+    description="🔐 Encode text to base64",
+    group=base64_group,
+    alias="encode",
+)
+def encode_base64(ctx: AnyContext) -> str:
+    result = base64.b64encode(ctx.input.text.encode()).decode()
+    ctx.print(result)
+    return result
+
+
+@make_task(
+    name="decode-base64",
+    input=StrInput(name="text", description="Text", prompt="Text to encode"),
+    description="🔓 Decode base64 text",
+    group=base64_group,
+    alias="decode",
+)
+def decode_base64(ctx: AnyContext) -> str:
+    result = base64.b64decode(ctx.input.text.encode()).decode()
+    ctx.print(result)
+    return result

zrb/builtin/git.py

@@ -0,0 +1,156 @@
+from zrb.builtin.group import git_branch_group, git_group
+from zrb.context.any_context import AnyContext
+from zrb.input.bool_input import BoolInput
+from zrb.input.str_input import StrInput
+from zrb.task.make_task import make_task
+from zrb.util.cli.style import stylize_green, stylize_red, stylize_yellow
+from zrb.util.git import (
+    add,
+    commit,
+    delete_branch,
+    get_branches,
+    get_current_branch,
+    get_diff,
+    pull,
+    push,
+)
+
+
+@make_task(
+    name="get-git-diff",
+    input=[
+        StrInput(
+            name="source",
+            description="Source branch/tag/commit",
+            prompt="Source branch/tag/commit",
+            default_str="main",
+        ),
+        StrInput(
+            name="current",
+            description="Current branch/tag/commit",
+            prompt="Current branch/tag/commit",
+            default_str="HEAD",
+        ),
+        BoolInput(
+            name="created",
+            description="Include created files",
+            prompt="Include created files",
+            default_str="True",
+        ),
+        BoolInput(
+            name="removed",
+            description="Include removed files",
+            prompt="Include removed files",
+            default_str="True",
+        ),
+        BoolInput(
+            name="updated",
+            description="Include updated files",
+            prompt="Include updated files",
+            default_str="True",
+        ),
+    ],
+    description="🔍 Get modified files",
+    group=git_group,
+    alias="diff",
+)
+def get_git_diff(ctx: AnyContext):
+    diff = get_diff(ctx.input.source, ctx.input.current)
+    result = []
+    decorated = []
+    if ctx.input.created and diff.created:
+        decorated += [stylize_green(f"++ {name}") for name in diff.created]
+        result += diff.created
+    if ctx.input.updated and diff.updated:
+        decorated += [stylize_yellow(f"+- {name}") for name in diff.updated]
+        result += diff.updated
+    if ctx.input.removed and diff.removed:
+        decorated += [stylize_red(f"-- {name}") for name in diff.removed]
+        result += diff.removed
+    if len(decorated) > 0:
+        decorated = [""] + decorated + [""]
+    ctx.print(
+        "\n" + "\n".join((f"    {decorated_line}" for decorated_line in decorated))
+    )
+    return "\n".join(result)
+
+
+@make_task(
+    name="prune-local-git-branches",
+    description="🧹 Prune local branches",
+    group=git_branch_group,
+    alias="prune",
+)
+def prune_local_branches(ctx: AnyContext):
+    branches = get_branches()
+    current_branch = get_current_branch()
+    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)
+        except Exception as e:
+            ctx.log_error(e)
+
+
+@make_task(
+    name="git-commit",
+    input=StrInput(
+        name="message",
+        description="Commit message",
+        prompt="Commit message",
+        default_str="Add feature/fix bug",
+    ),
+    description="📝 Commit changes",
+    group=git_group,
+    alias="commit",
+)
+def git_commit(ctx: AnyContext):
+    ctx.print("Add changes to staging")
+    add()
+    ctx.print("Commit changes")
+    try:
+        commit(ctx.input.message)
+    except Exception as e:
+        ctx.log_error(e)
+
+
+@make_task(
+    name="git-pull",
+    description="📥 Pull changes from remote repository",
+    input=StrInput(
+        name="remote",
+        description="Remote name",
+        prompt="Remote name",
+        default_str="origin",
+    ),
+    upstream=git_commit,
+    group=git_group,
+    alias="pull",
+)
+def git_pull(ctx: AnyContext):
+    remote = ctx.input.remote
+    current_branch = get_current_branch()
+    ctx.print(f"Pulling from {remote}/{current_branch}")
+    pull(remote, current_branch)
+
+
+@make_task(
+    name="git-push",
+    description="📤 Push changes to remote repository",
+    input=StrInput(
+        name="remote",
+        description="Remote name",
+        prompt="Remote name",
+        default_str="origin",
+    ),
+    upstream=git_commit,
+    group=git_group,
+    alias="push",
+)
+def git_push(ctx: AnyContext):
+    remote = ctx.input.remote
+    current_branch = get_current_branch()
+    ctx.print(f"Pushing to {remote}/{current_branch}")
+    push(remote, current_branch)

zrb/builtin/git_subtree.py

@@ -0,0 +1,88 @@
+from zrb.builtin.git import git_commit
+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_subtree import add_subtree, load_config, pull_subtree, push_subtree
+
+
+@make_task(
+    name="git-add-subtree",
+    input=[
+        StrInput(
+            name="name", description="Subtree config name", prompt="Subtree config name"
+        ),
+        StrInput(
+            name="repo-url", description="Subtree repo URL", prompt="Subtree repo URL"
+        ),
+        StrInput(
+            name="repo-branch",
+            description="Subtree repo branch",
+            prompt="Subtree repo branch",
+        ),
+        StrInput(
+            name="repo-prefix",
+            description="Subtree repo prefix",
+            prompt="Subtree repo prefix",
+        ),
+    ],
+    description="➕ Add subtree",
+    upstream=git_commit,
+    group=git_subtree_group,
+    alias="add",
+)
+def git_add_subtree(ctx: AnyContext):
+    add_subtree(
+        name=ctx.input.name,
+        repo_url=ctx.input["repo-url"],
+        branch=ctx.input["repo-branch"],
+        prefix=ctx.input["repo-prefix"],
+    )
+
+
+@make_task(
+    name="git-pull-subtree",
+    description="📥 Pull subtree",
+    upstream=git_commit,
+    group=git_subtree_group,
+    alias="pull",
+)
+def git_pull_subtree(ctx: AnyContext):
+    config = load_config()
+    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)
+        except Exception as e:
+            if first_err is None:
+                first_err = e
+            ctx.log_error(e)
+    if first_err is not None:
+        raise first_err
+
+
+@make_task(
+    name="git-push-subtree",
+    description="📤 Push subtree",
+    upstream=git_commit,
+    group=git_subtree_group,
+    alias="push",
+)
+def git_push_subtree(ctx: AnyContext):
+    config = load_config()
+    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)
+        except Exception as e:
+            if first_err is None:
+                first_err = e
+            ctx.log_error(e)
+    if first_err is not None:
+        raise first_err

zrb/builtin/group.py

@@ -0,0 +1,34 @@
+from zrb.group.group import Group
+from zrb.runner.cli import cli
+
+base64_group = cli.add_group(Group(name="base64", description="📄 Base64 operations"))
+git_group = cli.add_group(Group(name="git", description="🌱 Git related commands"))
+git_branch_group = git_group.add_group(
+    Group(name="branch", description="🌿 Git branch related commands")
+)
+git_subtree_group = git_group.add_group(
+    Group(name="subtree", description="🌳 Git subtree related commands")
+)
+llm_group = cli.add_group(Group(name="llm", description="🤖 LLM operations"))
+md5_group = cli.add_group(Group(name="md5", description="🔢 Md5 operations"))
+python_group = cli.add_group(
+    Group(name="python", description="🐍 Python related commands")
+)
+todo_group = cli.add_group(Group(name="todo", description="✅ Todo management"))
+
+shell_group = cli.add_group(
+    Group(name="shell", description="💬 Shell related commands")
+)
+shell_autocomplete_group: Group = shell_group.add_group(
+    Group(name="autocomplete", description="⌨️ Shell autocomplete related commands")
+)
+
+project_group = cli.add_group(
+    Group(name="project", description="📁 Project related commands")
+)
+add_to_project_group = project_group.add_group(
+    Group(name="add", description="➕ Add things to project")
+)
+add_fastapp_to_project_group = add_to_project_group.add_group(
+    Group(name="fastapp", description="🚀 Add Fastapp resources")
+)

zrb/builtin/llm.py

@@ -0,0 +1,31 @@
+from zrb.builtin.group import llm_group
+from zrb.config import LLM_MODEL, LLM_SYSTEM_PROMPT
+from zrb.input.str_input import StrInput
+from zrb.input.text_input import TextInput
+from zrb.task.llm_task import LLMTask
+
+llm_chat = llm_group.add_task(
+    LLMTask(
+        name="llm-chat",
+        input=[
+            StrInput(
+                "model",
+                description="LLM Model",
+                prompt="LLM Model",
+                default_str=LLM_MODEL,
+            ),
+            StrInput(
+                "system-prompt",
+                description="System prompt",
+                prompt="System prompt",
+                default_str=LLM_SYSTEM_PROMPT,
+            ),
+            TextInput("message", description="User message", prompt="Your message"),
+        ],
+        description="Chat with LLM",
+        model="{ctx.input.model}",
+        system_prompt="{ctx.input['system-prompt']}",
+        message="{ctx.input.message}",
+    ),
+    alias="chat",
+)

zrb/builtin/md5.py

@@ -0,0 +1,34 @@
+import hashlib
+
+from zrb.builtin.group import md5_group
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.task.make_task import make_task
+
+
+@make_task(
+    name="hash-md5",
+    input=StrInput(name="text", description="Text", prompt="Text to encode"),
+    description="🧩 Hash text to md5",
+    group=md5_group,
+    alias="hash",
+)
+def hash_md5(ctx: AnyContext) -> str:
+    result = hashlib.md5(ctx.input.text.encode()).hexdigest()
+    ctx.print(result)
+    return result
+
+
+@make_task(
+    name="sum-md5",
+    input=StrInput(name="file", description="File name", prompt="File name"),
+    description="➕ Get md5 checksum of a file",
+    group=md5_group,
+    alias="sum",
+)
+def sum_md5(ctx: AnyContext) -> str:
+    with open(ctx.input.file, mode="rb") as file:
+        content = file.read()
+    result = hashlib.md5(content).hexdigest()
+    ctx.print(result)
+    return result

zrb/builtin/project/add/fastapp.py

@@ -0,0 +1,72 @@
+import os
+
+from zrb.builtin.group import add_to_project_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.task.scaffolder import Scaffolder
+from zrb.task.task import Task
+from zrb.util.string.conversion import double_quote
+from zrb.util.string.name import get_random_name
+
+_DIR = os.path.dirname(__file__)
+
+
+scaffold_fastapp = Scaffolder(
+    name="scaffold-fastapp",
+    input=[
+        StrInput(
+            name="project-dir",
+            description="Project directory",
+            prompt="Project directory",
+            default_str=lambda _: os.getcwd(),
+        ),
+        StrInput(
+            name="app-name",
+            description="App name",
+            prompt="App name",
+            default_str=lambda _: get_random_name(separator="_"),
+        ),
+    ],
+    source_path=os.path.join(_DIR, "fastapp_template"),
+    auto_render_source_path=False,
+    destination_path=lambda ctx: os.path.join(
+        ctx.input["project-dir"], ctx.input["app-name"]
+    ),
+    transform_content={
+        "fastapp_template": "{to_snake_case(ctx.input['app-name'])}",
+        "App Name": "{ctx.input['app-name'].title()}",
+        "App name": "{ctx.input['app-name'].capitalize()}",
+        "app-name": "{to_kebab_case(ctx.input['app-name'])}",
+        "app_name": "{to_snake_case(ctx.input['app-name'])}",
+        "APP_NAME": "{to_snake_case(ctx.input['app-name']).upper()}",
+        "secure-password": lambda _: get_random_name(),
+    },
+    retries=0,
+)
+
+
+@make_task(
+    name="register-fastapp-automation",
+)
+def register_fastapp_automation(ctx: AnyContext):
+    project_dir_path = ctx.input["project-dir"]
+    zrb_init_path = os.path.join(project_dir_path, "zrb_init.py")
+    app_dir_path = ctx.input["app-name"]
+    app_automation_file_part = ", ".join(
+        [double_quote(part) for part in [app_dir_path, "_zrb", "main.py"]]
+    )
+    with open(zrb_init_path, "+a") as f:
+        f.write(f"load_file(os.path.join(_DIR, {app_automation_file_part}))\n")
+
+
+scaffold_fastapp >> register_fastapp_automation
+
+add_fastapp_to_project = add_to_project_group.add_task(
+    Task(
+        name="add-fastapp",
+        description="🚀 Add FastApp to project",
+    ),
+    alias="fastapp",
+)
+add_fastapp_to_project << [register_fastapp_automation]

zrb/builtin/project/add/fastapp_template/.gitignore

@@ -0,0 +1,4 @@
+__pycache__
+.venv
+.env
+*.db

zrb/builtin/project/add/fastapp_template/README.md

@@ -0,0 +1,7 @@
+# App Name
+
+# Principle
+
+- Developer should be able to override everything with sane amount of code.
+- Simple tasks should only require small amount of code.
+- A bit of magic is okay as long as transparent and documented.