zrb 1.9.4__py3-none-any.whl → 1.9.6__py3-none-any.whl

zrb/__init__.py

@@ -14,7 +14,7 @@ _LAZY_LOAD = {
     "CmdResult": "zrb.cmd.cmd_result",
     "Cmd": "zrb.cmd.cmd_val",
     "CmdPath": "zrb.cmd.cmd_val",
-    "CFG": "zrb.config",
+    "CFG": "zrb.config.config",
     "AnyContentTransformer": "zrb.content_transformer.any_content_transformer",
     "ContentTransformer": "zrb.content_transformer.content_transformer",
     "AnyContext": "zrb.context.any_context",
@@ -36,10 +36,10 @@ _LAZY_LOAD = {
     "PasswordInput": "zrb.input.password_input",
     "StrInput": "zrb.input.str_input",
     "TextInput": "zrb.input.text_input",
-    "llm_config": "zrb.llm_config",
-    "llm_rate_limitter": "zrb.llm_rate_limitter",
+    "llm_config": "zrb.config.llm_config",
+    "llm_rate_limitter": "zrb.config.llm_rate_limitter",
     "cli": "zrb.runner.cli",
-    "web_auth_config": "zrb.runner.web_auth_config",
+    "web_auth_config": "zrb.config.web_auth_config",
     "User": "zrb.runner.web_schema.user",
     "Session": "zrb.session.session",
     "AnyTask": "zrb.task.any_task",
@@ -74,7 +74,10 @@ if TYPE_CHECKING:
     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 CFG
+    from zrb.config.config import CFG
+    from zrb.config.llm_config import llm_config
+    from zrb.config.llm_rate_limitter import llm_rate_limitter
+    from zrb.config.web_auth_config import web_auth_config
     from zrb.content_transformer.any_content_transformer import AnyContentTransformer
     from zrb.content_transformer.content_transformer import ContentTransformer
     from zrb.context.any_context import AnyContext
@@ -96,10 +99,7 @@ if TYPE_CHECKING:
     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.llm_rate_limitter import llm_rate_limitter
     from zrb.runner.cli import cli
-    from zrb.runner.web_auth_config import web_auth_config
     from zrb.runner.web_schema.user import User
     from zrb.session.session import Session
     from zrb.task.any_task import AnyTask

zrb/__main__.py

@@ -2,7 +2,7 @@ import logging
 import os
 import sys
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.runner.cli import cli
 from zrb.util.cli.style import stylize_error, stylize_faint, stylize_warning
 from zrb.util.group import NodeNotFoundError

zrb/builtin/__init__.py

@@ -43,53 +43,3 @@ from zrb.builtin.uuid import (
     validate_uuid_v4,
     validate_uuid_v5,
 )
-
-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 validate_base64
-assert encode_jwt
-assert decode_jwt
-assert validate_jwt
-assert llm_ask
-assert hash_md5
-assert sum_md5
-assert validate_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 list_todo
-assert add_todo
-assert archive_todo
-assert edit_todo
-assert complete_todo
-assert log_todo
-assert show_todo
-assert throw_dice
-assert shuffle_values
-assert setup_ubuntu
-assert setup_latex_on_ubuntu
-assert setup_asdf
-assert setup_tmux
-assert setup_zsh
-assert validate_uuid
-assert validate_uuid_v1
-assert validate_uuid_v3
-assert validate_uuid_v4
-assert validate_uuid_v5
-assert generate_uuid_v1
-assert generate_uuid_v3
-assert generate_uuid_v4
-assert generate_uuid_v5
-assert http_request
-assert generate_curl

zrb/builtin/llm/chat_session.py

@@ -7,8 +7,8 @@ conversation flow via XCom.
 
 import asyncio
 
+from zrb.config.llm_config import llm_config
 from zrb.context.any_context import AnyContext
-from zrb.llm_config import llm_config
 from zrb.util.cli.style import stylize_bold_yellow, stylize_faint
 
 

zrb/builtin/llm/history.py

@@ -2,7 +2,7 @@ import json
 import os
 from typing import Any
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.context.any_shared_context import AnySharedContext
 from zrb.task.llm.history import ConversationHistoryData
 from zrb.util.file import read_file, write_file

zrb/builtin/llm/llm_ask.py

@@ -7,10 +7,10 @@ from zrb.builtin.llm.tool.cli import run_shell_command
 from zrb.builtin.llm.tool.code import analyze_repo
 from zrb.builtin.llm.tool.file import (
     analyze_file,
-    apply_diff,
     list_files,
     read_from_file,
     read_many_files,
+    replace_in_file,
     search_files,
     write_many_files,
     write_to_file,
@@ -22,7 +22,7 @@ from zrb.builtin.llm.tool.web import (
     search_wikipedia,
 )
 from zrb.callback.callback import Callback
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.input.bool_input import BoolInput
 from zrb.input.str_input import StrInput
 from zrb.input.text_input import TextInput
@@ -135,7 +135,7 @@ if CFG.LLM_ALLOW_ACCESS_LOCAL_FILE:
         list_files,
         read_from_file,
         read_many_files,
-        apply_diff,
+        replace_in_file,
         write_to_file,
         write_many_files,
     )

zrb/builtin/llm/tool/api.py

@@ -3,11 +3,16 @@ from typing import Literal
 
 
 def get_current_location() -> str:
-    """Get current location (latitude, longitude) based on IP address.
+    """
+    Fetches the user's current geographical location (latitude and longitude) based on their IP address.
+
+    Use this tool when the user asks "Where am I?", "What is my current location?", or has a query that requires knowing their location to be answered.
+
     Returns:
-        str: JSON string representing latitude and longitude.
+        str: A JSON string containing the 'lat' and 'lon' of the current location.
+             Example: '{"lat": 48.8584, "lon": 2.2945}'
     Raises:
-        requests.RequestException: If the API request fails.
+        requests.RequestException: If the API request to the location service fails.
     """
     import requests
 
@@ -24,15 +29,20 @@ def get_current_weather(
     longitude: float,
     temperature_unit: Literal["celsius", "fahrenheit"],
 ) -> str:
-    """Get current weather for a specific location.
+    """
+    Retrieves the current weather conditions for a given geographical location.
+
+    Use this tool when the user asks about the weather. If the user does not provide a location, first use the `get_current_location` tool to determine their location.
+
     Args:
-        latitude (float): Latitude coordinate.
-        longitude (float): Longitude coordinate.
-        temperature_unit (Literal["celsius", "fahrenheit"]): Temperature unit.
+        latitude (float): The latitude of the location.
+        longitude (float): The longitude of the location.
+        temperature_unit (Literal["celsius", "fahrenheit"]): The desired unit for the temperature reading.
+
     Returns:
-        str: JSON string with weather data.
+        str: A JSON string containing detailed weather data, including temperature, wind speed, and weather code.
     Raises:
-        requests.RequestException: If the API request fails.
+        requests.RequestException: If the API request to the weather service fails.
     """
     import requests
 

zrb/builtin/llm/tool/cli.py

@@ -2,14 +2,20 @@ import subprocess
 
 
 def run_shell_command(command: str) -> str:
-    """Execute a shell command and return its combined stdout and stderr.
+    """
+    Executes a shell command on the user's local machine and returns the output.
+
+    This tool is powerful and should be used for tasks that require interacting with the command line, such as running scripts, managing system processes, or using command-line tools.
+
+    **Security Warning:** This tool executes commands with the same permissions as the user running the assistant. Before executing any command that could modify files or system state (e.g., `git`, `npm`, `pip`, `docker`), you MUST explain what the command does and ask the user for confirmation.
+
     Args:
-        command (str): Shell command to execute on the user's system.
+        command (str): The exact shell command to execute.
+
     Returns:
-        str: The command's output (stdout and stderr combined).
+        str: The combined standard output (stdout) and standard error (stderr) from the command. If the command fails, this will contain the error message.
     Raises:
-        subprocess.CalledProcessError: If the command returns a non-zero exit code.
-        subprocess.SubprocessError: If there's an issue with subprocess execution.
+        subprocess.CalledProcessError: If the command returns a non-zero exit code, indicating an error.
     """
     try:
         output = subprocess.check_output(

zrb/builtin/llm/tool/code.py

@@ -3,8 +3,8 @@ import os
 
 from zrb.builtin.llm.tool.file import DEFAULT_EXCLUDED_PATTERNS, is_excluded
 from zrb.builtin.llm.tool.sub_agent import create_sub_agent_tool
+from zrb.config.llm_rate_limitter import llm_rate_limitter
 from zrb.context.any_context import AnyContext
-from zrb.llm_rate_limitter import llm_rate_limitter
 
 _EXTRACT_INFO_FROM_REPO_SYSTEM_PROMPT = """
 You are an extraction info agent.
@@ -86,29 +86,29 @@ async def analyze_repo(
     summarization_token_limit: int = 40000,
 ) -> str:
     """
-    Extract and summarize information from any directory.
-    You should state the goal specifically so that the tool can return relevant informations.
+    Performs a deep, goal-oriented analysis of a code repository or directory.
+
+    This powerful tool recursively reads all relevant files in a directory, extracts key information, and then summarizes that information in relation to a specific goal. It uses intelligent sub-agents for extraction and summarization, making it ideal for complex tasks that require a holistic understanding of a codebase.
+
     Use this tool for:
-    - summarization
-    - outline/structure extraction
-    - code review
-    - create diagram as code
-    - other tasks
+    - Understanding a large or unfamiliar codebase.
+    - Generating high-level summaries of a project's architecture.
+    - Performing a preliminary code review.
+    - Creating documentation or diagrams (e.g., "Generate a Mermaid C4 diagram for this service").
+    - Answering broad questions like "How does the authentication in this project work?".
+
     Args:
-        path (str): File path to be analyze. Pass exactly as provided, including '~'.
-        goal(str): Goal of extracting information (for example creating C4 diagram)
-        extensions(Optional[list[str]]): List of extension to be included
-            while reading resources. Defaults to common programming languages and config files.
-        exclude_patterns(Optional[list[str]]): List of patterns to exclude from analysis.
-            Common patterns like '.venv', 'node_modules' should be excluded by default.
-        extraction_token_limit(Optional[int]): Max resource content char length
-            the extraction assistant able to handle. Defaults to 150000
-        summarization_token_limit(Optional[int]): Max resource content char length
-            the summarization assistant able to handle. Defaults to 150000
+        path (str): The path to the directory or repository to analyze.
+        goal (str): A clear and specific description of what you want to achieve. A good goal is critical for getting a useful result. For example: "Understand the database schema by analyzing all the .sql files" or "Create a summary of all the API endpoints defined in the 'api' directory".
+        extensions (list[str], optional): A list of file extensions to include in the analysis. Defaults to a comprehensive list of common code and configuration files.
+        exclude_patterns (list[str], optional): A list of glob patterns for files and directories to exclude from the analysis. Defaults to common patterns like '.git', 'node_modules', and '.venv'.
+        extraction_token_limit (int, optional): The maximum token limit for the extraction sub-agent.
+        summarization_token_limit (int, optional): The maximum token limit for the summarization sub-agent.
+
     Returns:
-        str: The analysis result
+        str: A detailed, markdown-formatted analysis and summary of the repository, tailored to the specified goal.
     Raises:
-        Exception: If an error occurs.
+        Exception: If an error occurs during the analysis.
     """
     abs_path = os.path.abspath(os.path.expanduser(path))
     file_metadatas = _get_file_metadatas(abs_path, extensions, exclude_patterns)