zrb 1.0.0a18__py3-none-any.whl → 1.0.0a20__py3-none-any.whl

zrb/__init__.py

@@ -27,12 +27,14 @@ from zrb.group.group import Group
 from zrb.input.any_input import AnyInput
 from zrb.input.base_input import BaseInput
 from zrb.input.bool_input import BoolInput
+from zrb.input.float_input import FloatInput
 from zrb.input.int_input import IntInput
 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.runner.cli import cli
+from zrb.runner.web_config import User, web_config
 from zrb.session.session import Session
 from zrb.task.any_task import AnyTask
 from zrb.task.base_task import BaseTask
@@ -73,6 +75,7 @@ assert CmdResult
 assert CmdTask
 assert HttpCheck
 assert TcpCheck
+assert FloatInput
 assert IntInput
 assert OptionInput
 assert PasswordInput
@@ -98,6 +101,8 @@ assert Scaffolder
 assert Scheduler
 assert cli
 assert Xcom
+assert web_config
+assert User
 
 if LOAD_BUILTIN:
     from zrb import builtin

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/client/api_client.py

@@ -1,6 +1,6 @@
 from my_app_name.config import APP_AUTH_BASE_URL
 from my_app_name.module.auth.client.any_client import AnyClient
-from my_app_name.module.auth.service.user.user_usecase import user_usecase
+from my_app_name.module.auth.service.user.user_usecase_factory import user_usecase
 
 
 class APIClient(user_usecase.as_api_client(base_url=APP_AUTH_BASE_URL), AnyClient):

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/client/direct_client.py

@@ -1,5 +1,5 @@
 from my_app_name.module.auth.client.any_client import AnyClient
-from my_app_name.module.auth.service.user.user_usecase import user_usecase
+from my_app_name.module.auth.service.user.user_usecase_factory import user_usecase
 
 
 class DirectClient(user_usecase.as_direct_client(), AnyClient):

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/route.py

@@ -2,7 +2,7 @@ from fastapi import FastAPI
 from my_app_name.common.app import app
 from my_app_name.common.schema import BasicResponse
 from my_app_name.config import APP_MAIN_MODULE, APP_MODE, APP_MODULES
-from my_app_name.module.auth.service.user.user_usecase import user_usecase
+from my_app_name.module.auth.service.user.user_usecase_factory import user_usecase
 
 
 def serve_health_check(app: FastAPI):

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/service/user/user_usecase.py

@@ -1,5 +1,4 @@
 from my_app_name.common.base_usecase import BaseUsecase
-from my_app_name.module.auth.service.user.repository.factory import user_repository
 from my_app_name.module.auth.service.user.repository.user_repository import (
     UserRepository,
 )
@@ -50,8 +49,5 @@ class UserUsecase(BaseUsecase):
     @BaseUsecase.route(
         "/api/v1/users/{user_id}", methods=["delete"], response_model=UserResponse
     )
-    async def delete_user(self, user_id: str) -> UserResponse:
+    async def delete_user(self, user_id: str, deleted_by: str) -> UserResponse:
         return await self.user_repository.delete(user_id)
-
-
-user_usecase = UserUsecase(user_repository=user_repository)

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/service/user/user_usecase_factory.py

@@ -0,0 +1,6 @@
+from my_app_name.module.auth.service.user.repository.user_repository_factory import (
+    user_repository,
+)
+from my_app_name.module.auth.service.user.user_usecase import UserUsecase
+
+user_usecase = UserUsecase(user_repository=user_repository)

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/route.py

@@ -2,8 +2,7 @@ from fastapi import FastAPI
 from my_app_name.common.app import app
 from my_app_name.common.schema import BasicResponse
 from my_app_name.config import APP_MAIN_MODULE, APP_MODE, APP_MODULES
-from my_app_name.module.auth.client.factory import client as auth_client
-from my_app_name.schema.user import UserCreate, UserResponse
+from my_app_name.module.gateway.subroute.auth import serve_auth_route
 
 
 def serve_health_check(app: FastAPI):
@@ -31,13 +30,8 @@ def serve_route(app: FastAPI):
         serve_health_check(app)
         serve_readiness_check(app)
 
-    @app.get("/api/v1/users", response_model=list[UserResponse])
-    async def auth_get_all_users() -> UserResponse:
-        return await auth_client.get_all_users()
-
-    @app.post("/api/v1/users", response_model=UserResponse | list[UserResponse])
-    async def auth_create_user(data: UserCreate | list[UserCreate]):
-        return await auth_client.create_user(data)
+    # Serve Auth Route
+    serve_auth_route(app)
 
 
 serve_route(app)

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/gateway/subroute/auth.py

@@ -0,0 +1,44 @@
+from fastapi import FastAPI
+from my_app_name.module.auth.client.factory import client as auth_client
+from my_app_name.schema.user import (
+    UserCreate,
+    UserCreateWithAudit,
+    UserResponse,
+    UserUpdate,
+    UserUpdateWithAudit,
+)
+
+
+def serve_auth_route(app: FastAPI):
+
+    @app.get("/api/v1/users", response_model=list[UserResponse])
+    async def get_all_users() -> UserResponse:
+        return await auth_client.get_all_users()
+
+    @app.get("/api/v1/users/{user_id}", response_model=UserResponse)
+    async def get_user_by_id(user_id: str) -> UserResponse:
+        return await auth_client.get_user_by_id(user_id)
+
+    @app.post("/api/v1/users", response_model=UserResponse | list[UserResponse])
+    async def create_user(data: UserCreate | list[UserCreate]):
+        if isinstance(data, UserCreate):
+            data_dict = data.model_dump(exclude_unset=True)
+            audited_data = UserCreateWithAudit(**data_dict, created_by="system")
+            return await auth_client.create_user(audited_data)
+        audited_data = [
+            UserCreateWithAudit(
+                **row.model_dump(exclude_unset=True), created_by="system"
+            )
+            for row in data
+        ]
+        return await auth_client.create_user(audited_data)
+
+    @app.put("/api/v1/users/{user_id}", response_model=UserResponse)
+    async def update_user(user_id: str, data: UserUpdate) -> UserResponse:
+        data_dict = data.model_dump(exclude_unset=True)
+        audited_data = UserUpdateWithAudit(**data_dict, updated_by="system")
+        return await auth_client.update_user(user_id, audited_data)
+
+    @app.delete("/api/v1/users/{user_id}", response_model=UserResponse)
+    async def delete_user(user_id: str) -> UserResponse:
+        return await auth_client.delete_user(user_id, deleted_by="system")

zrb/config.py

@@ -59,6 +59,23 @@ TODO_VISUAL_FILTER = os.getenv("ZRB_TODO_FILTER", "")
 TODO_RETENTION = os.getenv("ZRB_TODO_RETENTION", "2w")
 VERSION = metadata.version("zrb")
 WEB_HTTP_PORT = int(os.getenv("ZRB_WEB_HTTP_PORT", "21213"))
+WEB_GUEST_USERNAME = os.getenv("ZRB_WEB_GUEST_USERNAME", "user")
+WEB_SUPER_ADMIN_USERNAME = os.getenv("ZRB_WEB_SUPERADMIN_USERNAME", "admin")
+WEB_SUPER_ADMIN_PASSWORD = os.getenv("ZRB_WEB_SUPERADMIN_PASSWORD", "admin")
+WEB_ACCESS_TOKEN_COOKIE_NAME = os.getenv(
+    "ZRB_WEB_ACCESS_TOKEN_COOKIE_NAME", "access_token"
+)
+WEB_REFRESH_TOKEN_COOKIE_NAME = os.getenv(
+    "ZRB_WEB_REFRESH_TOKEN_COOKIE_NAME", "refresh_token"
+)
+WEB_SECRET_KEY = os.getenv("ZRB_WEB_SECRET", "zrb")
+WEB_ENABLE_AUTH = to_boolean(os.getenv("ZRB_WEB_ENABLE_AUTH", "0"))
+WEB_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES = int(
+    os.getenv("ZRB_WEB_ACCESS_TOKEN_EXPIRE", "30")
+)
+WEB_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES = int(
+    os.getenv("ZRB_WEB_ACCESS_TOKEN_EXPIRE", f"{60*24*7}")
+)
 LLM_MODEL = os.getenv("ZRB_LLM_MODEL", "ollama_chat/llama3.1")
 LLM_SYSTEM_PROMPT = os.getenv("ZRB_LLM_SYSTEM_PROMPT", "You are a helpful assistant")
 LLM_HISTORY_FILE = os.getenv(

zrb/input/any_input.py

@@ -32,3 +32,7 @@ class AnyInput(ABC):
     @abstractmethod
     def prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         pass
+
+    @abstractmethod
+    def get_default_str(self, shared_ctx: AnySharedContext) -> str:
+        pass

zrb/input/base_input.py

@@ -42,14 +42,14 @@ class BaseInput(AnyInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
+        default = self.get_default_str(ctx)
         return f'<input name="{name}" placeholder="{description}" value="{default}" />'
 
     def update_shared_context(
         self, shared_ctx: AnySharedContext, str_value: str | None = None
     ):
         if str_value is None:
-            str_value = self._get_default_str(shared_ctx)
+            str_value = self.get_default_str(shared_ctx)
         value = self._parse_str_value(str_value)
         if self.name in shared_ctx.input:
             raise ValueError(f"Input already defined in the context: {self.name}")
@@ -75,7 +75,7 @@ class BaseInput(AnyInput):
 
     def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         prompt_message = self.prompt_message
-        default_value = self._get_default_str(shared_ctx)
+        default_value = self.get_default_str(shared_ctx)
         if default_value != "":
             prompt_message = f"{prompt_message} [{default_value}]"
         print(f"{prompt_message}: ", end="")
@@ -84,7 +84,7 @@ class BaseInput(AnyInput):
             value = default_value
         return value
 
-    def _get_default_str(self, shared_ctx: AnySharedContext) -> str:
+    def get_default_str(self, shared_ctx: AnySharedContext) -> str:
         return get_str_attr(
             shared_ctx, self._default_str, auto_render=self._auto_render
         )

zrb/input/bool_input.py

@@ -26,7 +26,7 @@ class BoolInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = to_boolean(self._get_default_str(ctx))
+        default = to_boolean(self.get_default_str(ctx))
         selected_true = "selected" if default else ""
         selected_false = "selected" if not default else ""
         return "\n".join(

zrb/input/float_input.py

@@ -25,8 +25,8 @@ class FloatInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
-        return f'<input type="number" name="{name}" placeholder="{description}" value="{default}" />'  # noqa
+        default = self.get_default_str(ctx)
+        return f'<input type="number" name="{name}" placeholder="{description}" value="{default}" step="any" />'  # noqa
 
     def _parse_str_value(self, str_value: str) -> float:
         return float(str_value)

zrb/input/int_input.py

@@ -25,7 +25,7 @@ class IntInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
+        default = self.get_default_str(ctx)
         return f'<input type="number" step="1" name="{name}" placeholder="{description}" value="{default}" />'  # noqa
 
     def _parse_str_value(self, str_value: str) -> int:

zrb/input/option_input.py

@@ -28,7 +28,7 @@ class OptionInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
+        default = self.get_default_str(ctx)
         html = [f'<select name="{name}" placeholder="{description}">']
         for value in get_str_list_attr(ctx, self._options, self._auto_render):
             selected = "selected" if value == default else ""
@@ -38,7 +38,7 @@ class OptionInput(BaseInput):
 
     def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         prompt_message = self.prompt_message
-        default_value = self._get_default_str(shared_ctx)
+        default_value = self.get_default_str(shared_ctx)
         options = get_str_list_attr(shared_ctx, self._options, self._auto_render)
         option_str = ", ".join(options)
         if default_value != "":

zrb/input/password_input.py

@@ -28,12 +28,12 @@ class PasswordInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
+        default = self.get_default_str(ctx)
         return f'<input type="password" name="{name}" placeholder="{description}" value="{default}" />'  # noqa
 
     def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         prompt_message = self.prompt_message
-        default_value = self._get_default_str(shared_ctx)
+        default_value = self.get_default_str(shared_ctx)
         value = getpass.getpass(f"{prompt_message}: ")
         if value.strip() == "":
             value = default_value

zrb/input/text_input.py

@@ -57,7 +57,7 @@ class TextInput(BaseInput):
     def to_html(self, ctx: AnySharedContext) -> str:
         name = self.name
         description = self.description
-        default = self._get_default_str(ctx)
+        default = self.get_default_str(ctx)
         return "\n".join(
             [
                 f'<textarea name="{name}" placeholder="{description}">',
@@ -71,7 +71,7 @@ class TextInput(BaseInput):
             f"{self.comment_start}{super().prompt_message}{self.comment_end}"
         )
         prompt_message_eol = f"{prompt_message}\n"
-        default_value = self._get_default_str(shared_ctx)
+        default_value = self.get_default_str(shared_ctx)
         with tempfile.NamedTemporaryFile(
             delete=False, suffix=self._extension
         ) as temp_file:

zrb/runner/cli.py

@@ -5,8 +5,13 @@ from zrb.config import BANNER, WEB_HTTP_PORT
 from zrb.context.any_context import AnyContext
 from zrb.context.shared_context import SharedContext
 from zrb.group.group import Group
+from zrb.runner.common_util import get_run_kwargs
 from zrb.runner.web_app import create_app
+from zrb.runner.web_config import web_config
 from zrb.session.session import Session
+from zrb.session_state_logger.default_session_state_logger import (
+    default_session_state_logger,
+)
 from zrb.task.any_task import AnyTask
 from zrb.task.make_task import make_task
 from zrb.util.cli.style import (
@@ -30,7 +35,7 @@ class Cli(Group):
         if "h" in kwargs or "help" in kwargs:
             self._show_task_info(node)
             return
-        run_kwargs = self._get_run_kwargs(node, args, kwargs)
+        run_kwargs = get_run_kwargs(task=node, args=args, kwargs=kwargs, prompt=True)
         try:
             result = self._run_task(node, args, run_kwargs)
             if result is not None:
@@ -72,35 +77,6 @@ class Cli(Group):
                 continue
         return task.run(Session(shared_ctx=shared_ctx, root_group=self))
 
-    def _get_run_kwargs(
-        self, task: AnyTask, args: list[str], kwargs: dict[str, str]
-    ) -> tuple[Any]:
-        arg_index = 0
-        str_kwargs = {key: val for key, val in kwargs.items()}
-        run_kwargs = {**str_kwargs}
-        shared_ctx = SharedContext(args=args)
-        for task_input in task.inputs:
-            if task_input.name in str_kwargs:
-                # Update shared context for next input default value
-                task_input.update_shared_context(
-                    shared_ctx, str_kwargs[task_input.name]
-                )
-            elif arg_index < len(args):
-                run_kwargs[task_input.name] = args[arg_index]
-                # Update shared context for next input default value
-                task_input.update_shared_context(
-                    shared_ctx, run_kwargs[task_input.name]
-                )
-                arg_index += 1
-            else:
-                str_value = task_input.prompt_cli_str(shared_ctx)
-                run_kwargs[task_input.name] = str_value
-                # Update shared context for next input default value
-                task_input.update_shared_context(
-                    shared_ctx, run_kwargs[task_input.name]
-                )
-        return run_kwargs
-
     def _show_task_info(self, task: AnyTask):
         description = task.description
         inputs = task.inputs
@@ -188,10 +164,9 @@ server_group = cli.add_group(
     group=server_group,
     alias="start",
 )
-async def run(_: AnyContext):
+async def start_server(_: AnyContext):
     from uvicorn import Config, Server
 
-    app = create_app(cli, WEB_HTTP_PORT)
-    config = Config(app=app, host="0.0.0.0", port=WEB_HTTP_PORT, loop="asyncio")
-    server = Server(config)
+    app = create_app(cli, web_config, default_session_state_logger)
+    server = Server(Config(app=app, host="0.0.0.0", port=WEB_HTTP_PORT, loop="asyncio"))
     await server.serve()

zrb/runner/common_util.py

@@ -0,0 +1,31 @@
+from typing import Any
+
+from zrb.context.shared_context import SharedContext
+from zrb.task.any_task import AnyTask
+
+
+def get_run_kwargs(
+    task: AnyTask, args: list[str], kwargs: dict[str, str], prompt: bool = True
+) -> tuple[Any]:
+    arg_index = 0
+    str_kwargs = {key: val for key, val in kwargs.items()}
+    run_kwargs = {**str_kwargs}
+    shared_ctx = SharedContext(args=args)
+    for task_input in task.inputs:
+        if task_input.name in str_kwargs:
+            # Update shared context for next input default value
+            task_input.update_shared_context(shared_ctx, str_kwargs[task_input.name])
+        elif arg_index < len(args):
+            run_kwargs[task_input.name] = args[arg_index]
+            # Update shared context for next input default value
+            task_input.update_shared_context(shared_ctx, run_kwargs[task_input.name])
+            arg_index += 1
+        else:
+            if prompt:
+                str_value = task_input.prompt_cli_str(shared_ctx)
+            else:
+                str_value = task_input.get_default_str(shared_ctx)
+            run_kwargs[task_input.name] = str_value
+            # Update shared context for next input default value
+            task_input.update_shared_context(shared_ctx, run_kwargs[task_input.name])
+    return run_kwargs