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

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/module/auth/client/any_client.py

@@ -1,9 +1,13 @@
 from abc import ABC, abstractmethod
 
-from fastapp_template.schema.user import UserCreate, UserResponse, UserUpdate
+from my_app_name.schema.user import (
+    UserCreateWithAudit,
+    UserResponse,
+    UserUpdateWithAudit,
+)
 
 
-class BaseClient(ABC):
+class AnyClient(ABC):
     @abstractmethod
     async def get_user_by_id(self, user_id: str) -> UserResponse:
         pass
@@ -14,12 +18,14 @@ class BaseClient(ABC):
 
     @abstractmethod
     async def create_user(
-        self, data: UserCreate | list[UserCreate]
+        self, data: UserCreateWithAudit | list[UserCreateWithAudit]
     ) -> UserResponse | list[UserResponse]:
         pass
 
     @abstractmethod
-    async def update_user(self, user_id: str, data: UserUpdate) -> UserResponse:
+    async def update_user(
+        self, user_id: str, data: UserUpdateWithAudit
+    ) -> UserResponse:
         pass
 
     @abstractmethod

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

@@ -0,0 +1,7 @@
+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_factory import user_usecase
+
+
+class APIClient(user_usecase.as_api_client(base_url=APP_AUTH_BASE_URL), AnyClient):
+    pass

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

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

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

@@ -0,0 +1,9 @@
+from my_app_name.config import APP_COMMUNICATION
+from my_app_name.module.auth.client.any_client import AnyClient
+from my_app_name.module.auth.client.api_client import APIClient
+from my_app_name.module.auth.client.direct_client import DirectClient
+
+if APP_COMMUNICATION == "direct":
+    client: AnyClient = DirectClient()
+elif APP_COMMUNICATION == "api":
+    client: AnyClient = APIClient()

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/module/auth/migration/env.py

@@ -1,8 +1,8 @@
 from logging.config import fileConfig
 
 from alembic import context
-from fastapp_template.config import APP_DB_URL
-from fastapp_template.module.auth.migration_metadata import metadata
+from my_app_name.config import APP_DB_URL
+from my_app_name.module.auth.migration_metadata import metadata
 from sqlalchemy import engine_from_config, pool
 
 # this is the Alembic Config object, which provides
@@ -68,7 +68,6 @@ def run_migrations_offline() -> None:
         target_metadata=target_metadata,
         literal_binds=True,
         dialect_opts={"paramstyle": "named"},
-        imports=["import sqlmodel"],  # 🔥 FastApp Modification
         version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
         include_object=include_object,  # 🔥 FastApp Modification
     )
@@ -94,7 +93,6 @@ def run_migrations_online() -> None:
         context.configure(
             connection=connection,
             target_metadata=target_metadata,
-            imports=["import sqlmodel"],  # 🔥 FastApp Modification
             version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
             include_object=include_object,  # 🔥 FastApp Modification
         )

zrb/builtin/project/add/{fastapp_template/module/gateway → fastapp/fastapp_template/my_app_name/module/auth}/migration/script.py.mako

@@ -9,6 +9,7 @@ from typing import Sequence, Union
 
 from alembic import op
 import sqlalchemy as sa
+import sqlmodel  # 🔥 FastApp Modification
 ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/module/auth/migration_metadata.py

@@ -1,4 +1,4 @@
-from fastapp_template.schema.user import User
+from my_app_name.schema.user import User
 from sqlalchemy import MetaData
 
 metadata = MetaData()

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

@@ -0,0 +1,37 @@
+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_factory import user_usecase
+
+
+def serve_health_check(app: FastAPI):
+    @app.api_route("/health", methods=["GET", "HEAD"], response_model=BasicResponse)
+    async def health():
+        """
+        Microservice's health check
+        """
+        return BasicResponse(message="ok")
+
+
+def serve_readiness_check(app: FastAPI):
+    @app.api_route("/readiness", methods=["GET", "HEAD"], response_model=BasicResponse)
+    async def readiness():
+        """
+        Microservice's readiness check
+        """
+        return BasicResponse(message="ok")
+
+
+def serve_route(app: FastAPI):
+    if APP_MODE != "microservices" or "auth" not in APP_MODULES:
+        return
+    if APP_MAIN_MODULE == "auth":
+        serve_health_check(app)
+        serve_readiness_check(app)
+
+    # Serve user endpoints for APIClient
+    user_usecase.serve_route(app)
+
+
+serve_route(app)

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/module/auth/service/user/repository/user_db_repository.py

@@ -1,9 +1,14 @@
-from fastapp_template.common.base_db_repository import BaseDBRepository
-from fastapp_template.common.error import NotFoundError
-from fastapp_template.module.auth.service.user.repository.user_repository import (
+from my_app_name.common.base_db_repository import BaseDBRepository
+from my_app_name.common.error import NotFoundError
+from my_app_name.module.auth.service.user.repository.user_repository import (
     UserRepository,
 )
-from fastapp_template.schema.user import User, UserCreate, UserResponse, UserUpdate
+from my_app_name.schema.user import (
+    User,
+    UserCreateWithAudit,
+    UserResponse,
+    UserUpdateWithAudit,
+)
 from passlib.context import CryptContext
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlmodel import Session, select
@@ -17,12 +22,13 @@ def hash_password(password: str) -> str:
 
 
 class UserDBRepository(
-    BaseDBRepository[User, UserResponse, UserCreate, UserUpdate], UserRepository
+    BaseDBRepository[User, UserResponse, UserCreateWithAudit, UserUpdateWithAudit],
+    UserRepository,
 ):
     db_model = User
     response_model = UserResponse
-    create_model = UserCreate
-    update_model = UserUpdate
+    create_model = UserCreateWithAudit
+    update_model = UserUpdateWithAudit
     entity_name = "user"
     column_preprocessors = {"password": hash_password}
 

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

@@ -0,0 +1,42 @@
+from abc import ABC, abstractmethod
+
+from my_app_name.schema.user import (
+    User,
+    UserCreateWithAudit,
+    UserResponse,
+    UserUpdateWithAudit,
+)
+
+
+class UserRepository(ABC):
+    @abstractmethod
+    async def create(self, user_data: UserCreateWithAudit) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def get_by_id(self, user_id: str) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def get_all(self) -> list[User]:
+        pass
+
+    @abstractmethod
+    async def update(
+        self, user_id: str, user_data: UserUpdateWithAudit
+    ) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def delete(self, user_id: str) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def create_bulk(
+        self, user_data_list: list[UserCreateWithAudit]
+    ) -> list[UserResponse]:
+        pass
+
+    @abstractmethod
+    async def get_by_credentials(self, username: str, password: str) -> UserResponse:
+        pass

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

@@ -0,0 +1,13 @@
+from my_app_name.common.db_engine import engine
+from my_app_name.config import APP_REPOSITORY_TYPE
+from my_app_name.module.auth.service.user.repository.user_db_repository import (
+    UserDBRepository,
+)
+from my_app_name.module.auth.service.user.repository.user_repository import (
+    UserRepository,
+)
+
+if APP_REPOSITORY_TYPE == "db":
+    user_repository: UserRepository = UserDBRepository(engine)
+else:
+    user_repository: UserRepository = None

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

@@ -1,13 +1,15 @@
-from fastapp_template.common.base_usecase import BaseUsecase
-from fastapp_template.module.auth.service.user.repository.factory import user_repository
-from fastapp_template.module.auth.service.user.repository.user_repository import (
+from my_app_name.common.base_usecase import BaseUsecase
+from my_app_name.module.auth.service.user.repository.user_repository import (
     UserRepository,
 )
-from fastapp_template.schema.user import UserCreate, UserResponse, UserUpdate
+from my_app_name.schema.user import (
+    UserCreateWithAudit,
+    UserResponse,
+    UserUpdateWithAudit,
+)
 
 
 class UserUsecase(BaseUsecase):
-
     def __init__(self, user_repository: UserRepository):
         super().__init__()
         self.user_repository = user_repository
@@ -30,23 +32,22 @@ class UserUsecase(BaseUsecase):
         response_model=UserResponse | list[UserResponse],
     )
     async def create_user(
-        self, data: UserCreate | list[UserCreate]
+        self, data: UserCreateWithAudit | list[UserCreateWithAudit]
     ) -> UserResponse | list[UserResponse]:
-        if isinstance(data, UserCreate):
+        if isinstance(data, UserCreateWithAudit):
             return await self.user_repository.create(data)
         return await self.user_repository.create_bulk(data)
 
     @BaseUsecase.route(
         "/api/v1/users/{user_id}", methods=["put"], response_model=UserResponse
     )
-    async def update_user(self, user_id: str, data: UserUpdate) -> UserResponse:
+    async def update_user(
+        self, user_id: str, data: UserUpdateWithAudit
+    ) -> UserResponse:
         return await self.user_repository.update(user_id, data)
 
     @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_template → fastapp/fastapp_template/my_app_name}/module/gateway/migration/env.py

@@ -1,8 +1,8 @@
 from logging.config import fileConfig
 
 from alembic import context
-from fastapp_template.config import APP_DB_URL
-from fastapp_template.module.gateway.migration_metadata import metadata
+from my_app_name.config import APP_DB_URL
+from my_app_name.module.gateway.migration_metadata import metadata
 from sqlalchemy import engine_from_config, pool
 
 # this is the Alembic Config object, which provides
@@ -68,7 +68,6 @@ def run_migrations_offline() -> None:
         target_metadata=target_metadata,
         literal_binds=True,
         dialect_opts={"paramstyle": "named"},
-        imports=["import sqlmodel"],  # 🔥 FastApp Modification
         version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
         include_object=include_object,  # 🔥 FastApp Modification
     )
@@ -94,7 +93,6 @@ def run_migrations_online() -> None:
         context.configure(
             connection=connection,
             target_metadata=target_metadata,
-            imports=["import sqlmodel"],  # 🔥 FastApp Modification
             version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
             include_object=include_object,  # 🔥 FastApp Modification
         )

zrb/builtin/project/add/{fastapp_template/_zrb/module/module_template → fastapp/fastapp_template/my_app_name/module/gateway}/migration/script.py.mako

@@ -9,6 +9,7 @@ from typing import Sequence, Union
 
 from alembic import op
 import sqlalchemy as sa
+import sqlmodel  # 🔥 FastApp Modification
 ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.

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

@@ -0,0 +1,37 @@
+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.gateway.subroute.auth import serve_auth_route
+
+
+def serve_health_check(app: FastAPI):
+    @app.api_route("/health", methods=["GET", "HEAD"], response_model=BasicResponse)
+    async def health():
+        """
+        My App Name's health check
+        """
+        return BasicResponse(message="ok")
+
+
+def serve_readiness_check(app: FastAPI):
+    @app.api_route("/readiness", methods=["GET", "HEAD"], response_model=BasicResponse)
+    async def readiness():
+        """
+        My App Name's readiness check
+        """
+        return BasicResponse(message="ok")
+
+
+def serve_route(app: FastAPI):
+    if APP_MODE != "monolith" and "gateway" not in APP_MODULES:
+        return
+    if APP_MODE == "monolith" or APP_MAIN_MODULE == "gateway":
+        serve_health_check(app)
+        serve_readiness_check(app)
+
+    # 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/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/requirements.txt

@@ -1,4 +1,4 @@
-fastapi[standard]~=0.115.5
+fastapi[standard]~=0.115.6
 alembic~=1.14.0
 sqlmodel~=0.0.22
 ulid-py~=1.1.0

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/schema/permission.py

@@ -12,11 +12,19 @@ class PermissionCreate(PermissionBase):
     description: str
 
 
+class PermissionCreateWithAudit(PermissionCreate):
+    created_by: str
+
+
 class PermissionUpdate(SQLModel):
     name: str | None = None
     description: str | None = None
 
 
+class PermissionUpdateWithAudit(PermissionUpdate):
+    updated_by: str
+
+
 class PermissionResponse(PermissionBase):
     id: str
 

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/schema/role.py

@@ -12,11 +12,19 @@ class RoleCreate(RoleBase):
     description: str
 
 
+class RoleCreateWithAudit(RoleCreate):
+    created_by: str
+
+
 class RoleUpdate(SQLModel):
     name: str | None = None
     description: str | None = None
 
 
+class RoleUpdateWithAudit(RoleUpdate):
+    updated_by: str
+
+
 class RoleResponse(RoleBase):
     id: str
 

zrb/builtin/project/add/{fastapp_template → fastapp/fastapp_template/my_app_name}/schema/user.py

@@ -12,11 +12,19 @@ class UserCreate(UserBase):
     password: str
 
 
+class UserCreateWithAudit(UserCreate):
+    created_by: str
+
+
 class UserUpdate(SQLModel):
     username: str | None = None
     password: str | None = None
 
 
+class UserUpdateWithAudit(UserUpdate):
+    updated_by: str
+
+
 class UserResponse(UserBase):
     id: str
 

zrb/builtin/project/add/fastapp/fastapp_util.py

@@ -0,0 +1,46 @@
+import os
+
+from zrb.context.any_context import AnyContext
+from zrb.util.file import read_file, write_file
+from zrb.util.string.conversion import double_quote, to_snake_case
+
+
+def is_in_project_app_dir(ctx: AnyContext, file_path: str) -> bool:
+    return file_path.startswith(
+        os.path.join(ctx.input.project_dir, to_snake_case(ctx.input.app))
+    )
+
+
+def is_project_zrb_init_file(ctx: AnyContext, file_path: str) -> bool:
+    return file_path == os.path.join(ctx.input.project_dir, "zrb_init.py")
+
+
+def update_project_zrb_init_file(ctx: AnyContext, zrb_init_path: str):
+    existing_zrb_init_code = read_file(zrb_init_path)
+    write_file(
+        file_path=zrb_init_path,
+        content=[
+            _get_import_load_file_code(existing_zrb_init_code),
+            existing_zrb_init_code.strip(),
+            _get_load_app_name_task_code(ctx.input.app),
+        ],
+    )
+
+
+def _get_import_load_file_code(existing_code: str) -> str | None:
+    code = "from zrb import load_file"
+    return code if code not in existing_code else None
+
+
+def _get_load_app_name_task_code(app: str) -> str:
+    snake_app_name = to_snake_case(app)
+    load_file_param = ", ".join(
+        [double_quote(part) for part in [snake_app_name, "_zrb", "task.py"]]
+    )
+    return "\n".join(
+        [
+            f"# Load {app} automation",
+            f"{snake_app_name} = load_file(os.path.join(_DIR, {load_file_param}))",
+            f"assert {snake_app_name}",
+        ]
+    )

zrb/builtin/project/create/{create.py → project_task.py}

@@ -21,7 +21,7 @@ scaffold_project = Scaffolder(
             name="project",
             description="Project name",
             prompt="Project name",
-            default_str=lambda ctx: os.path.basename(ctx.input["project-dir"]),
+            default_str=lambda ctx: os.path.basename(ctx.input.project_dir),
         ),
     ],
     source_path=os.path.join(_DIR, "project-template"),

zrb/builtin/python.py

@@ -5,7 +5,10 @@ format_python_code = python_group.add_task(
     CmdTask(
         name="format-code",
         description="✏️ Format Python code",
-        cmd=["isort .", "black ."],
+        cmd=[
+            "isort . --profile black --force-grid-wrap 0",
+            "black .",
+        ],
     ),
     alias="format",
 )

zrb/builtin/setup/asdf/asdf_helper.py

@@ -1,6 +1,7 @@
 import os
 
 from zrb.context.any_context import AnyContext
+from zrb.util.file import read_file, write_file
 
 
 def get_install_prerequisites_cmd(ctx: AnyContext) -> str:
@@ -31,14 +32,9 @@ def setup_asdf_ps_config(file_path: str):
 
 
 def _setup_asdf_config(file_path: str, asdf_config: str):
-    dir_path = os.path.dirname(file_path)
-    os.makedirs(dir_path, exist_ok=True)
     if not os.path.isfile(file_path):
-        with open(file_path, "w") as f:
-            f.write("")
-    with open(file_path, "r") as f:
-        content = f.read()
+        write_file(file_path, "")
+    content = read_file(file_path)
     if asdf_config in content:
         return
-    with open(file_path, "a") as f:
-        f.write(f"\n{asdf_config}\n")
+    write_file(file_path, [content, asdf_config, ""])

zrb/builtin/setup/tmux/tmux.py

@@ -7,6 +7,7 @@ from zrb.context.any_context import AnyContext
 from zrb.input.str_input import StrInput
 from zrb.task.cmd_task import CmdTask
 from zrb.task.make_task import make_task
+from zrb.util.file import read_file, write_file
 
 install_tmux = CmdTask(
     name="install-tmux",
@@ -28,22 +29,16 @@ install_tmux = CmdTask(
     alias="tmux",
 )
 def setup_tmux(ctx: AnyContext):
-    with open(os.path.join(os.path.dirname(__file__), "tmux_config.sh"), "r") as f:
-        tmux_config_template = f.read()
+    tmux_config = read_file(os.path.join(os.path.dirname(__file__), "tmux_config.sh"))
     tmux_config_file = os.path.expanduser(ctx.input["tmux-config"])
-    tmux_config_dir = os.path.dirname(tmux_config_file)
     # Make sure config file exists
-    os.makedirs(tmux_config_dir, exist_ok=True)
     if not os.path.isfile(tmux_config_file):
-        with open(tmux_config_file, "w") as f:
-            f.write("")
-    with open(tmux_config_file, "r") as f:
-        # config file already contain the config
-        if tmux_config_template in f.read():
-            return
+        write_file(tmux_config_file, "")
+    content = read_file(tmux_config_file)
+    if tmux_config in content:
+        return
     # Write config
-    with open(tmux_config_file, "a") as f:
-        f.write(f"\n{tmux_config_template}\n")
+    write_file(tmux_config_file, [content, tmux_config, ""])
     ctx.print("Setup complete, restart your terminal to continue")