zrb 1.4.2__tar.gz → 1.5.0__tar.gz

{zrb-1.4.2 → zrb-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 1.4.2
+Version: 1.5.0
 Summary: Your Automation Powerhouse
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -13,16 +13,20 @@ 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: all
+Provides-Extra: playwright
 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: chromadb (>=0.5.20,<0.6.0) ; extra == "rag" or extra == "all"
 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: openai (>=1.10.0,<2.0.0) ; extra == "rag" or extra == "all"
+Requires-Dist: pdfplumber (>=0.11.4,<0.12.0) ; extra == "rag" or extra == "all"
+Requires-Dist: playwright (>=1.43.0,<2.0.0) ; extra == "playwright" or extra == "all"
 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)
@@ -79,40 +83,47 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/mai
 
 ```
 
-# 🍲 Quick Start
+# 🍲 Quick Start: Build Your First Automation Workflow
 
-Create a file at `/home/<your-user-name>/zrb_init.py` with the following content:
+Zrb empowers you to create custom automation tasks using Python. This guide shows you how to define two simple tasks: one to generate a PlantUML script from your source code and another to convert that script into a PNG image.
 
+## 1. Create Your Task Definition File
+
+Place a file named `zrb_init.py` in a directory that's accessible from your projects. Zrb will automatically search for this file by starting in your current directory and then moving upward (i.e., checking parent directories) until it finds one. This means if you place your `zrb_init.py` in your home directory (e.g., `/home/<your-user-name>/zrb_init.py`), the tasks defined there will be available for any project.
+
+Add the following content to your zrb_init.py:
 
 ```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
+from zrb import cli, LLMTask, CmdTask, StrInput, Group
+from zrb.builtin.llm.tool.file import (
+    list_files, read_from_file, search_files, write_to_file
+)
+
 
 CURRENT_DIR = os.getcwd()
 
-# Make UML group
+# Create a group for UML-related tasks
 uml_group = cli.add_group(Group(name="uml", description="UML related tasks"))
 
-# Generate UML script
+# Task 1: Generate a PlantUML script from your source code
 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}, "
+            f"Read all necessary files 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,
+            list_files, read_from_file, search_files, write_to_file
         ],
     )
 )
 
-# Defining a Cmd Task to transform Plantuml script into a png image.
+# Task 2: Convert the PlantUML script into a PNG image
 make_uml_image = uml_group.add_task(
     CmdTask(
         name="make-image",
@@ -123,63 +134,75 @@ make_uml_image = uml_group.add_task(
     )
 )
 
-# Making sure that make_png has make_uml as its dependency.
+# Set up the dependency: the image task runs after the script is created
 make_uml_script >> make_uml_image
 ```
 
-You have just define two automation tasks.
+**What This Does**
 
-The first one use LLM to read files in your current directory and create a `PlantUML script` on that directory.
+- **Task 1 – make-script**:
 
-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.
+    Uses an LLM to read all files in your current directory and generate a PlantUML script (e.g., `state diagram.uml`).
 
-You can run the tasks by invoking `zrb uml make-script` or `zrb uml make-image` respectively.
+- **Task 2 – make-image**:
 
-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.
+    Executes a command that converts the PlantUML script into a PNG image (e.g., `state diagram.png`). This task will run only after the script has been generated.
 
-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"
-```
+## 2. Run Your Tasks
 
-You can also invoke the task without specifying parameter.
+After setting up your tasks, you can execute them from any project. For example:
 
-```bash
-zrb uml make-image
-```
+- Clone/Create a Project:
 
-Once you do so, Zrb will ask you to provide the diagram type.
+    ```bash
+    git clone git@github.com:jjinux/gotetris.git
+    cd gotetris
+    ```
 
-```
-diagram [state diagram]:
-```
+- Create a state diagram:
+
+    ```bash
+    zrb uml make-image --diagram "state diagram"
+    ```
+
+- Or use the interactive mode:
 
-You can just press enter if you want to use the default value (i.e., in this case `state diagram`).
+    ```bash
+    zrb uml make-image
+    ```
 
-Finally, you can also serve the tasks via a Web UI interface by invoking the following command:
+    Zrb will prompt:
+
+    ```bash
+    diagram [state diagram]:
+    ```
+
+    Press **Enter** to use the default value
+
+![State Diagram](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/state-diagram.png)
+
+
+## 3. Try Out the Web UI
+
+You can also serve your tasks through a user-friendly web interface:
 
 ```bash
 zrb server start
 ```
 
-You will have a nice web interface running on `http://localhost:12123`
+Then open your browser and visit `http://localhost:21213`
 
 ![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)
+
+    [![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
 
 
 # 🤝 Join the Community

{zrb-1.4.2 → zrb-1.5.0}/README.md

@@ -44,40 +44,47 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/mai
 
 ```
 
-# 🍲 Quick Start
+# 🍲 Quick Start: Build Your First Automation Workflow
 
-Create a file at `/home/<your-user-name>/zrb_init.py` with the following content:
+Zrb empowers you to create custom automation tasks using Python. This guide shows you how to define two simple tasks: one to generate a PlantUML script from your source code and another to convert that script into a PNG image.
 
+## 1. Create Your Task Definition File
+
+Place a file named `zrb_init.py` in a directory that's accessible from your projects. Zrb will automatically search for this file by starting in your current directory and then moving upward (i.e., checking parent directories) until it finds one. This means if you place your `zrb_init.py` in your home directory (e.g., `/home/<your-user-name>/zrb_init.py`), the tasks defined there will be available for any project.
+
+Add the following content to your zrb_init.py:
 
 ```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
+from zrb import cli, LLMTask, CmdTask, StrInput, Group
+from zrb.builtin.llm.tool.file import (
+    list_files, read_from_file, search_files, write_to_file
+)
+
 
 CURRENT_DIR = os.getcwd()
 
-# Make UML group
+# Create a group for UML-related tasks
 uml_group = cli.add_group(Group(name="uml", description="UML related tasks"))
 
-# Generate UML script
+# Task 1: Generate a PlantUML script from your source code
 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}, "
+            f"Read all necessary files 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,
+            list_files, read_from_file, search_files, write_to_file
         ],
     )
 )
 
-# Defining a Cmd Task to transform Plantuml script into a png image.
+# Task 2: Convert the PlantUML script into a PNG image
 make_uml_image = uml_group.add_task(
     CmdTask(
         name="make-image",
@@ -88,63 +95,75 @@ make_uml_image = uml_group.add_task(
     )
 )
 
-# Making sure that make_png has make_uml as its dependency.
+# Set up the dependency: the image task runs after the script is created
 make_uml_script >> make_uml_image
 ```
 
-You have just define two automation tasks.
+**What This Does**
 
-The first one use LLM to read files in your current directory and create a `PlantUML script` on that directory.
+- **Task 1 – make-script**:
 
-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.
+    Uses an LLM to read all files in your current directory and generate a PlantUML script (e.g., `state diagram.uml`).
 
-You can run the tasks by invoking `zrb uml make-script` or `zrb uml make-image` respectively.
+- **Task 2 – make-image**:
 
-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.
+    Executes a command that converts the PlantUML script into a PNG image (e.g., `state diagram.png`). This task will run only after the script has been generated.
 
-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"
-```
+## 2. Run Your Tasks
 
-You can also invoke the task without specifying parameter.
+After setting up your tasks, you can execute them from any project. For example:
 
-```bash
-zrb uml make-image
-```
+- Clone/Create a Project:
 
-Once you do so, Zrb will ask you to provide the diagram type.
+    ```bash
+    git clone git@github.com:jjinux/gotetris.git
+    cd gotetris
+    ```
 
-```
-diagram [state diagram]:
-```
+- Create a state diagram:
+
+    ```bash
+    zrb uml make-image --diagram "state diagram"
+    ```
+
+- Or use the interactive mode:
 
-You can just press enter if you want to use the default value (i.e., in this case `state diagram`).
+    ```bash
+    zrb uml make-image
+    ```
 
-Finally, you can also serve the tasks via a Web UI interface by invoking the following command:
+    Zrb will prompt:
+
+    ```bash
+    diagram [state diagram]:
+    ```
+
+    Press **Enter** to use the default value
+
+![State Diagram](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/state-diagram.png)
+
+
+## 3. Try Out the Web UI
+
+You can also serve your tasks through a user-friendly web interface:
 
 ```bash
 zrb server start
 ```
 
-You will have a nice web interface running on `http://localhost:12123`
+Then open your browser and visit `http://localhost:21213`
 
 ![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)
+
+    [![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
 
 
 # 🤝 Join the Community

{zrb-1.4.2 → zrb-1.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "1.4.2"
+version = "1.5.0"
 description = "Your Automation Powerhouse"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"
@@ -52,11 +52,15 @@ python-jose = {extras = ["cryptography"], version = "^3.4.0"}
 ulid-py = "^1.1.0"
 pydantic-ai = "^0.0.42"
 fastembed = "^0.5.1"
+openai = {version = "^1.10.0", optional = true}
+playwright = {version = "^1.43.0", optional = true}
 psutil = "^6.1.1"
 
 [tool.poetry.extras]
 # poetry install -E rag
-rag = ["chromadb", "pdfplumber"]
+rag = ["chromadb", "pdfplumber", "openai"]
+playwright = ["playwright"]
+all = ["chromadb", "pdfplumber", "openai", "playwright"]
 
 [tool.poetry.group.dev.dependencies]
 alembic = "^1.14.0" # FastApp dependencies

{zrb-1.4.2 → zrb-1.5.0}/src/zrb/builtin/llm/llm_chat.py

@@ -6,10 +6,11 @@ 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 (
+    apply_diff,
     list_files,
-    read_all_files,
-    read_text_file,
-    write_text_file,
+    read_from_file,
+    search_files,
+    write_to_file,
 )
 from zrb.builtin.llm.tool.web import (
     create_search_internet_tool,
@@ -161,10 +162,11 @@ llm_chat: LLMTask = llm_group.add_task(
 
 
 if LLM_ALLOW_ACCESS_LOCAL_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)
+    llm_chat.add_tool(read_from_file)
+    llm_chat.add_tool(write_to_file)
+    llm_chat.add_tool(search_files)
+    llm_chat.add_tool(apply_diff)
 
 if LLM_ALLOW_ACCESS_SHELL:
     llm_chat.add_tool(run_shell_command)

{zrb-1.4.2 → zrb-1.5.0}/src/zrb/builtin/llm/tool/api.py

@@ -5,7 +5,7 @@ from typing import Annotated, Literal
 def get_current_location() -> (
     Annotated[str, "JSON string representing latitude and longitude"]
 ):  # noqa
-    """Get the user's current location."""
+    """Get the user's current location. This function take no argument."""
     import requests
 
     return json.dumps(requests.get("http://ip-api.com/json?fields=lat,lon").json())