zrb 1.5.16__py3-none-any.whl → 1.6.0__py3-none-any.whl

zrb/llm_config.py

@@ -1,4 +1,3 @@
-import os
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
@@ -8,7 +7,7 @@ else:
     Model = Any
     Provider = Any
 
-from zrb.util.string.conversion import to_boolean
+from zrb.config import CFG
 
 DEFAULT_SYSTEM_PROMPT = """
 You have access to tools.
@@ -65,72 +64,30 @@ class LLMConfig:
         default_enrich_context: bool | None = None,
         default_context_enrichment_threshold: int | None = None,
     ):
-        self._default_model_name = (
-            default_model_name
-            if default_model_name is not None
-            else os.getenv("ZRB_LLM_MODEL", None)
-        )
-        self._default_model_base_url = (
-            default_base_url
-            if default_base_url is not None
-            else os.getenv("ZRB_LLM_BASE_URL", None)
-        )
-        self._default_model_api_key = (
-            default_api_key
-            if default_api_key is not None
-            else os.getenv("ZRB_LLM_API_KEY", None)
-        )
-        self._default_system_prompt = (
-            default_system_prompt
-            if default_system_prompt is not None
-            else os.getenv("ZRB_LLM_SYSTEM_PROMPT", None)
-        )
-        self._default_persona = (
-            default_persona
-            if default_persona is not None
-            else os.getenv("ZRB_LLM_PERSONA", None)
-        )
-        self._default_special_instruction_prompt = (
-            default_special_instruction_prompt
-            if default_special_instruction_prompt is not None
-            else os.getenv("ZRB_LLM_SPECIAL_INSTRUCTION_PROMPT", None)
-        )
-        self._default_summarization_prompt = (
-            default_summarization_prompt
-            if default_summarization_prompt is not None
-            else os.getenv("ZRB_LLM_SUMMARIZATION_PROMPT", None)
-        )
-        self._default_context_enrichment_prompt = (
-            default_context_enrichment_prompt
-            if default_context_enrichment_prompt is not None
-            else os.getenv("ZRB_LLM_CONTEXT_ENRICHMENT_PROMPT", None)
-        )
-        self._default_summarize_history = (
-            default_summarize_history
-            if default_summarize_history is not None
-            else to_boolean(os.getenv("ZRB_LLM_SUMMARIZE_HISTORY", "true"))
-        )
+        self._default_model_name = default_model_name
+        self._default_model_base_url = default_base_url
+        self._default_model_api_key = default_api_key
+        self._default_persona = default_persona
+        self._default_system_prompt = default_system_prompt
+        self._default_special_instruction_prompt = default_special_instruction_prompt
+        self._default_summarization_prompt = default_summarization_prompt
+        self._default_context_enrichment_prompt = default_context_enrichment_prompt
+        self._default_summarize_history = default_summarize_history
         self._default_history_summarization_threshold = (
             default_history_summarization_threshold
-            if default_history_summarization_threshold is not None
-            else int(os.getenv("ZRB_LLM_HISTORY_SUMMARIZATION_THRESHOLD", "5"))
-        )
-        self._default_enrich_context = (
-            default_enrich_context
-            if default_enrich_context is not None
-            else to_boolean(os.getenv("ZRB_LLM_ENRICH_CONTEXT", "true"))
         )
+        self._default_enrich_context = default_enrich_context
         self._default_context_enrichment_threshold = (
             default_context_enrichment_threshold
-            if default_context_enrichment_threshold is not None
-            else int(os.getenv("ZRB_LLM_CONTEXT_ENRICHMENT_THRESHOLD", "5"))
         )
         self._default_provider = None
         self._default_model = None
 
     def _get_model_name(self) -> str | None:
         return (
-            self._default_model_name if self._default_model_name is not None else None
+            self._default_model_name
+            if self._default_model_name is not None
+            else CFG.LLM_MODEL
         )
 
     def get_default_model_provider(self) -> Provider | str:
@@ -146,35 +103,53 @@ class LLMConfig:
 
     def get_default_system_prompt(self) -> str:
         return (
-            DEFAULT_SYSTEM_PROMPT
-            if self._default_system_prompt is None
-            else self._default_system_prompt
+            self._default_system_prompt
+            if self._default_system_prompt is not None
+            else (
+                CFG.LLM_SYSTEM_PROMPT
+                if CFG.LLM_SYSTEM_PROMPT is not None
+                else DEFAULT_SYSTEM_PROMPT
+            )
         )
 
     def get_default_persona(self) -> str:
         return (
-            DEFAULT_PERSONA if self._default_persona is None else self._default_persona
+            self._default_persona
+            if self._default_persona is not None
+            else (CFG.LLM_PERSONA if CFG.LLM_PERSONA is not None else DEFAULT_PERSONA)
         )
 
     def get_default_special_instruction_prompt(self) -> str:
         return (
-            DEFAULT_SPECIAL_INSTRUCTION_PROMPT
-            if self._default_special_instruction_prompt is None
-            else self._default_special_instruction_prompt
+            self._default_special_instruction_prompt
+            if self._default_special_instruction_prompt is not None
+            else (
+                CFG.LLM_SPECIAL_INSTRUCTION_PROMPT
+                if CFG.LLM_SPECIAL_INSTRUCTION_PROMPT is not None
+                else DEFAULT_SPECIAL_INSTRUCTION_PROMPT
+            )
         )
 
     def get_default_summarization_prompt(self) -> str:
         return (
-            DEFAULT_SUMMARIZATION_PROMPT
-            if self._default_summarization_prompt is None
-            else self._default_summarization_prompt
+            self._default_summarization_prompt
+            if self._default_summarization_prompt is not None
+            else (
+                CFG.LLM_SUMMARIZATION_PROMPT
+                if CFG.LLM_SUMMARIZATION_PROMPT is not None
+                else DEFAULT_SUMMARIZATION_PROMPT
+            )
         )
 
     def get_default_context_enrichment_prompt(self) -> str:
         return (
-            DEFAULT_CONTEXT_ENRICHMENT_PROMPT
-            if self._default_context_enrichment_prompt is None
-            else self._default_context_enrichment_prompt
+            self._default_context_enrichment_prompt
+            if self._default_context_enrichment_prompt is not None
+            else (
+                CFG.LLM_CONTEXT_ENRICHMENT_PROMPT
+                if CFG.LLM_CONTEXT_ENRICHMENT_PROMPT is not None
+                else DEFAULT_CONTEXT_ENRICHMENT_PROMPT
+            )
         )
 
     def get_default_model(self) -> Model | str | None:
@@ -191,16 +166,32 @@ class LLMConfig:
         )
 
     def get_default_summarize_history(self) -> bool:
-        return self._default_summarize_history
+        return (
+            self._default_summarize_history
+            if self._default_summarize_history is not None
+            else CFG.LLM_SUMMARIZE_HISTORY
+        )
 
     def get_default_history_summarization_threshold(self) -> int:
-        return self._default_history_summarization_threshold
+        return (
+            self._default_history_summarization_threshold
+            if self._default_history_summarization_threshold is not None
+            else CFG.LLM_HISTORY_SUMMARIZATION_THRESHOLD
+        )
 
     def get_default_enrich_context(self) -> bool:
-        return self._default_enrich_context
+        return (
+            self._default_enrich_context
+            if self._default_enrich_context is not None
+            else CFG.LLM_ENRICH_CONTEXT
+        )
 
     def get_default_context_enrichment_threshold(self) -> int:
-        return self._default_context_enrichment_threshold
+        return (
+            self._default_context_enrichment_threshold
+            if self._default_context_enrichment_threshold is not None
+            else CFG.LLM_CONTEXT_ENRICHMENT_THRESHOLD
+        )
 
     def set_default_persona(self, persona: str):
         self._default_persona = persona

zrb/runner/cli.py

@@ -1,7 +1,7 @@
 import sys
 from typing import Any
 
-from zrb.config import BANNER, VERSION, WEB_HTTP_PORT
+from zrb.config import CFG
 from zrb.context.any_context import AnyContext
 from zrb.context.shared_context import SharedContext
 from zrb.group.any_group import AnyGroup
@@ -23,6 +23,13 @@ from zrb.util.string.conversion import double_quote
 
 
 class Cli(Group):
+
+    @property
+    def banner(self) -> str:
+        if self._banner is None:
+            return CFG.BANNER
+        return self._banner
+
     def run(self, args: list[str] = []):
         kwargs, args = self._extract_kwargs_from_args(args)
         node, node_path, args = extract_node_from_args(self, args)
@@ -147,14 +154,14 @@ class Cli(Group):
         return kwargs, residual_args
 
 
-cli = Cli(name="zrb", description="Your Automation Powerhouse", banner=BANNER)
+cli = Cli(name="zrb", description="Your Automation Powerhouse")
 
 
 @make_task(
     name="version", description="🌟 Get current Zrb version", retries=0, group=cli
 )
 def get_version(_: AnyContext):
-    return VERSION
+    return CFG.VERSION
 
 
 server_group = cli.add_group(
@@ -174,5 +181,7 @@ async def start_server(_: AnyContext):
     from uvicorn import Config, Server
 
     app = create_web_app(cli, web_config, session_state_logger)
-    server = Server(Config(app=app, host="0.0.0.0", port=WEB_HTTP_PORT, loop="asyncio"))
+    server = Server(
+        Config(app=app, host="0.0.0.0", port=CFG.WEB_HTTP_PORT, loop="asyncio")
+    )
     await server.serve()

zrb/runner/web_app.py

@@ -2,7 +2,7 @@ import asyncio
 import sys
 from typing import TYPE_CHECKING
 
-from zrb.config import BANNER, VERSION
+from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_config.config import WebConfig
 from zrb.runner.web_route.docs_route import serve_docs
@@ -37,7 +37,7 @@ def create_web_app(
 
     @asynccontextmanager
     async def lifespan(app: FastAPI):
-        for line in BANNER.split("\n") + [
+        for line in CFG.BANNER.split("\n") + [
             f"Zrb Server running on http://localhost:{web_config.port}"
         ]:
             print(line, file=sys.stderr)
@@ -48,7 +48,7 @@ def create_web_app(
 
     app = FastAPI(
         title="Zrb",
-        version=VERSION,
+        version=CFG.VERSION,
         summary="Your Automation Powerhouse",
         lifespan=lifespan,
         docs_url=None,

zrb/runner/web_config/config_factory.py

@@ -1,26 +1,15 @@
-from zrb.config import (
-    WEB_ACCESS_TOKEN_COOKIE_NAME,
-    WEB_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES,
-    WEB_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES,
-    WEB_ENABLE_AUTH,
-    WEB_GUEST_USERNAME,
-    WEB_HTTP_PORT,
-    WEB_REFRESH_TOKEN_COOKIE_NAME,
-    WEB_SECRET_KEY,
-    WEB_SUPER_ADMIN_PASSWORD,
-    WEB_SUPER_ADMIN_USERNAME,
-)
+from zrb.config import CFG
 from zrb.runner.web_config.config import WebConfig
 
 web_config = WebConfig(
-    port=WEB_HTTP_PORT,
-    secret_key=WEB_SECRET_KEY,
-    access_token_expire_minutes=WEB_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES,
-    refresh_token_expire_minutes=WEB_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES,
-    access_token_cookie_name=WEB_ACCESS_TOKEN_COOKIE_NAME,
-    refresh_token_cookie_name=WEB_REFRESH_TOKEN_COOKIE_NAME,
-    enable_auth=WEB_ENABLE_AUTH,
-    super_admin_username=WEB_SUPER_ADMIN_USERNAME,
-    super_admin_password=WEB_SUPER_ADMIN_PASSWORD,
-    guest_username=WEB_GUEST_USERNAME,
+    port=CFG.WEB_HTTP_PORT,
+    secret_key=CFG.WEB_SECRET_KEY,
+    access_token_expire_minutes=CFG.WEB_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES,
+    refresh_token_expire_minutes=CFG.WEB_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES,
+    access_token_cookie_name=CFG.WEB_ACCESS_TOKEN_COOKIE_NAME,
+    refresh_token_cookie_name=CFG.WEB_REFRESH_TOKEN_COOKIE_NAME,
+    enable_auth=CFG.WEB_ENABLE_AUTH,
+    super_admin_username=CFG.WEB_SUPER_ADMIN_USERNAME,
+    super_admin_password=CFG.WEB_SUPER_ADMIN_PASSWORD,
+    guest_username=CFG.WEB_GUEST_USERNAME,
 )

zrb/runner/web_route/error_page/show_error_page.py

@@ -1,5 +1,6 @@
 import os
 
+from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_schema.user import User
 from zrb.runner.web_util.html import get_html_auth_link
@@ -11,17 +12,26 @@ def show_error_page(user: User, root_group: AnyGroup, status_code: int, message:
     from fastapi.responses import HTMLResponse
 
     _DIR = os.path.dirname(__file__)
+    _GLOBAL_TEMPLATE = read_file(
+        os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
+    )
     _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
     auth_link = get_html_auth_link(user)
     return HTMLResponse(
         fstring_format(
-            _VIEW_TEMPLATE,
+            _GLOBAL_TEMPLATE,
             {
-                "name": root_group.name,
-                "description": root_group.description,
-                "auth_link": auth_link,
-                "error_status_code": status_code,
-                "error_message": message,
+                "web_title": CFG.WEB_TITLE,
+                "content": fstring_format(
+                    _VIEW_TEMPLATE,
+                    {
+                        "name": root_group.name,
+                        "description": root_group.description,
+                        "auth_link": auth_link,
+                        "error_status_code": status_code,
+                        "error_message": message,
+                    },
+                ),
             },
         ),
         status_code=status_code,

zrb/runner/web_route/home_page/home_page_route.py

@@ -1,6 +1,7 @@
 import os
 from typing import TYPE_CHECKING
 
+from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_config.config import WebConfig
 from zrb.runner.web_util.html import (
@@ -30,22 +31,37 @@ def serve_home_page(
     @app.get("/ui", response_class=HTMLResponse, include_in_schema=False)
     @app.get("/ui/", response_class=HTMLResponse, include_in_schema=False)
     async def home_page_ui(request: Request) -> HTMLResponse:
-
         _DIR = os.path.dirname(__file__)
+        _GLOBAL_TEMPLATE = read_file(
+            os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
+        )
         _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
+        web_title = CFG.WEB_TITLE if CFG.WEB_TITLE.strip() != "" else root_group.name
+        web_jargon = (
+            CFG.WEB_JARGON if CFG.WEB_JARGON.strip() != "" else root_group.description
+        )
         user = await get_user_from_request(web_config, request)
         group_info = get_html_subgroup_info(user, "/ui/", root_group)
         task_info = get_html_subtask_info(user, "/ui/", root_group)
         auth_link = get_html_auth_link(user)
         return HTMLResponse(
             fstring_format(
-                _VIEW_TEMPLATE,
+                _GLOBAL_TEMPLATE,
                 {
-                    "group_info": group_info,
-                    "task_info": task_info,
-                    "name": root_group.name,
-                    "description": root_group.description,
-                    "auth_link": auth_link,
+                    "web_title": web_title,
+                    "content": fstring_format(
+                        _VIEW_TEMPLATE,
+                        {
+                            "web_title": web_title,
+                            "web_jargon": web_jargon,
+                            "web_homepage_intro": CFG.WEB_HOMEPAGE_INTRO,
+                            "group_info": group_info,
+                            "task_info": task_info,
+                            "name": root_group.name,
+                            "description": root_group.description,
+                            "auth_link": auth_link,
+                        },
+                    ),
                 },
             )
         )

zrb/runner/web_route/home_page/view.html

@@ -1,33 +1,19 @@
-<!doctype html>
-<html lang="en">
-    <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <meta name="color-scheme" content="light dark">
-        <link rel="stylesheet" href="/static/pico.min.css">
-        <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
-        <title>Zrb</title>
-        <link rel="stylesheet" href="/static/common.css">
-    </head>
-    <body>
-        <header class="container">
-            <hgroup>
-                <h1>{name}</h1>
-                <p>{description}</p>
-                <nav>
-                    <ul>
-                        <li><a href="/docs">💻 API Documentation</a></li>
-                    </ul>
-                    <ul>
-                        <li>{auth_link}</li>
-                    </ul>
-                </nav>
-            </hgroup>
-        </header>
-        <main class="container">
-                {group_info}
-                {task_info}
-        </main>
-    </body>
-    <script src="/refresh-token.js"></script>
-</html>
+<header class="container">
+    <hgroup>
+        <h1>{web_title}</h1>
+        <p>{web_jargon}</p>
+        <nav>
+            <ul>
+                <li><a href="/docs">💻 API Documentation</a></li>
+            </ul>
+            <ul>
+                <li>{auth_link}</li>
+            </ul>
+        </nav>
+    </hgroup>
+</header>
+<main class="container">
+    <p>{web_homepage_intro}</p>
+    {group_info}
+    {task_info}
+</main>

zrb/runner/web_route/login_page/login_page_route.py

@@ -1,6 +1,7 @@
 import os
 from typing import TYPE_CHECKING
 
+from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_config.config import WebConfig
 from zrb.runner.web_util.html import get_html_auth_link
@@ -24,16 +25,25 @@ def serve_login_page(
     @app.get("/login", response_class=HTMLResponse, include_in_schema=False)
     async def login(request: Request) -> HTMLResponse:
         _DIR = os.path.dirname(__file__)
+        _GLOBAL_TEMPLATE = read_file(
+            os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
+        )
         _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
         user = await get_user_from_request(web_config, request)
         auth_link = get_html_auth_link(user)
         return HTMLResponse(
             fstring_format(
-                _VIEW_TEMPLATE,
+                _GLOBAL_TEMPLATE,
                 {
-                    "name": root_group.name,
-                    "description": root_group.description,
-                    "auth_link": auth_link,
+                    "web_title": CFG.WEB_TITLE,
+                    "content": fstring_format(
+                        _VIEW_TEMPLATE,
+                        {
+                            "name": root_group.name,
+                            "description": root_group.description,
+                            "auth_link": auth_link,
+                        },
+                    ),
                 },
             )
         )

zrb/runner/web_route/login_page/view.html

@@ -1,51 +1,33 @@
-<!doctype html>
-<html lang="en">
-
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="color-scheme" content="light dark">
-    <link rel="stylesheet" href="/static/pico.min.css">
-    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
-    <title>Zrb</title>
-    <link rel="stylesheet" href="/static/common.css">
-</head>
-
-<body>
-    <header class="container">
-        <hgroup>
-            <h1>{name}</h1>
-            <p>{description}</p>
-            <nav>
-                <ul>
-                    <li><a href="/">🏠 Home</a></li>
-                    <li><a href="/docs">💻 API Documentation</a></li>
-                </ul>
-            </nav>
-        </hgroup>
-    </header>
-    <main class="container">
-        <article>
-            <h1>Login</h1>
-            <form id="login-form" onsubmit="login(event)">
-                <label for="username">
-                    Username
-                    <input type="text" id="username" name="username" placeholder="Enter your username" required />
-                </label>
-                <label for="password">
-                    Password
-                    <input type="password" id="password" name="password" placeholder="Enter your password" required />
-                </label>
-                <div class="button-group">
-                    <button class="primary">🔑 Login</button>
-                    <button class="secondary" onclick="window.history.back()">🔙 Cancel</button>
-                </div>
-            </form>
-            <p id="error-message"></p>
-        </article>
-    </main>
-    <script src="/static/login/event.js"></script>
-    <script src="/refresh-token.js"></script>
-</body>
-
-</html>
+<header class="container">
+    <hgroup>
+        <h1>{name}</h1>
+        <p>{description}</p>
+        <nav>
+            <ul>
+                <li><a href="/">🏠 Home</a></li>
+                <li><a href="/docs">💻 API Documentation</a></li>
+            </ul>
+        </nav>
+    </hgroup>
+</header>
+<main class="container">
+    <article>
+        <h1>Login</h1>
+        <form id="login-form" onsubmit="login(event)">
+            <label for="username">
+                Username
+                <input type="text" id="username" name="username" placeholder="Enter your username" required />
+            </label>
+            <label for="password">
+                Password
+                <input type="password" id="password" name="password" placeholder="Enter your password" required />
+            </label>
+            <div class="button-group">
+                <button class="primary">🔑 Login</button>
+                <button class="secondary" onclick="window.history.back()">🔙 Cancel</button>
+            </div>
+        </form>
+        <p id="error-message"></p>
+    </article>
+</main>
+<script src="/static/login/event.js"></script>

zrb/runner/web_route/logout_page/logout_page_route.py

@@ -1,6 +1,7 @@
 import os
 from typing import TYPE_CHECKING
 
+from zrb.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_config.config import WebConfig
 from zrb.runner.web_util.html import get_html_auth_link
@@ -24,17 +25,26 @@ def serve_logout_page(
     @app.get("/logout", response_class=HTMLResponse, include_in_schema=False)
     async def logout(request: Request) -> HTMLResponse:
         _DIR = os.path.dirname(__file__)
+        _GLOBAL_TEMPLATE = read_file(
+            os.path.join(os.path.dirname(_DIR), "static", "global_template.html")
+        )
         _VIEW_TEMPLATE = read_file(os.path.join(_DIR, "view.html"))
         user = await get_user_from_request(web_config, request)
         auth_link = get_html_auth_link(user)
         return HTMLResponse(
             fstring_format(
-                _VIEW_TEMPLATE,
+                _GLOBAL_TEMPLATE,
                 {
-                    "name": root_group.name,
-                    "description": root_group.description,
-                    "auth_link": auth_link,
-                    "user": user,
+                    "web_title": CFG.WEB_TITLE,
+                    "content": fstring_format(
+                        _VIEW_TEMPLATE,
+                        {
+                            "name": root_group.name,
+                            "description": root_group.description,
+                            "auth_link": auth_link,
+                            "user": user,
+                        },
+                    ),
                 },
             )
         )