zrb 1.0.0b1__py3-none-any.whl → 1.0.0b2__py3-none-any.whl

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/module/my_module/service/my_entity/repository/my_entity_repository_factory.py

@@ -1,4 +1,4 @@
-from my_app_name.common.db_engine import engine
+from my_app_name.common.db_engine_factory import db_engine
 from my_app_name.config import APP_REPOSITORY_TYPE
 from my_app_name.module.my_module.service.my_entity.repository.my_entity_db_repository import (
     MyEntityDBRepository,
@@ -8,6 +8,6 @@ from my_app_name.module.my_module.service.my_entity.repository.my_entity_reposit
 )
 
 if APP_REPOSITORY_TYPE == "db":
-    my_entity_repository: MyEntityRepository = MyEntityDBRepository(engine)
+    my_entity_repository: MyEntityRepository = MyEntityDBRepository(db_engine)
 else:
     my_entity_repository: MyEntityRepository = None

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/schema/my_entity.py

@@ -1,6 +1,7 @@
 import datetime
 
 import ulid
+from pydantic import BaseModel
 from sqlmodel import Field, SQLModel
 
 
@@ -9,7 +10,8 @@ class MyEntityBase(SQLModel):
 
 
 class MyEntityCreate(MyEntityBase):
-    pass
+    def with_audit(self, created_by: str) -> "MyEntityCreateWithAudit":
+        return MyEntityCreateWithAudit(**self.model_dump(), created_by=created_by)
 
 
 class MyEntityCreateWithAudit(MyEntityCreate):
@@ -19,6 +21,9 @@ class MyEntityCreateWithAudit(MyEntityCreate):
 class MyEntityUpdate(SQLModel):
     my_column: str | None = None
 
+    def with_audit(self, updated_by: str) -> "MyEntityUpdateWithAudit":
+        return MyEntityUpdateWithAudit(**self.model_dump(), updated_by=updated_by)
+
 
 class MyEntityUpdateWithAudit(MyEntityUpdate):
     updated_by: str
@@ -28,10 +33,15 @@ class MyEntityResponse(MyEntityBase):
     id: str
 
 
+class MultipleMyEntityResponse(BaseModel):
+    data: list[MyEntityResponse]
+    count: int
+
+
 class MyEntity(SQLModel, table=True):
     id: str = Field(default_factory=lambda: ulid.new().str, primary_key=True)
-    created_at: datetime.datetime
-    created_by: str
-    updated_at: datetime.datetime
-    updated_by: str
-    my_column: str
+    created_at: datetime.datetime = Field(index=True)
+    created_by: str = Field(index=True)
+    updated_at: datetime.datetime | None = Field(index=True)
+    updated_by: str | None = Field(index=True)
+    my_column: str = Field(index=True)

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/client_method.py

@@ -0,0 +1,57 @@
+# MyEntity related methods
+
+
+@abstractmethod
+async def get_my_entity_by_id(self, my_entity_id: str) -> MyEntityResponse:
+    """Get my entity by id"""
+
+
+@abstractmethod
+async def get_my_entities(
+    self,
+    page: int = 1,
+    page_size: int = 10,
+    sort: str | None = None,
+    filter: str | None = None,
+) -> MultipleMyEntityResponse:
+    """Get my entities by filter and sort"""
+
+
+@abstractmethod
+async def create_my_entity(self, data: MyEntityCreateWithAudit) -> MyEntityResponse:
+    """Create a new my entities"""
+
+
+@abstractmethod
+async def create_my_entity(
+    self, data: list[MyEntityCreateWithAudit]
+) -> list[MyEntityResponse]:
+    """Create new my entities"""
+
+
+@abstractmethod
+async def update_my_entity_bulk(
+    self, my_entity_ids: list[str], data: MyEntityUpdateWithAudit
+) -> MyEntityResponse:
+    """Update some my entities"""
+
+
+@abstractmethod
+async def update_my_entity(
+    self, my_entity_id: str, data: MyEntityUpdateWithAudit
+) -> MyEntityResponse:
+    """Update a my entity"""
+
+
+@abstractmethod
+async def delete_my_entity_bulk(
+    self, my_entity_ids: str, deleted_by: str
+) -> MyEntityResponse:
+    """Delete some my entities"""
+
+
+@abstractmethod
+async def delete_my_entity(
+    self, my_entity_id: str, deleted_by: str
+) -> MyEntityResponse:
+    """Delete a my entity"""

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/gateway_subroute.py

@@ -1,37 +1,72 @@
-@app.get("/api/v1/my_entities", response_model=list[MyEntityResponse])
-async def get_all_my_entities() -> MyEntityResponse:
-    return await my_module_client.get_all_my_entities()
+# MyEntity routes
 
 
-@app.get("/api/v1/my_entities/{my_entity_id}", response_model=MyEntityResponse)
+@app.get("/api/v1/my-entities", response_model=MultipleMyEntityResponse)
+async def get_my_entities(
+    page: int = 1,
+    page_size: int = 10,
+    sort: str | None = None,
+    filter: str | None = None,
+) -> MultipleMyEntityResponse:
+    return await my_module_client.get_my_entities(
+        page=page, page_size=page_size, sort=sort, filter=filter
+    )
+
+
+@app.get("/api/v1/my-entities/{my_entity_id}", response_model=MyEntityResponse)
 async def get_my_entity_by_id(my_entity_id: str) -> MyEntityResponse:
     return await my_module_client.get_my_entity_by_id(my_entity_id)
 
 
 @app.post(
-    "/api/v1/my_entities", response_model=MyEntityResponse | list[MyEntityResponse]
+    "/api/v1/my-entities/bulk",
+    response_model=list[MyEntityResponse],
+)
+async def create_my_entity_bulk(data: list[MyEntityCreate]):
+    return await my_module_client.create_my_entity_bulk(
+        [row.with_audit(created_by="system") for row in data]
+    )
+
+
+@app.post(
+    "/api/v1/my-entities",
+    response_model=MyEntityResponse,
+)
+async def create_my_entity(data: MyEntityCreate):
+    return await my_module_client.create_my_entity(data.with_audit(created_by="system"))
+
+
+@app.put(
+    "/api/v1/my-entities/bulk",
+    response_model=list[MyEntityResponse],
+)
+async def update_my_entity_bulk(my_entity_ids: list[str], data: MyEntityUpdate):
+    return await my_module_client.update_my_entity_bulk(
+        my_entity_ids, data.with_audit(updated_by="system")
+    )
+
+
+@app.put(
+    "/api/v1/my-entities/{my_entity_id}",
+    response_model=MyEntityResponse,
+)
+async def update_my_entity(my_entity_id: str, data: MyEntityUpdate):
+    return await my_module_client.update_my_entity(data.with_audit(updated_by="system"))
+
+
+@app.delete(
+    "/api/v1/my-entities/bulk",
+    response_model=list[MyEntityResponse],
+)
+async def delete_my_entity_bulk(my_entity_ids: list[str]):
+    return await my_module_client.delete_my_entity_bulk(
+        my_entity_ids, deleted_by="system"
+    )
+
+
+@app.delete(
+    "/api/v1/my-entities/{my_entity_id}",
+    response_model=MyEntityResponse,
 )
-async def create_my_entity(data: MyEntityCreate | list[MyEntityCreate]):
-    if isinstance(data, MyEntityCreate):
-        data_dict = data.model_dump(exclude_unset=True)
-        audited_data = MyEntityCreateWithAudit(**data_dict, created_by="system")
-        return await my_module_client.create_my_entity(audited_data)
-    audited_data = [
-        MyEntityCreateWithAudit(
-            **row.model_dump(exclude_unset=True), created_by="system"
-        )
-        for row in data
-    ]
-    return await my_module_client.create_my_entity(audited_data)
-
-
-@app.put("/api/v1/my_entities/{my_entity_id}", response_model=MyEntityResponse)
-async def update_my_entity(my_entity_id: str, data: MyEntityUpdate) -> MyEntityResponse:
-    data_dict = data.model_dump(exclude_unset=True)
-    audited_data = MyEntityUpdateWithAudit(**data_dict, updated_by="system")
-    return await my_module_client.update_my_entity(my_entity_id, audited_data)
-
-
-@app.delete("/api/v1/my_entities/{my_entity_id}", response_model=MyEntityResponse)
-async def delete_my_entity(my_entity_id: str) -> MyEntityResponse:
+async def delete_my_entity(my_entity_id: str):
     return await my_module_client.delete_my_entity(my_entity_id, deleted_by="system")

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/add_module_task.py

@@ -50,6 +50,7 @@ scaffold_my_app_name_module = Scaffolder(
             transform={
                 "MY_MODULE": "{to_snake_case(ctx.input.module).upper()}",
                 "my_module": "{to_snake_case(ctx.input.module)}",
+                "MyModule": "{to_pascal_case(ctx.input.module)}",
             },
         ),
         # Gateway's module subroute (my_app_name/module/gateway/subroute/snake_module_name.py)

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/app_template/module/my_module/client/my_module_api_client.py

@@ -0,0 +1,6 @@
+from my_app_name.config import APP_MY_MODULE_BASE_URL
+from my_app_name.module.my_module.client.my_module_client import MyModuleClient
+
+
+class MyModuleAPIClient(MyModuleClient):
+    pass

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/app_template/module/my_module/client/{any_client.py → my_module_client.py}

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 
 
-class AnyClient(ABC):
+class MyModuleClient(ABC):
     """
     Defining client methods
     """

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/app_template/module/my_module/client/my_module_client_factory.py

@@ -0,0 +1,11 @@
+from my_app_name.config import APP_COMMUNICATION
+from my_app_name.module.my_module.client.my_module_api_client import MyModuleAPIClient
+from my_app_name.module.my_module.client.my_module_client import MyModuleClient
+from my_app_name.module.my_module.client.my_module_direct_client import (
+    MyModuleDirectClient,
+)
+
+if APP_COMMUNICATION == "direct":
+    my_module_client: MyModuleClient = MyModuleDirectClient()
+elif APP_COMMUNICATION == "api":
+    my_module_client: MyModuleClient = MyModuleAPIClient()

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/app_template/module/my_module/client/my_module_direct_client.py

@@ -0,0 +1,5 @@
+from my_app_name.module.my_module.client.my_module_client import MyModuleClient
+
+
+class MyModuleDirectClient(MyModuleClient):
+    pass

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/app_template/module/my_module/route.py

@@ -1,5 +1,5 @@
 from fastapi import FastAPI
-from my_app_name.common.app import app
+from my_app_name.common.app_factory import app
 from my_app_name.common.schema import BasicResponse
 from my_app_name.config import APP_MAIN_MODULE, APP_MODE, APP_MODULES
 

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/module/template/module_task_definition.py

@@ -1,7 +1,7 @@
 # 🔐 Run/Migrate My Module ==========================================================
 
 run_my_module = app_run_group.add_task(
-    run_microservice("my-module", 3000, "my_module"), alias="microservices-my_module"
+    run_microservice("my-module", 3000, "my_module"), alias="svc-my_module"
 )
 prepare_venv >> run_my_module >> run_microservices
 
@@ -17,7 +17,7 @@ prepare_venv >> migrate_monolith_my_module >> [migrate_monolith, run_monolith]
 
 migrate_microservices_my_module = app_migrate_group.add_task(
     migrate_module("my-module", "my_module", as_microservices=True),
-    alias="microservices-my-module",
+    alias="svc-my-module",
 )
 (
     prepare_venv

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/task.py

@@ -100,7 +100,7 @@ migrate_microservices >> migrate_all
 # 📡 Run/Migrate Gateway =======================================================
 
 run_gateway = app_run_group.add_task(
-    run_microservice("gateway", 3001, "gateway"), alias="microservices-gateway"
+    run_microservice("gateway", 3001, "gateway"), alias="svc-gateway"
 )
 prepare_venv >> run_gateway >> run_microservices
 
@@ -114,14 +114,14 @@ prepare_venv >> migrate_monolith_gateway >> [migrate_monolith, run_monolith]
 
 migrate_microservices_gateway = app_migrate_group.add_task(
     migrate_module("gateway", "gateway", as_microservices=True),
-    alias="microservices-gateway",
+    alias="svc-gateway",
 )
 prepare_venv >> migrate_microservices_gateway >> [migrate_microservices, run_gateway]
 
 # 🔐 Run/Migrate Auth ==========================================================
 
 run_auth = app_run_group.add_task(
-    run_microservice("auth", 3002, "auth"), alias="microservices-auth"
+    run_microservice("auth", 3002, "auth"), alias="svc-auth"
 )
 prepare_venv >> run_auth >> run_microservices
 
@@ -134,6 +134,6 @@ migrate_monolith_auth = migrate_module("auth", "auth", as_microservices=False)
 prepare_venv >> migrate_monolith_auth >> [migrate_monolith, run_monolith]
 
 migrate_microservices_auth = app_migrate_group.add_task(
-    migrate_module("auth", "auth", as_microservices=True), alias="microservices-auth"
+    migrate_module("auth", "auth", as_microservices=True), alias="svc-auth"
 )
 prepare_venv >> migrate_microservices_auth >> [migrate_microservices, run_auth]

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/util.py

@@ -1,4 +1,5 @@
 import os
+import platform
 
 from my_app_name._zrb.config import (
     ACTIVATE_VENV_SCRIPT,
@@ -8,6 +9,7 @@ from my_app_name._zrb.config import (
 )
 
 from zrb import Cmd, CmdTask, EnvFile, EnvMap, StrInput, Task
+from zrb.util.string.conversion import double_quote, to_snake_case
 
 
 def create_migration(name: str, module: str) -> Task:
@@ -20,19 +22,13 @@ def create_migration(name: str, module: str) -> Task:
             prompt="Migration message",
             allow_empty=False,
         ),
-        env=[
-            EnvFile(path=os.path.join(APP_DIR, "template.env")),
-            EnvMap(
-                vars={
-                    "APP_DB_URL": f"sqlite:///{APP_DIR}/.migration.{module}.db",
-                    "MY_APP_NAME_MODULES": f"{module}",
-                }
-            ),
-        ],
+        env=EnvFile(path=os.path.join(APP_DIR, "template.env")),
         cwd=APP_DIR,
         cmd=[
             ACTIVATE_VENV_SCRIPT,
-            f"cd {os.path.join(APP_DIR, 'module', module)}",
+            set_create_migration_db_url_env(module),
+            set_module_env(module),
+            cd_module_script(module),
             "alembic upgrade head",
             Cmd(
                 "alembic revision --autogenerate -m {double_quote(ctx.input.message)}",
@@ -45,7 +41,11 @@ def create_migration(name: str, module: str) -> Task:
 
 
 def migrate_module(name: str, module: str, as_microservices: bool) -> Task:
-    env_vars = MICROSERVICES_ENV_VARS if as_microservices else MONOLITH_ENV_VARS
+    env_vars = (
+        dict(MICROSERVICES_ENV_VARS) if as_microservices else dict(MONOLITH_ENV_VARS)
+    )
+    if as_microservices:
+        env_vars["MY_APP_NAME_MODULES"] = to_snake_case(module)
     return CmdTask(
         name=(
             f"migrate-my-app-name-{name}"
@@ -55,17 +55,12 @@ def migrate_module(name: str, module: str, as_microservices: bool) -> Task:
         description=f"🧩 Run My App Name {name.capitalize()} DB migration",
         env=[
             EnvFile(path=os.path.join(APP_DIR, "template.env")),
-            EnvMap(
-                vars={
-                    **env_vars,
-                    "MY_APP_NAME_MODULES": f"{module}",
-                }
-            ),
+            EnvMap(vars=env_vars),
         ],
         cwd=APP_DIR,
         cmd=[
             ACTIVATE_VENV_SCRIPT,
-            f"cd {os.path.join(APP_DIR, 'module', module)}",
+            cd_module_script(module),
             "alembic upgrade head",
         ],
         render_cmd=False,
@@ -82,14 +77,14 @@ def run_microservice(name: str, port: int, module: str) -> Task:
             EnvMap(
                 vars={
                     **MICROSERVICES_ENV_VARS,
-                    "MY_APP_NAME_PORT": f"{port}",
-                    "MY_APP_NAME_MODULES": f"{module}",
                 }
             ),
         ],
         cwd=APP_DIR,
         cmd=[
             ACTIVATE_VENV_SCRIPT,
+            set_env("MY_APP_NAME_MODULES", module),
+            set_env("MY_APP_NAME_PORT", f"{port}"),
             'fastapi dev main.py --port "${MY_APP_NAME_PORT}"',
         ],
         render_cmd=False,
@@ -109,3 +104,35 @@ def get_existing_schema_names() -> list[str]:
         for entry in os.scandir(module_dir_path)
         if entry.is_file() and entry.name.endswith(".py")
     ]
+
+
+def set_create_migration_db_url_env(module_name: str) -> str:
+    return set_env(
+        "MY_APP_NAME_DB_URL",
+        f"sqlite:///{APP_DIR}/.migration.{to_snake_case(module_name)}.db",
+    )
+
+
+def set_module_env(module_name: str) -> str:
+    return (set_env("MY_APP_NAME_MODULES", to_snake_case(module_name)),)
+
+
+def cd_module_script(module_name: str) -> str:
+    module_dir_path = os.path.join(APP_DIR, "module", to_snake_case(module_name))
+    return f"cd {module_dir_path}"
+
+
+def set_env(var_name: str, var_value: str) -> str:
+    """
+    Generates a script to set an environment variable depending on the OS.
+    :param var_name: Name of the environment variable.
+    :param var_value: Value of the environment variable.
+    :return: A string containing the appropriate script.
+    """
+    if platform.system() == "Windows":
+        # PowerShell script for Windows
+        script = f'[Environment]::SetEnvironmentVariable({double_quote(var_name)}, {double_quote(var_value)}, "User")'  # noqa
+    else:
+        # Bash script for Unix-like systems
+        script = f"export {var_name}={double_quote(var_value)}"
+    return script

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/common/app_factory.py

@@ -0,0 +1,29 @@
+import os
+
+from fastapi import FastAPI
+from my_app_name.common.db_engine_factory import db_engine
+from my_app_name.common.util.app import (
+    create_default_app_lifespan,
+    get_default_app_title,
+    serve_docs,
+    serve_static_dir,
+)
+from my_app_name.config import (
+    APP_GATEWAY_FAVICON_PATH,
+    APP_GATEWAY_TITLE,
+    APP_GATEWAY_VIEW_PATH,
+    APP_MODE,
+    APP_MODULES,
+    APP_VERSION,
+)
+
+app_title = get_default_app_title(APP_GATEWAY_TITLE, mode=APP_MODE, modules=APP_MODULES)
+app = FastAPI(
+    title=app_title,
+    version=APP_VERSION,
+    lifespan=create_default_app_lifespan(db_engine),
+    docs_url=None,
+)
+
+serve_static_dir(app, os.path.join(APP_GATEWAY_VIEW_PATH, "static"))
+serve_docs(app, app_title=app_title, favicon_url=APP_GATEWAY_FAVICON_PATH)