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

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

@@ -0,0 +1,74 @@
+# MyEntity routes
+
+
+@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/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(
+        my_entity_id, 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 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/format_task.py

@@ -6,7 +6,7 @@ from zrb.task.cmd_task import CmdTask
 format_my_app_name_code = app_group.add_task(
     CmdTask(
         name="format-my-app-name-code",
-        description="✏️ Format Python code",
+        description="✨ Format Python code",
         cmd=[
             "isort . --profile black --force-grid-wrap 0",
             "black .",

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

@@ -38,3 +38,16 @@ new_entity_column_input = StrInput(
     prompt="New entity's column name",
     default_str="name",
 )
+
+new_column_input = StrInput(
+    name="column",
+    description="Column name",
+    prompt="New column name",
+)
+
+new_column_type_input = OptionInput(
+    name="type",
+    description="Column type",
+    prompt="Column type",
+    options=["str", "int", "float", "bool", "datetime", "date"],
+)

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

@@ -9,11 +9,14 @@ from my_app_name._zrb.module.add_module_util import (
     is_app_main_file,
     is_app_zrb_config_file,
     is_app_zrb_task_file,
+    is_gateway_module_subroute_file,
+    is_gateway_route_file,
     is_in_module_dir,
     update_app_config_file,
     update_app_main_file,
     update_app_zrb_config_file,
     update_app_zrb_task_file,
+    update_gateway_route_file,
 )
 from my_app_name._zrb.util import get_existing_module_names
 
@@ -42,32 +45,52 @@ scaffold_my_app_name_module = Scaffolder(
     transform_content=[
         # Common transformation (my_app_name/module/snake_module_name)
         ContentTransformer(
+            name="transform-module-dir",
             match=is_in_module_dir,
             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)
+        ContentTransformer(
+            name="transform-gateway-subroute",
+            match=is_gateway_module_subroute_file,
+            transform={
+                "my_module": "{to_snake_case(ctx.input.module)}",
             },
         ),
         # Register module config to my_app_name/config.py
         ContentTransformer(
+            name="transform-app-config",
             match=is_app_config_file,
             transform=update_app_config_file,
         ),
         # Register module route to my_app_name/main.py
         ContentTransformer(
+            name="transform-app-main",
             match=is_app_main_file,
             transform=update_app_main_file,
         ),
         # Register module's tasks to my_app_name/_zrb/task.py
         ContentTransformer(
+            name="transform-zrb-task",
             match=is_app_zrb_task_file,
             transform=update_app_zrb_task_file,
         ),
         # Register module's base url to my_app_name/_zrb/config.py
         ContentTransformer(
+            name="transform-zrb-config",
             match=is_app_zrb_config_file,
             transform=update_app_zrb_config_file,
         ),
+        # Register module's subroute to my_app_name/gateway/route.py
+        ContentTransformer(
+            name="transform-gateway-route",
+            match=is_gateway_route_file,
+            transform=update_gateway_route_file,
+        ),
     ],
     retries=0,
     upstream=validate_create_my_app_name_module,

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

@@ -4,6 +4,7 @@ from my_app_name._zrb.config import APP_DIR
 from my_app_name._zrb.util import get_existing_module_names
 
 from zrb.context.any_context import AnyContext
+from zrb.util.codemod.append_code_to_function import append_code_to_function
 from zrb.util.codemod.append_key_to_dict import append_key_to_dict
 from zrb.util.file import read_file, write_file
 from zrb.util.string.conversion import to_kebab_case, to_pascal_case, to_snake_case
@@ -17,6 +18,10 @@ def is_app_main_file(ctx: AnyContext, file_path: str) -> bool:
     return file_path == os.path.join(APP_DIR, "main.py")
 
 
+def is_gateway_route_file(ctx: AnyContext, file_path: str) -> bool:
+    return file_path == os.path.join(APP_DIR, "module", "gateway", "route.py")
+
+
 def is_app_zrb_task_file(ctx: AnyContext, file_path: str) -> bool:
     return file_path == os.path.join(APP_DIR, "_zrb", "task.py")
 
@@ -31,6 +36,13 @@ def is_in_module_dir(ctx: AnyContext, file_path: str) -> bool:
     )
 
 
+def is_gateway_module_subroute_file(ctx: AnyContext, file_path: str) -> bool:
+    module_subroute_file_name = f"{to_snake_case(ctx.input.module)}.py"
+    return file_path == os.path.join(
+        APP_DIR, "module", "gateway", "subroute", module_subroute_file_name
+    )
+
+
 def update_app_zrb_config_file(ctx: AnyContext, zrb_config_file_path: str):
     existing_zrb_config_code = read_file(zrb_config_file_path)
     module_name = ctx.input.module
@@ -152,3 +164,33 @@ def _get_new_module_config_code(existing_code: str, module_name: str) -> str | N
     if config_code in existing_code:
         return None
     return config_code
+
+
+def update_gateway_route_file(ctx: AnyContext, gateway_route_file_path: str):
+    existing_gateway_route_code = read_file(gateway_route_file_path)
+    snake_module_name = to_snake_case(ctx.input.module)
+    write_file(
+        file_path=gateway_route_file_path,
+        content=[
+            _get_module_subroute_import(existing_gateway_route_code, ctx.input.module),
+            append_code_to_function(
+                original_code=existing_gateway_route_code,
+                function_name="serve_route",
+                new_code="\n".join(
+                    [
+                        f"# Serve {snake_module_name} route",
+                        f"serve_{snake_module_name}_route(app)",
+                    ]
+                ),
+            ),
+        ],
+    )
+
+
+def _get_module_subroute_import(existing_code: str, module_name: str) -> str | None:
+    snake_module_name = to_snake_case(module_name)
+    import_module_path = f"my_app_name.module.gateway.subroute.{snake_module_name}"
+    import_code = f"from {import_module_path} import serve_{snake_module_name}_route"
+    if import_code in existing_code:
+        return None
+    return import_code

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

@@ -0,0 +1,7 @@
+from fastapi import FastAPI
+
+
+def serve_my_module_route(app: FastAPI):
+    """
+    Serving routes for my_module
+    """

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,10 +1,18 @@
 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
 
 
-def serve_health_check(app: FastAPI):
+def serve_route(app: FastAPI):
+    if APP_MODE != "microservices" or "my_module" not in APP_MODULES:
+        return
+    if APP_MAIN_MODULE == "my_module":
+        _serve_health_check(app)
+        _serve_readiness_check(app)
+
+
+def _serve_health_check(app: FastAPI):
     @app.api_route("/health", methods=["GET", "HEAD"], response_model=BasicResponse)
     async def health():
         """
@@ -13,7 +21,7 @@ def serve_health_check(app: FastAPI):
         return BasicResponse(message="ok")
 
 
-def serve_readiness_check(app: FastAPI):
+def _serve_readiness_check(app: FastAPI):
     @app.api_route("/readiness", methods=["GET", "HEAD"], response_model=BasicResponse)
     async def readiness():
         """
@@ -22,12 +30,4 @@ def serve_readiness_check(app: FastAPI):
         return BasicResponse(message="ok")
 
 
-def serve_route(app: FastAPI):
-    if APP_MODE != "microservices" or "my_module" not in APP_MODULES:
-        return
-    if APP_MAIN_MODULE == "my_module":
-        serve_health_check(app)
-        serve_readiness_check(app)
-
-
 serve_route(app)

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

@@ -1,7 +1,7 @@
 import os
 
-from my_app_name._zrb.column.create_column_task import add_my_app_name_column
-from my_app_name._zrb.config import ACTIVATE_VENV_SCRIPT, APP_DIR
+from my_app_name._zrb.column.add_column_task import add_my_app_name_column
+from my_app_name._zrb.config import ACTIVATE_VENV_SCRIPT, APP_DIR, MONOLITH_ENV_VARS
 from my_app_name._zrb.entity.add_entity_task import add_my_app_name_entity
 from my_app_name._zrb.format_task import format_my_app_name_code
 from my_app_name._zrb.group import (
@@ -13,7 +13,7 @@ from my_app_name._zrb.module.add_module_task import add_my_app_name_module
 from my_app_name._zrb.util import create_migration, migrate_module, run_microservice
 from my_app_name._zrb.venv_task import prepare_venv
 
-from zrb import CmdTask, Env, EnvFile, Task
+from zrb import CmdTask, EnvFile, EnvMap, Task
 
 assert add_my_app_name_entity
 assert add_my_app_name_module
@@ -54,7 +54,7 @@ run_monolith = app_run_group.add_task(
         description="🗿 Run My App Name as a monolith",
         env=[
             EnvFile(path=os.path.join(APP_DIR, "template.env")),
-            Env(name="MY_APP_NAME_MODE", default="monolith"),
+            EnvMap(vars=MONOLITH_ENV_VARS),
         ],
         cwd=APP_DIR,
         cmd=[
@@ -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)