zrb 0.28.0__tar.gz → 1.0.0a5__tar.gz

zrb-1.0.0a5/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.1
+Name: zrb
+Version: 1.0.0a5
+Summary: Your Automation Powerhouse
+Home-page: https://github.com/state-alchemists/zrb
+License: AGPL-3.0-or-later
+Keywords: Automation,Task Runner,Code Generator,Monorepo,Low Code
+Author: Go Frendi Gunawan
+Author-email: gofrendiasgard@gmail.com
+Requires-Python: >=3.10.0,<4.0.0
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: rag
+Requires-Dist: autopep8 (>=2.0.4,<3.0.0)
+Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
+Requires-Dist: black (>=24.10.0,<24.11.0)
+Requires-Dist: chromadb (>=0.5.20,<0.6.0) ; extra == "rag"
+Requires-Dist: fastapi[standard] (>=0.115.5,<0.116.0)
+Requires-Dist: isort (>=5.13.2,<5.14.0)
+Requires-Dist: libcst (>=1.5.0,<2.0.0)
+Requires-Dist: litellm (>=1.52.12,<2.0.0)
+Requires-Dist: pdfplumber (>=0.11.4,<0.12.0) ; extra == "rag"
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Project-URL: Documentation, https://github.com/state-alchemists/zrb
+Project-URL: Repository, https://github.com/state-alchemists/zrb
+Description-Content-Type: text/markdown
+
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
+
+# 🤖 Zrb: Your Automation Powerhouse
+
+With Zrb, you can write your automation tasks like this:
+
+
+```python
+# Filename: zrb_init.py
+from zrb import cli, Task, Group, IntInput
+
+math = cli.add_group(Group("math", description="Math tools"))
+math.add_task(Task(
+    name="add",
+    input=[
+        IntInput("a", description="First number"),
+        IntInput("b", description="Second number")
+    ],
+    action=lambda ctx: ctx.input.a + ctx.input.b
+))
+```
+
+You can then access the task in various ways.
+
+__Using CLI with arguments__
+
+```bash
+zrb math add 4 5
+```
+
+Result:
+
+```
+9
+To run again: zrb math add --a=4 --b=5
+```
+
+__Using CLI with keyword arguments__
+
+```bash
+zrb math add --a 4 --b 5
+```
+
+Result:
+
+```
+9
+To run again: zrb math add --a=4 --b=5
+```
+
+__Using CLI with incomplete arguments__
+
+```bash
+zrb math add 4
+```
+
+Result:
+
+```
+b [0]: 5
+9
+To run again: zrb math add 4
+```
+
+__Using Web Interface__
+
+```bash
+zrb server start
+```
+
+Result (you need to access `http://localhost:21213`)
+
+![](https://raw.githubusercontent.com/state-alchemists/zrb/refs/heads/1.0.0/_images/web.png)
+
+__More:__
+
+[![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
+
+
+# 🫰 Installing Zrb
+
+You can install Zrb as a pip package by invoking the following command:
+
+```bash
+pip install --pre zrb
+```
+
+Alternatively, you can also use our installation script to install Zrb along with some prerequisites:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/refs/heads/1.0.0/install.sh)"
+# bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
+```
+
+# 🐞 Bug Report + Feature Request
+
+You can submit bug reports and feature requests by creating a new [issue](https://github.com/state-alchemists/zrb/issues) on Zrb's GitHub Repositories. When reporting a bug or requesting a feature, please be sure to:
+
+- Include the version of Zrb you are using (i.e., `zrb version`)
+- Tell us what you have tried
+- Tell us what you expect
+- Tell us what you get
+
+We will also welcome your [pull requests and contributions](https://github.com/state-alchemists/zrb/pulls).
+
+
+# ☕ Donation
+
+Help Red Skull to click the donation button:
+
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
+
+# 🎉 Fun Fact
+
+> Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. [(Garo Wiki | Fandom)](https://garo.fandom.com/wiki/Zaruba)
+
+![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/madou-ring-zaruba.jpg)
+

zrb-1.0.0a5/README.md

@@ -0,0 +1,117 @@
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
+
+# 🤖 Zrb: Your Automation Powerhouse
+
+With Zrb, you can write your automation tasks like this:
+
+
+```python
+# Filename: zrb_init.py
+from zrb import cli, Task, Group, IntInput
+
+math = cli.add_group(Group("math", description="Math tools"))
+math.add_task(Task(
+    name="add",
+    input=[
+        IntInput("a", description="First number"),
+        IntInput("b", description="Second number")
+    ],
+    action=lambda ctx: ctx.input.a + ctx.input.b
+))
+```
+
+You can then access the task in various ways.
+
+__Using CLI with arguments__
+
+```bash
+zrb math add 4 5
+```
+
+Result:
+
+```
+9
+To run again: zrb math add --a=4 --b=5
+```
+
+__Using CLI with keyword arguments__
+
+```bash
+zrb math add --a 4 --b 5
+```
+
+Result:
+
+```
+9
+To run again: zrb math add --a=4 --b=5
+```
+
+__Using CLI with incomplete arguments__
+
+```bash
+zrb math add 4
+```
+
+Result:
+
+```
+b [0]: 5
+9
+To run again: zrb math add 4
+```
+
+__Using Web Interface__
+
+```bash
+zrb server start
+```
+
+Result (you need to access `http://localhost:21213`)
+
+![](https://raw.githubusercontent.com/state-alchemists/zrb/refs/heads/1.0.0/_images/web.png)
+
+__More:__
+
+[![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
+
+
+# 🫰 Installing Zrb
+
+You can install Zrb as a pip package by invoking the following command:
+
+```bash
+pip install --pre zrb
+```
+
+Alternatively, you can also use our installation script to install Zrb along with some prerequisites:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/refs/heads/1.0.0/install.sh)"
+# bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
+```
+
+# 🐞 Bug Report + Feature Request
+
+You can submit bug reports and feature requests by creating a new [issue](https://github.com/state-alchemists/zrb/issues) on Zrb's GitHub Repositories. When reporting a bug or requesting a feature, please be sure to:
+
+- Include the version of Zrb you are using (i.e., `zrb version`)
+- Tell us what you have tried
+- Tell us what you expect
+- Tell us what you get
+
+We will also welcome your [pull requests and contributions](https://github.com/state-alchemists/zrb/pulls).
+
+
+# ☕ Donation
+
+Help Red Skull to click the donation button:
+
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
+
+# 🎉 Fun Fact
+
+> Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. [(Garo Wiki | Fandom)](https://garo.fandom.com/wiki/Zaruba)
+
+![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/madou-ring-zaruba.jpg)

zrb-1.0.0a5/pyproject.toml

@@ -0,0 +1,73 @@
+[tool.poetry]
+name = "zrb"
+version = "1.0.0a5"
+description = "Your Automation Powerhouse"
+authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
+license = "AGPL-3.0-or-later"
+readme = "README.md"
+homepage = "https://github.com/state-alchemists/zrb"
+repository = "https://github.com/state-alchemists/zrb"
+documentation = "https://github.com/state-alchemists/zrb"
+keywords = ["Automation", "Task Runner", "Code Generator", "Monorepo", "Low Code"]
+exclude = [
+    "__pycache__",
+    "_images",
+    ".github",
+    ".pytest_cache",
+    ".venv",
+    ".vscode",
+    "dist",
+    "docker",
+    "docs",
+    "htmlcov",
+    "playground",
+    "test",
+    ".coverage",
+    ".coveragerc",
+    ".cprofile.prof",
+    ".cprofile.svg",
+    ".env",
+    ".flake8",
+    ".gitignore",
+    ".python-version",
+    "install.sh",
+    "project.sh",
+    "README.md",
+    "template.env",
+    "zrb_init.py"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10.0,<4.0.0"
+python-dotenv = "^1.0.1"
+autopep8 = "^2.0.4"
+black = "~24.10.0"
+isort = "~5.13.2"
+requests = "^2.32.3"
+libcst = "^1.5.0"
+litellm = "^1.52.12"
+chromadb = {version = "^0.5.20", optional = true}
+pdfplumber = {version = "^0.11.4", optional = true}
+beautifulsoup4 = "^4.12.3"
+fastapi = {extras = ["standard"], version = "^0.115.5"}
+
+[tool.poetry.extras]
+# poetry install -E rag
+rag = ["chromadb", "pdfplumber"]
+
+[tool.poetry.dev-dependencies]
+flake8 = "~7.1.1"
+pytest = "~8.3.3"
+pytest-cov = "~6.0.0"
+pytest-asyncio = "~0.24.0"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.poetry.scripts]
+zrb = "zrb.__main__:serve_cli"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+

zrb-1.0.0a5/src/zrb/__init__.py

@@ -0,0 +1,105 @@
+from zrb.attr.type import (
+    AnyAttr,
+    BoolAttr,
+    FloatAttr,
+    IntAttr,
+    StrAttr,
+    StrDictAttr,
+    fstring,
+)
+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 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
+assert IntAttr
+assert FloatAttr
+assert StrAttr
+assert StrDictAttr
+assert AnyCallback
+assert Callback
+assert AnyEnv
+assert Env
+assert EnvFile
+assert EnvMap
+assert AnyInput
+assert BaseInput
+assert BoolInput
+assert Cmd
+assert CmdPath
+assert CmdResult
+assert CmdTask
+assert HttpCheck
+assert TcpCheck
+assert IntInput
+assert OptionInput
+assert PasswordInput
+assert StrInput
+assert TextInput
+assert AnyGroup
+assert Group
+assert AnyTask
+assert BaseTask
+assert BaseTrigger
+assert RsyncTask
+assert Task
+assert LLMTask
+assert Session
+assert AnyContext
+assert Context
+assert AnySharedContext
+assert SharedContext
+assert make_task
+assert AnyContentTransformer
+assert ContentTransformer
+assert Scaffolder
+assert Scheduler
+assert cli
+assert Xcom
+
+if LOAD_BUILTIN:
+    from zrb import builtin
+
+    assert builtin

zrb-1.0.0a5/src/zrb/__main__.py

@@ -0,0 +1,14 @@
+import sys
+
+from zrb.runner.cli import cli
+from zrb.util.cli.style import stylize_error, stylize_warning
+from zrb.util.group import NodeNotFoundError
+
+
+def serve_cli():
+    try:
+        cli.run(sys.argv[1:])
+    except KeyboardInterrupt:
+        print(stylize_warning("\nStopped"), file=sys.stderr)
+    except NodeNotFoundError as e:
+        print(stylize_error(f"{e}"), file=sys.stderr)

zrb-1.0.0a5/src/zrb/attr/type.py

@@ -0,0 +1,12 @@
+from typing import Any, Callable
+
+from zrb.context.any_shared_context import AnySharedContext
+
+fstring = str
+AnyAttr = Any | fstring | Callable[[AnySharedContext], Any]
+StrAttr = str | fstring | Callable[[AnySharedContext], str]
+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-1.0.0a5/src/zrb/builtin/__init__.py

@@ -0,0 +1,43 @@
+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.llm_chat 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_complete, todo_edit, todo_list, todo_log
+
+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
+assert todo_complete
+assert todo_log

zrb-1.0.0a5/src/zrb/builtin/base64.py

@@ -0,0 +1,34 @@
+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:
+    import base64
+
+    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:
+    import base64
+
+    result = base64.b64decode(ctx.input.text.encode()).decode()
+    ctx.print(result)
+    return result

zrb-1.0.0a5/src/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)