zrb 1.3.1__tar.gz → 1.4.1__tar.gz

zrb-1.4.1/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.1
+Name: zrb
+Version: 1.4.1
+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.6,<0.116.0)
+Requires-Dist: fastembed (>=0.5.1,<0.6.0)
+Requires-Dist: isort (>=5.13.2,<5.14.0)
+Requires-Dist: libcst (>=1.5.0,<2.0.0)
+Requires-Dist: pdfplumber (>=0.11.4,<0.12.0) ; extra == "rag"
+Requires-Dist: psutil (>=6.1.1,<7.0.0)
+Requires-Dist: pydantic-ai (>=0.0.42,<0.0.43)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: python-jose[cryptography] (>=3.4.0,<4.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: ulid-py (>=1.1.0,<2.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)
+
+[Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md)
+
+# 🤖 Zrb: Your Automation Powerhouse
+
+
+**Unlock the full potential of automation in your projects!**
+
+Zrb streamlines repetitive tasks, integrates with powerful LLMs, and lets you create custom automation workflows effortlessly. Whether you’re building CI/CD pipelines, code generators, or unique automation scripts, Zrb is designed to simplify and supercharge your workflow.
+
+---
+
+## 🚀 Why Zrb?
+
+- **Easy Automation with Python:** Write your tasks in Python and let Zrb handle the rest.
+- **Seamless Integration:** Utilize built-in support for LLM tasks, command execution, and more.
+- **Custom Workflows:** Chain tasks, set dependencies, and build robust automation pipelines.
+- **Developer-Friendly:** Quick to install and get started, with clear documentation and examples.
+- **Web Interface:** Run Zrb as a server to make tasks accessible even to non-technical team members.
+
+---
+
+## 🔥 Key Features
+
+- **LLM Integration:** Leverage state-of-the-art language models to generate code, diagrams, and documentation.
+- **Task Chaining:** Easily define dependencies between tasks to create complex workflows.
+- **CLI & Server Mode:** Run tasks directly from the command line or through a user-friendly web UI.
+- **Flexible Input Handling:** Defaults, prompts, and command-line parameters to suit any workflow.
+- **Extensible & Open Source:** Contribute, customize, or extend Zrb to fit your unique needs.
+
+---
+
+## 🛠️ Getting Started
+
+### Quick Installation
+
+Install Zrb via pip:
+
+```bash
+pip install zrb
+
+```
+
+Or run our installation script to set up Zrb along with all prerequisites:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
+
+```
+
+### Your First Task
+
+Create a file at `/home/<your-user-name>/zrb_init.py` with the following content:
+
+
+```python
+import os
+from zrb import cli, llm_config, LLMTask, CmdTask, StrInput, Group
+from zrb.builtin.llm.tool.file import read_all_files, write_text_file
+
+CURRENT_DIR = os.getcwd()
+
+# Make UML group
+uml_group = cli.add_group(Group(name="uml", description="UML related tasks"))
+
+# Generate UML script
+make_uml_script = uml_group.add_task(
+    LLMTask(
+        name="make-script",
+        description="Creating plantuml diagram based on source code in current directory",
+        input=StrInput(name="diagram", default="state diagram"),
+        message=(
+            f"Read source code in {CURRENT_DIR}, "
+            "make a {ctx.input.diagram} in plantuml format. "
+            f"Write the script into {CURRENT_DIR}/{{ctx.input.diagram}}.uml"
+        ),
+        tools=[
+            read_all_files,
+            write_text_file,
+        ],
+    )
+)
+
+# Defining a Cmd Task to transform Plantuml script into a png image.
+make_uml_image = uml_group.add_task(
+    CmdTask(
+        name="make-image",
+        description="Creating png based on source code in current directory",
+        input=StrInput(name="diagram", default="state diagram"),
+        cmd="plantuml -tpng '{ctx.input.diagram}.uml'",
+        cwd=CURRENT_DIR,
+    )
+)
+
+# Making sure that make_png has make_uml as its dependency.
+make_uml_script >> make_uml_image
+```
+
+You have just define two automation tasks.
+
+The first one use LLM to read files in your current directory and create a `PlantUML script` on that directory.
+
+The second task turn the PlantUML script into a `*.png` file. The second task depends on the first task and both of them are located under the same group.
+
+You can run the tasks by invoking `zrb uml make-script` or `zrb uml make-image` respectively.
+
+When you run zrb, it automatically searches for a file named `zrb_init.py` starting from your current directory and moving upward through its parent directories. This design lets you set up common automation tasks in a central location—like placing a `zrb_init.py` in your home directory (`/home/<your-user>/zrb_init.py`)—so that your tasks are available across all your projects.
+
+Now, go to your project and create a state diagram:
+
+```bash
+git clone git@github.com:jjinux/gotetris.git
+cd gotetris
+zrb uml make-image --diagram "state diagram"
+```
+
+You can also invoke the task without specifying parameter.
+
+```bash
+zrb uml make-image
+```
+
+Once you do so, Zrb will ask you to provide the diagram type.
+
+```
+diagram [state diagram]:
+```
+
+You can just press enter if you want to use the default value (i.e., in this case `state diagram`).
+
+Finally, you can also serve the tasks via a Web UI interface by invoking the following command:
+
+```bash
+zrb server start
+```
+
+You will have a nice web interface running on `http://localhost:12123`
+
+![Zrb Web UI](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb-web-ui.png)
+
+Now, let's see how things work in detail. First, Zrb generates a `state diagram.uml` in your current directory, it then transform the UML script into a PNG image `state diagram.png`.
+
+![State Diagram](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/state-diagram.png)
+
+
+# 🎥 Demo & Documentation
+
+- **Step by step guide:** [Getting started with Zrb](https://github.com/state-alchemists/zrb/blob/main/docs/recipes/getting-started/README.md).
+- **Full documentation:** [Zrb Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md)
+- **Video demo:** [![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
+
+
+# 🤝 Join the Community
+
+- **Bug Reports & Feature Requests:** Create an [issue](https://github.com/state-alchemists/zrb/issues) on Zrb's GitHub Repositories and include:
+    - Your Zrb version (i.e., `zrb version`).
+    - Steps you’ve taken and what you expected versus what happened
+- **Contributions:** We welcome pull requests! Check out our [contribution guidelines](https://github.com/state-alchemists/zrb/pulls).
+
+
+# ☕ Support The Project
+
+If you find Zrb valuable, please consider donating:
+
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
+
+# 🎉 Fun Fact
+
+Did you know?
+
+Zrb is named after `Zaruba`, a powerful support tool from the Garo universe!
+
+> 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.4.1/README.md

@@ -0,0 +1,176 @@
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
+
+[Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md)
+
+# 🤖 Zrb: Your Automation Powerhouse
+
+
+**Unlock the full potential of automation in your projects!**
+
+Zrb streamlines repetitive tasks, integrates with powerful LLMs, and lets you create custom automation workflows effortlessly. Whether you’re building CI/CD pipelines, code generators, or unique automation scripts, Zrb is designed to simplify and supercharge your workflow.
+
+---
+
+## 🚀 Why Zrb?
+
+- **Easy Automation with Python:** Write your tasks in Python and let Zrb handle the rest.
+- **Seamless Integration:** Utilize built-in support for LLM tasks, command execution, and more.
+- **Custom Workflows:** Chain tasks, set dependencies, and build robust automation pipelines.
+- **Developer-Friendly:** Quick to install and get started, with clear documentation and examples.
+- **Web Interface:** Run Zrb as a server to make tasks accessible even to non-technical team members.
+
+---
+
+## 🔥 Key Features
+
+- **LLM Integration:** Leverage state-of-the-art language models to generate code, diagrams, and documentation.
+- **Task Chaining:** Easily define dependencies between tasks to create complex workflows.
+- **CLI & Server Mode:** Run tasks directly from the command line or through a user-friendly web UI.
+- **Flexible Input Handling:** Defaults, prompts, and command-line parameters to suit any workflow.
+- **Extensible & Open Source:** Contribute, customize, or extend Zrb to fit your unique needs.
+
+---
+
+## 🛠️ Getting Started
+
+### Quick Installation
+
+Install Zrb via pip:
+
+```bash
+pip install zrb
+
+```
+
+Or run our installation script to set up Zrb along with all prerequisites:
+
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"
+
+```
+
+### Your First Task
+
+Create a file at `/home/<your-user-name>/zrb_init.py` with the following content:
+
+
+```python
+import os
+from zrb import cli, llm_config, LLMTask, CmdTask, StrInput, Group
+from zrb.builtin.llm.tool.file import read_all_files, write_text_file
+
+CURRENT_DIR = os.getcwd()
+
+# Make UML group
+uml_group = cli.add_group(Group(name="uml", description="UML related tasks"))
+
+# Generate UML script
+make_uml_script = uml_group.add_task(
+    LLMTask(
+        name="make-script",
+        description="Creating plantuml diagram based on source code in current directory",
+        input=StrInput(name="diagram", default="state diagram"),
+        message=(
+            f"Read source code in {CURRENT_DIR}, "
+            "make a {ctx.input.diagram} in plantuml format. "
+            f"Write the script into {CURRENT_DIR}/{{ctx.input.diagram}}.uml"
+        ),
+        tools=[
+            read_all_files,
+            write_text_file,
+        ],
+    )
+)
+
+# Defining a Cmd Task to transform Plantuml script into a png image.
+make_uml_image = uml_group.add_task(
+    CmdTask(
+        name="make-image",
+        description="Creating png based on source code in current directory",
+        input=StrInput(name="diagram", default="state diagram"),
+        cmd="plantuml -tpng '{ctx.input.diagram}.uml'",
+        cwd=CURRENT_DIR,
+    )
+)
+
+# Making sure that make_png has make_uml as its dependency.
+make_uml_script >> make_uml_image
+```
+
+You have just define two automation tasks.
+
+The first one use LLM to read files in your current directory and create a `PlantUML script` on that directory.
+
+The second task turn the PlantUML script into a `*.png` file. The second task depends on the first task and both of them are located under the same group.
+
+You can run the tasks by invoking `zrb uml make-script` or `zrb uml make-image` respectively.
+
+When you run zrb, it automatically searches for a file named `zrb_init.py` starting from your current directory and moving upward through its parent directories. This design lets you set up common automation tasks in a central location—like placing a `zrb_init.py` in your home directory (`/home/<your-user>/zrb_init.py`)—so that your tasks are available across all your projects.
+
+Now, go to your project and create a state diagram:
+
+```bash
+git clone git@github.com:jjinux/gotetris.git
+cd gotetris
+zrb uml make-image --diagram "state diagram"
+```
+
+You can also invoke the task without specifying parameter.
+
+```bash
+zrb uml make-image
+```
+
+Once you do so, Zrb will ask you to provide the diagram type.
+
+```
+diagram [state diagram]:
+```
+
+You can just press enter if you want to use the default value (i.e., in this case `state diagram`).
+
+Finally, you can also serve the tasks via a Web UI interface by invoking the following command:
+
+```bash
+zrb server start
+```
+
+You will have a nice web interface running on `http://localhost:12123`
+
+![Zrb Web UI](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb-web-ui.png)
+
+Now, let's see how things work in detail. First, Zrb generates a `state diagram.uml` in your current directory, it then transform the UML script into a PNG image `state diagram.png`.
+
+![State Diagram](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/state-diagram.png)
+
+
+# 🎥 Demo & Documentation
+
+- **Step by step guide:** [Getting started with Zrb](https://github.com/state-alchemists/zrb/blob/main/docs/recipes/getting-started/README.md).
+- **Full documentation:** [Zrb Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md)
+- **Video demo:** [![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
+
+
+# 🤝 Join the Community
+
+- **Bug Reports & Feature Requests:** Create an [issue](https://github.com/state-alchemists/zrb/issues) on Zrb's GitHub Repositories and include:
+    - Your Zrb version (i.e., `zrb version`).
+    - Steps you’ve taken and what you expected versus what happened
+- **Contributions:** We welcome pull requests! Check out our [contribution guidelines](https://github.com/state-alchemists/zrb/pulls).
+
+
+# ☕ Support The Project
+
+If you find Zrb valuable, please consider donating:
+
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
+
+# 🎉 Fun Fact
+
+Did you know?
+
+Zrb is named after `Zaruba`, a powerful support tool from the Garo universe!
+
+> 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.3.1 → zrb-1.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "1.3.1"
+version = "1.4.1"
 description = "Your Automation Powerhouse"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"
@@ -50,7 +50,7 @@ beautifulsoup4 = "^4.12.3"
 fastapi = {extras = ["standard"], version = "^0.115.6"}
 python-jose = {extras = ["cryptography"], version = "^3.4.0"}
 ulid-py = "^1.1.0"
-pydantic-ai = "^0.0.31"
+pydantic-ai = "^0.0.42"
 fastembed = "^0.5.1"
 psutil = "^6.1.1"
 

{zrb-1.3.1 → zrb-1.4.1}/src/zrb/__init__.py

@@ -33,6 +33,7 @@ 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.llm_config import llm_config
 from zrb.runner.cli import cli
 from zrb.runner.web_config.config_factory import web_config
 from zrb.runner.web_schema.user import User
@@ -101,6 +102,7 @@ assert ContentTransformer
 assert Scaffolder
 assert Scheduler
 assert cli
+assert llm_config
 assert Xcom
 assert web_config
 assert User

zrb-1.4.1/src/zrb/__main__.py

@@ -0,0 +1,50 @@
+import os
+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:
+        # load init modules
+        for init_module in INIT_MODULES:
+            load_module(init_module)
+        zrb_init_path_list = _get_zrb_init_path_list()
+        # load init scripts
+        for init_script in INIT_SCRIPTS:
+            abs_init_script = os.path.abspath(init_script)
+            if abs_init_script not in zrb_init_path_list:
+                load_file(abs_init_script, -1)
+        # load zrb init
+        for zrb_init_path in zrb_init_path_list:
+            load_file(zrb_init_path)
+        # run the CLI
+        cli.run(sys.argv[1:])
+    except KeyboardInterrupt:
+        print(stylize_warning("\nStopped"), file=sys.stderr)
+        sys.exit(1)
+    except RuntimeError as e:
+        if f"{e}".lower() != "event loop is closed":
+            raise e
+        sys.exit(1)
+    except NodeNotFoundError as e:
+        print(stylize_error(f"{e}"), file=sys.stderr)
+        sys.exit(1)
+
+
+def _get_zrb_init_path_list() -> list[str]:
+    current_path = os.path.abspath(os.getcwd())
+    dir_path_list = [current_path]
+    while current_path != os.path.dirname(current_path):  # Stop at root
+        current_path = os.path.dirname(current_path)
+        dir_path_list.append(current_path)
+    zrb_init_path_list = []
+    for current_path in dir_path_list[::-1]:
+        zrb_init_path = os.path.join(current_path, "zrb_init.py")
+        if os.path.isfile(zrb_init_path):
+            zrb_init_path_list.append(zrb_init_path)
+    return zrb_init_path_list

{zrb-1.3.1 → zrb-1.4.1}/src/zrb/builtin/llm/llm_chat.py

@@ -2,14 +2,12 @@ import json
 import os
 from typing import Any
 
-from pydantic_ai.models import Model
-
 from zrb.builtin.group import llm_group
 from zrb.builtin.llm.tool.api import get_current_location, get_current_weather
 from zrb.builtin.llm.tool.cli import run_shell_command
 from zrb.builtin.llm.tool.file import (
-    list_file,
-    read_source_code,
+    list_files,
+    read_all_files,
     read_text_file,
     write_text_file,
 )
@@ -24,18 +22,14 @@ from zrb.config import (
     LLM_ALLOW_ACCESS_LOCAL_FILE,
     LLM_ALLOW_ACCESS_SHELL,
     LLM_HISTORY_DIR,
-    LLM_MODEL,
     LLM_SYSTEM_PROMPT,
     SERP_API_KEY,
 )
-from zrb.context.any_context import AnyContext
 from zrb.context.any_shared_context import AnySharedContext
-from zrb.input.any_input import AnyInput
 from zrb.input.bool_input import BoolInput
 from zrb.input.str_input import StrInput
 from zrb.input.text_input import TextInput
 from zrb.task.llm_task import LLMTask
-from zrb.util.attr import get_attr
 from zrb.util.file import read_file, write_file
 from zrb.util.string.conversion import to_pascal_case
 
@@ -90,46 +84,37 @@ def _write_chat_conversation(
     write_file(last_session_file_path, current_session_name)
 
 
-class _LLMChat(LLMTask):
-
-    _default_model: Model | str | None = None
-
-    def set_default_model(self, model: Model | str):
-        self._default_model = model
-
-    @property
-    def inputs(self) -> list[AnyInput]:
-        task_inputs = super().inputs
-        model_input_default = LLM_MODEL if self._default_model is None else "default"
-        return [
+llm_chat: LLMTask = llm_group.add_task(
+    LLMTask(
+        name="llm-chat",
+        input=[
             StrInput(
                 "model",
                 description="LLM Model",
                 prompt="LLM Model",
-                default=model_input_default,
+                default="",
                 allow_positional_parsing=False,
                 always_prompt=False,
+                allow_empty=True,
+            ),
+            StrInput(
+                "base-url",
+                description="LLM API Base URL",
+                prompt="LLM API Base URL",
+                default="",
+                allow_positional_parsing=False,
+                always_prompt=False,
+                allow_empty=True,
+            ),
+            StrInput(
+                "api-key",
+                description="LLM API Key",
+                prompt="LLM API Key",
+                default="",
+                allow_positional_parsing=False,
+                always_prompt=False,
+                allow_empty=True,
             ),
-            *task_inputs,
-        ]
-
-    def _get_model(self, ctx: AnyContext) -> str | Model | None:
-        if ctx.input.model == "default":
-            if self._default_model is not None:
-                return self._default_model
-            return super()._get_model(ctx)
-        model = get_attr(
-            ctx, ctx.input.model, "ollama_chat/llama3.1", auto_render=self._render_model
-        )
-        if isinstance(model, (Model, str)) or model is None:
-            return model
-        raise ValueError("Invalid model")
-
-
-llm_chat: LLMTask = llm_group.add_task(
-    _LLMChat(
-        name="llm-chat",
-        input=[
             TextInput(
                 "system-prompt",
                 description="System prompt",
@@ -156,10 +141,17 @@ llm_chat: LLMTask = llm_group.add_task(
                 always_prompt=False,
             ),
         ],
+        model=lambda ctx: None if ctx.input.model == "" else ctx.input.model,
+        model_base_url=lambda ctx: (
+            None if ctx.input.base_url == "" else ctx.input.base_url
+        ),
+        model_api_key=lambda ctx: (
+            None if ctx.input.api_key == "" else ctx.input.api_key
+        ),
         conversation_history_reader=_read_chat_conversation,
         conversation_history_writer=_write_chat_conversation,
         description="Chat with LLM",
-        system_prompt="{ctx.input['system-prompt']}",
+        system_prompt="{ctx.input.system_prompt}",
         message="{ctx.input.message}",
         retries=0,
     ),
@@ -168,8 +160,8 @@ llm_chat: LLMTask = llm_group.add_task(
 
 
 if LLM_ALLOW_ACCESS_LOCAL_FILE:
-    llm_chat.add_tool(read_source_code)
-    llm_chat.add_tool(list_file)
+    llm_chat.add_tool(read_all_files)
+    llm_chat.add_tool(list_files)
     llm_chat.add_tool(read_text_file)
     llm_chat.add_tool(write_text_file)