zrb 1.4.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

zrb/__main__.py

@@ -1,3 +1,4 @@
+import os
 import sys
 
 from zrb.config import INIT_MODULES, INIT_SCRIPTS
@@ -9,10 +10,19 @@ 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:
-            load_file(init_script, -1)
+            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)
@@ -24,3 +34,17 @@ def serve_cli():
     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/builtin/llm/tool/file.py

@@ -3,25 +3,92 @@ import os
 
 from zrb.util.file import read_file, write_file
 
+_INCLUDED_PATTERNS: list[str] = [
+    "*.py",  # Python
+    "*.go",  # Go
+    "*.rs",  # Rust
+    "*.js",  # JavaScript
+    "*.ts",  # TypeScript
+    "*.java",  # Java
+    "*.c",  # C
+    "*.cpp",  # C++
+    "*.cc",  # Alternative C++ extension
+    "*.cxx",  # Alternative C++ extension
+    "*.rb",  # Ruby
+    "*.swift",  # Swift
+    "*.kt",  # Kotlin
+    "*.php",  # PHP
+    "*.pl",  # Perl / Prolog
+    "*.pm",  # Perl module
+    "*.sh",  # Shell
+    "*.bat",  # Batch
+    "*.ps1",  # PowerShell
+    "*.R",  # R (capital)
+    "*.r",  # R (lowercase)
+    "*.scala",  # Scala
+    "*.hs",  # Haskell
+    "*.cs",  # C#
+    "*.fs",  # F#
+    "*.ex",  # Elixir
+    "*.exs",  # Elixir script
+    "*.erl",  # Erlang
+    "*.hrl",  # Erlang header
+    "*.dart",  # Dart
+    "*.m",  # Objective-C / Matlab (note: conflicts may arise)
+    "*.mm",  # Objective-C++
+    "*.lua",  # Lua
+    "*.jl",  # Julia
+    "*.groovy",  # Groovy
+    "*.clj",  # Clojure
+    "*.cljs",  # ClojureScript
+    "*.cljc",  # Clojure common
+    "*.vb",  # Visual Basic
+    "*.f90",  # Fortran
+    "*.f95",  # Fortran
+    "*.adb",  # Ada
+    "*.ads",  # Ada specification
+    "*.pas",  # Pascal
+    "*.pp",  # Pascal
+    "*.ml",  # OCaml
+    "*.mli",  # OCaml interface
+    "*.nim",  # Nim
+    "*.rkt",  # Racket
+    "*.d",  # D
+    "*.lisp",  # Common Lisp
+    "*.lsp",  # Lisp variant
+    "*.cl",  # Common Lisp
+    "*.scm",  # Scheme
+    "*.st",  # Smalltalk
+    "*.vhd",  # VHDL
+    "*.vhdl",  # VHDL
+    "*.v",  # Verilog
+    "*.asm",  # Assembly
+    "*.s",  # Assembly (alternative)
+    "*.sql",  # SQL (if desired)
+]
+
+# Extended list of directories and patterns to exclude.
+_EXCLUDED_PATTERNS: list[str] = [
+    "venv",  # Python virtual environments
+    ".venv",
+    "node_modules",  # Node.js dependencies
+    ".git",  # Git repositories
+    "__pycache__",  # Python cache directories
+    "build",  # Build directories
+    "dist",  # Distribution directories
+    "target",  # Build output directories (Java, Rust, etc.)
+    "bin",  # Binary directories
+    "obj",  # Object files directories
+    ".idea",  # JetBrains IDEs
+    ".vscode",  # VS Code settings
+    ".eggs",  # Python eggs
+]
+
 
 def list_files(
     directory: str = ".",
-    included_patterns: list[str] = [
-        "*.py",
-        "*.go",
-        "*.js",
-        "*.ts",
-        "*.java",
-        "*.c",
-        "*.cpp",
-    ],
-    excluded_patterns: list[str] = [
-        "venv",
-        ".venv",
-        "node_modules",
-        ".git",
-        "__pycache__",
-    ],
+    included_patterns: list[str] = _INCLUDED_PATTERNS,
+    excluded_patterns: list[str] = _EXCLUDED_PATTERNS,
 ) -> list[str]:
     """List all files in a directory that match any of the included glob patterns
     and do not reside in any directory matching an excluded pattern.
@@ -32,16 +99,33 @@ def list_files(
         for filename in files:
             if any(fnmatch.fnmatch(filename, pat) for pat in included_patterns):
                 full_path = os.path.join(root, filename)
-                # Check each component of the full path for excluded patterns.
-                if any(
-                    any(fnmatch.fnmatch(part, pat) for pat in excluded_patterns)
-                    for part in os.path.normpath(full_path).split(os.sep)
-                ):
+                if _should_exclude(full_path, excluded_patterns):
                     continue
                 all_files.append(full_path)
     return all_files
 
 
+def _should_exclude(full_path: str, excluded_patterns: list[str]) -> bool:
+    """
+    Return True if the file at full_path should be excluded based on
+    the list of excluded_patterns. Patterns that include a path separator
+    are applied to the full normalized path; otherwise they are matched
+    against each individual component of the path.
+    """
+    norm_path = os.path.normpath(full_path)
+    path_parts = norm_path.split(os.sep)
+    for pat in excluded_patterns:
+        # If the pattern seems intended for full path matching (contains a separator)
+        if os.sep in pat or "/" in pat:
+            if fnmatch.fnmatch(norm_path, pat):
+                return True
+        else:
+            # Otherwise check each part of the path
+            if any(fnmatch.fnmatch(part, pat) for part in path_parts):
+                return True
+    return False
+
+
 def read_text_file(file: str) -> str:
     """Read a text file"""
     return read_file(os.path.abspath(file))
@@ -54,16 +138,8 @@ def write_text_file(file: str, content: str):
 
 def read_all_files(
     directory: str = ".",
-    included_patterns: list[str] = [
-        "*.py",
-        "*.go",
-        "*.js",
-        "*.ts",
-        "*.java",
-        "*.c",
-        "*.cpp",
-    ],
-    excluded_patterns: list[str] = [],
+    included_patterns: list[str] = _INCLUDED_PATTERNS,
+    excluded_patterns: list[str] = _EXCLUDED_PATTERNS,
 ) -> list[str]:
     """Read all files in a directory that match any of the included glob patterns
     and do not match any of the excluded glob patterns.

zrb/runner/cli.py

@@ -18,13 +18,11 @@ from zrb.util.cli.style import (
     stylize_section_header,
 )
 from zrb.util.group import extract_node_from_args, get_non_empty_subgroups, get_subtasks
-from zrb.util.load import load_zrb_init
 from zrb.util.string.conversion import double_quote
 
 
 class Cli(Group):
     def run(self, args: list[str] = []):
-        load_zrb_init()
         kwargs, args = self._extract_kwargs_from_args(args)
         node, node_path, args = extract_node_from_args(self, args)
         if isinstance(node, Group):

zrb/util/load.py

@@ -9,22 +9,6 @@ from typing import Any
 pattern = re.compile("[^a-zA-Z0-9]")
 
 
-def load_zrb_init(dir_path: str | None = None) -> Any | None:
-    if dir_path is None:
-        dir_path = os.getcwd()
-    # get path list from current path to the absolute root
-    current_path = os.path.abspath(dir_path)
-    path_list = [current_path]
-    while current_path != os.path.dirname(current_path):  # Stop at root
-        current_path = os.path.dirname(current_path)
-        path_list.append(current_path)
-    # loop from root to current path to load zrb_init
-    for current_path in path_list[::-1]:
-        script_path = os.path.join(current_path, "zrb_init.py")
-        if os.path.isfile(script_path):
-            load_file(script_path)
-
-
 @lru_cache
 def load_file(script_path: str, sys_path_index: int = 0) -> Any | None:
     if not os.path.isfile(script_path):

{zrb-1.4.0.dist-info → zrb-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 1.4.0
+Version: 1.4.1
 Summary: Your Automation Powerhouse
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -39,29 +39,63 @@ Description-Content-Type: text/markdown
 
 # 🤖 Zrb: Your Automation Powerhouse
 
-Zrb allows you to write your automation tasks in Python. For example, you can define the following script in your home directory (`/home/<your-user-name>/zrb_init.py`).
+
+**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
-from pydantic_ai.models.openai import OpenAIModel
-from pydantic_ai.providers.openai import OpenAIProvider
 
 CURRENT_DIR = os.getcwd()
 
-# Setup default LLM Config
-llm_config.set_default_model(
-    OpenAIModel(
-        model_name="gpt-4o",
-        provider=OpenAIProvider(
-            base_url="https://openrouter.ai/api/v1",
-            api_key=os.getenv("OPENROUTER_API_KEY", "")
-        )
-    )
-)
-
 # Make UML group
 uml_group = cli.add_group(Group(name="uml", description="UML related tasks"))
 
@@ -98,27 +132,39 @@ make_uml_image = uml_group.add_task(
 make_uml_script >> make_uml_image
 ```
 
-Once defined, your automation tasks are immediately accessible from the CLI. You can then invoke the tasks by invoking.
+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"
 ```
 
-Or you can invoke the tasks without parameter.
+You can also invoke the task without specifying parameter.
 
 ```bash
 zrb uml make-image
 ```
 
-At this point, Zrb will politely ask you to provide the diagram type.
+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.
+You can just press enter if you want to use the default value (i.e., in this case `state diagram`).
 
-Finally, you can run Zrb as a server and make your tasks available for non technical users by invoking the following command.
+Finally, you can also serve the tasks via a Web UI interface by invoking the following command:
 
 ```bash
 zrb server start
@@ -128,49 +174,38 @@ 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 Zrb generate the state diagram. Based on the source code in your current directory, Zrb will generate a `state diagram.uml` and transform it into `state diagram.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)
 
-See the [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/recipes/getting-started/README.md) for more information. Or just watch the demo:
-
-[![Video Title](https://img.youtube.com/vi/W7dgk96l__o/0.jpg)](https://www.youtube.com/watch?v=W7dgk96l__o)
-
 
-# 🫰 Installing Zrb
+# 🎥 Demo & Documentation
 
-You can install Zrb as a pip package by invoking the following command:
+- **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)
 
-```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/main/install.sh)"
-```
+# 🤝 Join the Community
 
-# 🐞 Bug Report + Feature Request
+- **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).
 
-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
+# ☕ Support The Project
 
-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:
+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.0.dist-info → zrb-1.4.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 zrb/__init__.py,sha256=1waPjZcA3IHUEvIuVQso0YfNfW9i7SCJgEfzhiNTaCk,3020
-zrb/__main__.py,sha256=QcMnHfAFbDUFw9p9tgfFS4U0Ra9nE-TLU5YoMBiAriE,808
+zrb/__main__.py,sha256=MvAGzoM3ElJZOPMKNqaTdnrT9PXi9Saq8CPa11RiLQk,1748
 zrb/attr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/attr/type.py,sha256=4TV5gPYMMrKh5V-yB6iRYKCbsXAH_AvGXMsjxKLHcUs,568
 zrb/builtin/__init__.py,sha256=oXG4Zm_rIp3G81Y7hiSe38jeS2sGZAnADoP_yxxhYEc,1926
@@ -11,7 +11,7 @@ zrb/builtin/llm/llm_chat.py,sha256=QCfxocM7UQPtpIWLMzr9wKbl9DCPcDZszAnPxszaww0,6
 zrb/builtin/llm/previous-session.js,sha256=xMKZvJoAbrwiyHS0OoPrWuaKxWYLoyR5sguePIoCjTY,816
 zrb/builtin/llm/tool/api.py,sha256=bXFE7jihdhUscxJH8lu5imwlYH735AalbCyUTl28BaQ,826
 zrb/builtin/llm/tool/cli.py,sha256=to_IjkfrMGs6eLfG0cpVN9oyADWYsJQCtyluUhUdBww,253
-zrb/builtin/llm/tool/file.py,sha256=CVmAwzHrO6gk6OcnHedKiZDQhmi-0f6Tx0vJWQe1KOQ,2191
+zrb/builtin/llm/tool/file.py,sha256=8H_qXt4imsy28DD21wBIo4ud5zfnkFjLLm8Simo84Q8,4732
 zrb/builtin/llm/tool/rag.py,sha256=vEIThEy0JGwXEiNRLOEJAHAE0l1Qie2qvU3ryioeYMk,6066
 zrb/builtin/llm/tool/web.py,sha256=SDnCtYHZ0Q4DtLbIhc11a0UyyKbTTeW60UfeIKzK35k,3204
 zrb/builtin/md5.py,sha256=0pNlrfZA0wlZlHvFHLgyqN0JZJWGKQIF5oXxO44_OJk,949
@@ -239,7 +239,7 @@ zrb/input/str_input.py,sha256=NevZHX9rf1g8eMatPyy-kUX3DglrVAQpzvVpKAzf7bA,81
 zrb/input/text_input.py,sha256=shvVbc2U8Is36h23M5lcW8IEwKc9FR-4uEPZZroj3rU,3377
 zrb/llm_config.py,sha256=SXSkDpmXxGLJaoUrT09oNdOGwHXc82TwIGssVeo6S7U,1553
 zrb/runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/runner/cli.py,sha256=HtfJQecFg2keIMK-7bVATBlTeZC_RvT8DsbUC58TMKU,6736
+zrb/runner/cli.py,sha256=0mT0oO_yEhc8N4nYCJNujhgLjVykZ0B-kAOFXyAvAqM,6672
 zrb/runner/common_util.py,sha256=0zhZn1Jdmr194_nsL5_L-Kn9-_NDpMTI2z6_LXUQJ-U,1369
 zrb/runner/web_app.py,sha256=Ji2AWeFpJu5guXmur7mAAbjMToyjgmPDdfYu8047FFI,2616
 zrb/runner/web_config/config.py,sha256=0wR58KreAmawGGfamm0GLZY344HaXs7qfDgHLavBDwo,3125
@@ -332,7 +332,7 @@ zrb/util/file.py,sha256=mgNobIKCr0eIQUlg6W2Yg1fvg943VyuOUF8WMFpJA5A,859
 zrb/util/git.py,sha256=TShnMxPAk20Tglp25d_XPVZX-q0mvKeqdprVMeXQ5f0,4787
 zrb/util/git_subtree.py,sha256=zyWl0aUEZJyUJKjfw1uglozB4R1kF9pWtfKjhu8DN44,2658
 zrb/util/group.py,sha256=Bg7HrSycoK110U5s_Tca6-uUQuZ5CMgb8wxZSrvDQ98,2790
-zrb/util/load.py,sha256=m0e5DVLV7_RON6AZdjkquPym6BBrvYBbDMrllV44Y_k,1993
+zrb/util/load.py,sha256=Aeyh1EWtp-oJGVAhcjZn-VSB9innoOe8ZkUawha_ddk,1339
 zrb/util/run.py,sha256=DGHUP9x1Q8V8UF3FbpmjLGuhVVCCLfjTH2teT8qXlNI,207
 zrb/util/string/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/util/string/conversion.py,sha256=636sfF1a3_bpzXNw5bdSzbJzwakyAoo70KT3_ItgZEo,4333
@@ -341,7 +341,7 @@ zrb/util/string/name.py,sha256=8picJfUBXNpdh64GNaHv3om23QHhUZux7DguFLrXHp8,1163
 zrb/util/todo.py,sha256=1nDdwPc22oFoK_1ZTXyf3638Bg6sqE2yp_U4_-frHoc,16015
 zrb/xcom/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/xcom/xcom.py,sha256=o79rxR9wphnShrcIushA0Qt71d_p3ZTxjNf7x9hJB78,1571
-zrb-1.4.0.dist-info/METADATA,sha256=9IBDp38-en6FVpqq2RUd4qMo7c138HImysJXzd6-kwg,6291
-zrb-1.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-zrb-1.4.0.dist-info/entry_points.txt,sha256=-Pg3ElWPfnaSM-XvXqCxEAa-wfVI6BEgcs386s8C8v8,46
-zrb-1.4.0.dist-info/RECORD,,
+zrb-1.4.1.dist-info/METADATA,sha256=qKftyv7rxRUk1eiIo5hUOZJY80melIT4RpgAPXVa1Ew,8135
+zrb-1.4.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+zrb-1.4.1.dist-info/entry_points.txt,sha256=-Pg3ElWPfnaSM-XvXqCxEAa-wfVI6BEgcs386s8C8v8,46
+zrb-1.4.1.dist-info/RECORD,,