zrb 0.10.0__py3-none-any.whl → 0.11.2__py3-none-any.whl

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/frontend.py

@@ -1,55 +0,0 @@
-import os
-
-from zrb import CmdTask, Env, EnvFile, PathChecker, runner
-from zrb.builtin.group import project_group
-
-from ._config import (
-    APP_FRONTEND_BUILD_DIR,
-    APP_FRONTEND_DIR,
-    APP_TEMPLATE_ENV_FILE_NAME,
-    CURRENT_DIR,
-)
-
-###############################################################################
-# ⚙️ build-kebab-zrb-task-name-frontend
-###############################################################################
-
-build_snake_zrb_app_name_frontend = CmdTask(
-    icon="🚤",
-    name="build-kebab-zrb-app-name-frontend",
-    description="Build frontend for human readable zrb app name",
-    group=project_group,
-    cwd=APP_FRONTEND_DIR,
-    cmd_path=os.path.join(CURRENT_DIR, "cmd", "app-build-frontend.sh"),
-    checkers=[
-        PathChecker(
-            name="check-kebab-zrb-app-name-frontend-build", path=APP_FRONTEND_BUILD_DIR
-        )
-    ],
-    env_files=[
-        EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="ZRB_ENV_PREFIX"),
-    ],
-    envs=[Env(name="WATCH", os_name="", default="1")],
-)
-runner.register(build_snake_zrb_app_name_frontend)
-
-###############################################################################
-# ⚙️ build-kebab-zrb-task-name-frontend-once
-###############################################################################
-
-build_snake_zrb_app_name_frontend_once = CmdTask(
-    icon="🚤",
-    name="build-kebab-zrb-app-name-frontend_once",
-    description="Build frontend for human readable zrb app name",
-    cwd=APP_FRONTEND_DIR,
-    cmd_path=os.path.join(CURRENT_DIR, "cmd", "app-build-frontend.sh"),
-    checkers=[
-        PathChecker(
-            name="check-kebab-zrb-app-name-frontend-build", path=APP_FRONTEND_BUILD_DIR
-        )
-    ],
-    env_files=[
-        EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="ZRB_ENV_PREFIX"),
-    ],
-    envs=[Env(name="WATCH", os_name="", default="0")],
-)

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/image.py

@@ -1,58 +0,0 @@
-from zrb import BoolInput, DockerComposeTask, runner
-from zrb.builtin.group import project_group
-
-from ._config import RESOURCE_DIR
-from ._env import image_env
-from ._input import image_input, local_input
-
-###############################################################################
-# ⚙️ build-kebab-zrb-task-name-image
-###############################################################################
-
-build_snake_zrb_app_name_image = DockerComposeTask(
-    icon="🏭",
-    name="build-kebab-zrb-app-name-image",
-    description="Build human readable zrb app name image",
-    group=project_group,
-    inputs=[
-        local_input,
-        image_input,
-        BoolInput(
-            name="build-kebab-zrb-app-name-with-cache",
-            prompt="Build human readable zrb app name image with Cache",
-            default=True,
-        ),
-    ],
-    envs=[image_env],
-    should_execute="{{ input.local_snake_zrb_app_name}}",
-    cwd=RESOURCE_DIR,
-    compose_cmd="build",
-    compose_args=["kebab-zrb-app-name"],
-    compose_flags=[
-        "{{ '--no-cache' if not input.build_snake_zrb_app_name_with_cache else '' }}"
-    ],
-    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
-)
-runner.register(build_snake_zrb_app_name_image)
-
-###############################################################################
-# ⚙️ push-kebab-zrb-task-name-image
-###############################################################################
-
-push_snake_zrb_app_name_image = DockerComposeTask(
-    icon="📰",
-    name="push-kebab-zrb-app-name-image",
-    description="Push human readable zrb app name image",
-    group=project_group,
-    inputs=[
-        local_input,
-        image_input,
-    ],
-    envs=[image_env],
-    upstreams=[build_snake_zrb_app_name_image],
-    cwd=RESOURCE_DIR,
-    compose_cmd="push",
-    compose_args=["kebab-zrb-app-name"],
-    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
-)
-runner.register(push_snake_zrb_app_name_image)

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/load_test.py

@@ -1,78 +0,0 @@
-import os
-
-from zrb import BoolInput, CmdTask, EnvFile, IntInput, StrInput, runner
-from zrb.builtin.group import project_group
-
-from ._config import CURRENT_DIR, LOAD_TEST_DIR, LOAD_TEST_TEMPLATE_ENV_FILE_NAME
-
-###############################################################################
-# ⚙️ prepare-kebab-zrb-task-name-load-test
-###############################################################################
-
-prepare_snake_zrb_app_name_load_test = CmdTask(
-    icon="🚤",
-    name="prepare-kebab-zrb-app-name-load-test",
-    description="Prepare load test for human readable zrb app name",
-    group=project_group,
-    cwd=LOAD_TEST_DIR,
-    cmd_path=[
-        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
-        os.path.join(CURRENT_DIR, "cmd", "app-prepare-load-test.sh"),
-    ],
-)
-runner.register(prepare_snake_zrb_app_name_load_test)
-
-###############################################################################
-# ⚙️ load-test-kebab-zrb-task-name
-###############################################################################
-
-load_test_snake_zrb_app_name_load_test = CmdTask(
-    icon="🧪",
-    name="load-test-kebab-zrb-app-name",
-    description="Load test human readable zrb app name",
-    group=project_group,
-    upstreams=[prepare_snake_zrb_app_name_load_test],
-    inputs=[
-        BoolInput(
-            name="kebab-zrb-app-name-load-test-headless",
-            default=True,
-            description="Load test UI headless",
-            prompt="Load test UI headless (if True, there will be no UI)",
-        ),
-        IntInput(
-            name="kebab-zrb-app-name-load-test-port",
-            default=8089,
-            description="Load test UI web port",
-            prompt="Load test UI web port (Only works if headless is False)",
-        ),
-        IntInput(
-            name="kebab-zrb-app-name-load-test-users",
-            default=200,
-            description="Load test users",
-            prompt="Load test users",
-        ),
-        IntInput(
-            name="kebab-zrb-app-name-load-test-spawn-rate",
-            default=10,
-            description="Load test spawn rate",
-            prompt="Load test spawn rate",
-        ),
-        StrInput(
-            name="kebab-zrb-app-name-load-test-url",
-            default="http://localhost:zrbAppHttpPort",
-            description="Load test url",
-            prompt="Load test url",
-        ),
-    ],
-    cwd=LOAD_TEST_DIR,
-    env_files=[
-        EnvFile(
-            path=LOAD_TEST_TEMPLATE_ENV_FILE_NAME, prefix="LOAD_TEST_ZRB_ENV_PREFIX"
-        )
-    ],
-    cmd_path=[
-        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
-        os.path.join(CURRENT_DIR, "cmd", "app-load-test.sh"),
-    ],
-)
-runner.register(load_test_snake_zrb_app_name_load_test)

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/local.py

@@ -1,203 +0,0 @@
-import os
-
-from zrb import CmdTask, DockerComposeTask, Env, Task, runner
-from zrb.builtin.group import project_group
-
-from ._checker import (
-    app_local_checker,
-    kafka_outside_checker,
-    kafka_plaintext_checker,
-    pandaproxy_outside_checker,
-    pandaproxy_plaintext_checker,
-    rabbitmq_checker,
-    rabbitmq_management_checker,
-    redpanda_console_checker,
-)
-from ._config import APP_DIR, CURRENT_DIR, RESOURCE_DIR
-from ._env import app_enable_otel_env
-from ._env_file import app_env_file
-from ._get_start_microservices import get_start_microservices
-from ._helper import (
-    activate_support_compose_profile,
-    should_start_local_microservices,
-    should_start_local_monolith,
-    should_start_support_container,
-)
-from ._input import (
-    enable_monitoring_input,
-    host_input,
-    https_input,
-    image_input,
-    local_input,
-    run_mode_input,
-)
-from .container import compose_env_file, remove_snake_zrb_app_name_container
-from .frontend import build_snake_zrb_app_name_frontend
-
-###############################################################################
-# ⚙️ init-kebab-zrb-task-name-support-container
-###############################################################################
-
-init_snake_zrb_app_name_support_container = DockerComposeTask(
-    icon="🔥",
-    name="init-kebab-zrb-app-name-support-container",
-    inputs=[
-        local_input,
-        host_input,
-        image_input,
-    ],
-    should_execute=should_start_support_container,
-    upstreams=[remove_snake_zrb_app_name_container],
-    cwd=RESOURCE_DIR,
-    setup_cmd=activate_support_compose_profile,
-    compose_cmd="up",
-    compose_flags=["-d"],
-    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
-    env_files=[compose_env_file],
-)
-
-###############################################################################
-# ⚙️ start-kebab-zrb-task-name-support-container
-###############################################################################
-
-start_snake_zrb_app_name_support_container = DockerComposeTask(
-    icon="🐳",
-    name="start-kebab-zrb-app-name-support-container",
-    description="Start human readable zrb app name container",
-    inputs=[
-        local_input,
-        enable_monitoring_input,
-        host_input,
-        https_input,
-        image_input,
-    ],
-    should_execute=should_start_support_container,
-    upstreams=[init_snake_zrb_app_name_support_container],
-    cwd=RESOURCE_DIR,
-    setup_cmd=activate_support_compose_profile,
-    compose_cmd="logs",
-    compose_flags=["-f"],
-    compose_env_prefix="CONTAINER_ZRB_ENV_PREFIX",
-    env_files=[compose_env_file],
-    checkers=[
-        rabbitmq_checker,
-        rabbitmq_management_checker,
-        kafka_outside_checker,
-        kafka_plaintext_checker,
-        redpanda_console_checker,
-        pandaproxy_outside_checker,
-        pandaproxy_plaintext_checker,
-    ],
-)
-
-###############################################################################
-# ⚙️ prepare-kebab-zrb-task-name-backend
-###############################################################################
-
-prepare_snake_zrb_app_name_backend = CmdTask(
-    icon="🚤",
-    name="prepare-kebab-zrb-app-name-backend",
-    description="Prepare backend for human readable zrb app name",
-    group=project_group,
-    cwd=APP_DIR,
-    cmd_path=[
-        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
-        os.path.join(CURRENT_DIR, "cmd", "app-prepare-backend.sh"),
-    ],
-)
-runner.register(prepare_snake_zrb_app_name_backend)
-
-###############################################################################
-# ⚙️ start-monolith-kebab-zrb-task-name
-###############################################################################
-
-start_monolith_snake_zrb_app_name = CmdTask(
-    icon="🚤",
-    name="start-monolith-kebab-zrb-app-name",
-    inputs=[
-        local_input,
-        enable_monitoring_input,
-        run_mode_input,
-        host_input,
-        https_input,
-    ],
-    should_execute=should_start_local_monolith,
-    upstreams=[
-        start_snake_zrb_app_name_support_container,
-        build_snake_zrb_app_name_frontend,
-        prepare_snake_zrb_app_name_backend,
-    ],
-    cwd=APP_DIR,
-    env_files=[app_env_file],
-    envs=[app_enable_otel_env],
-    cmd_path=[
-        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
-        os.path.join(CURRENT_DIR, "cmd", "app-start.sh"),
-    ],
-    checkers=[
-        app_local_checker,
-    ],
-)
-
-###############################################################################
-# ⚙️ start-kebab-zrb-task-name-gateway
-###############################################################################
-
-start_snake_zrb_app_name_gateway = CmdTask(
-    icon="🚪",
-    name="start-kebab-zrb-app-name-gateway",
-    inputs=[
-        local_input,
-        enable_monitoring_input,
-        run_mode_input,
-        host_input,
-        https_input,
-    ],
-    should_execute=should_start_local_microservices,
-    upstreams=[
-        start_snake_zrb_app_name_support_container,
-        build_snake_zrb_app_name_frontend,
-        prepare_snake_zrb_app_name_backend,
-    ],
-    cwd=APP_DIR,
-    env_files=[
-        app_env_file,
-    ],
-    envs=[
-        Env(name="APP_DB_AUTO_MIGRATE", default="false", os_name=""),
-        Env(name="APP_ENABLE_EVENT_HANDLER", default="false", os_name=""),
-        Env(name="APP_ENABLE_RPC_SERVER", default="false", os_name=""),
-        app_enable_otel_env,
-    ],
-    cmd_path=[
-        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
-        os.path.join(CURRENT_DIR, "cmd", "app-start.sh"),
-    ],
-    checkers=[
-        app_local_checker,
-    ],
-)
-
-###############################################################################
-# ⚙️ start-kebab-zrb-task-name
-###############################################################################
-
-start_snake_zrb_app_name = Task(
-    icon="🚤",
-    name="start-kebab-zrb-app-name",
-    description="Start human readable zrb app name",
-    group=project_group,
-    upstreams=[
-        start_monolith_snake_zrb_app_name,
-        start_snake_zrb_app_name_gateway,
-        *get_start_microservices(
-            upstreams=[
-                start_snake_zrb_app_name_support_container,
-                build_snake_zrb_app_name_frontend,
-                prepare_snake_zrb_app_name_backend,
-            ]
-        ),
-    ],
-    run=lambda *args, **kwargs: kwargs.get("_task").print_out("🆗"),
-)
-runner.register(start_snake_zrb_app_name)

zrb/builtin/generator/fastapp/template/_automate/snake_zrb_app_name/test.py

@@ -1,63 +0,0 @@
-import os
-
-from zrb import CmdTask, Env, EnvFile, StrInput, python_task, runner
-from zrb.builtin.group import project_group
-
-from ._config import APP_TEMPLATE_ENV_FILE_NAME, CURRENT_DIR, RESOURCE_DIR
-from .frontend import build_snake_zrb_app_name_frontend_once
-from .local import prepare_snake_zrb_app_name_backend
-
-###############################################################################
-# ⚙️ remove-kebab-zrb-task-name-test-db
-###############################################################################
-
-
-@python_task(
-    icon="🧪",
-    name="remove-kebab-zrb-app-name-test-db",
-    group=project_group,
-    runner=runner,
-)
-def remove_snake_zrb_app_name_test_db(*args, **kwargs):
-    test_db_file_path = os.path.join(RESOURCE_DIR, "test.db")
-    if os.path.isfile(test_db_file_path):
-        os.remove(test_db_file_path)
-
-
-###############################################################################
-# ⚙️ test-kebab-zrb-task-name
-###############################################################################
-
-test_snake_zrb_app_name = CmdTask(
-    icon="🚤",
-    name="test-kebab-zrb-app-name",
-    group=project_group,
-    inputs=[
-        StrInput(
-            name="kebab-zrb-app-name-test",
-            description="Specific test case (i.e., test/file.py::test_name)",
-            prompt="Test (i.e., test/file.py::test_name)",
-            default="",
-        )
-    ],
-    upstreams=[
-        build_snake_zrb_app_name_frontend_once,
-        prepare_snake_zrb_app_name_backend,
-        remove_snake_zrb_app_name_test_db,
-    ],
-    cwd=RESOURCE_DIR,
-    env_files=[EnvFile(path=APP_TEMPLATE_ENV_FILE_NAME, prefix="TEST_ZRB_ENV_PREFIX")],
-    envs=[
-        Env(name="APP_BROKER_TYPE", os_name="TEST_APP_BROKER_TYPE", default="mock"),
-        Env(
-            name="APP_DB_CONNECTION",
-            os_name="TEST_APP_DB_CONNECTION",
-            default="sqlite:///test.db",
-        ),
-        Env(name="APP_AUTH_ADMIN_ACTIVE", os_name="", default="true"),
-        Env(name="APP", os_name="APP_ENABLE_OTEL", default="false"),
-    ],
-    cmd_path=os.path.join(CURRENT_DIR, "cmd", "app-test.sh"),
-    retry=0,
-)
-runner.register(test_snake_zrb_app_name)

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/README.md

@@ -1,225 +0,0 @@
-# PascalZrbAppName
-
-PascalZrbAppName is a modular monolith application built on top of [FastApi](https://fastapi.tiangolo.com/) and [Svelte Kit](https://kit.svelte.dev/).
-
-You can run PascalZrbAppName as a monolith or microservices.
-
-Running your application as a monolith is preferable during local development. Furthermore, monolith application is more maintainable than microservices.
-
-The purpose of PascalZrbAppName is to:
-
-- Give you a sensible default.
-- Give you a good experience while developing/testing things locally.
-- Assure you that your application is always ready to be deployed as microservices.
-
-You can learn more about PascalZrbAppName's modular monolith concept in our [documentation](docs/modular-monolith/README.md).
-
-# Run PascalZrbAppName as a monolith
-
-To run PascalZrbAppName as a monolith, you can invoke the following command:
-
-```bash
-zrb project start-kebab-zrb-app-name --kebab-zrb-app-name-run-mode monolith
-```
-
-You can also run PascalZrbAppName as a docker container by invoking the following command:
-
-```bash
-zrb project start-kebab-zrb-app-name-container --kebab-zrb-app-name-run-mode monolith
-```
-
-# Run PascalZrbAppName as a microservices
-
-To run PascalZrbAppName as a microservices, you can invoke the following command:
-
-```bash
-zrb project start-kebab-zrb-app-name --kebab-zrb-app-name-run-mode microservices
-```
-
-You can also run PascalZrbAppName as a docker container by invoking the following command:
-
-```bash
-zrb project start-kebab-zrb-app-name-container --kebab-zrb-app-name-run-mode microservices
-```
-
-# Accessing the web interface
-
-Once you start the application, you can visit [`http://localhost:zrbAppHttpPort`](http://localhost:zrbAppHttpPort) in your browser. By default, the application will run on port zrbAppHttpPort, but you can change the port by providing `ZRB_ENV_PREFIX_APP_PORT`.
-
-To log in as admin, you can use the following credential:
-
-- User: `root`
-- Password: `toor`
-
-You can change the default username and password by providing `ZRB_ENV_PREFIX_APP_AUTH_ADMIN_USERNAME` and `ZRB_ENV_PREFIX_APP_AUTH_ADMIN_PASSWORD`.
-
-Furthermore, you can also visit `http://localhost:zrbAppHttpPort/docs` to access the API specification.
-
-# Deploying to Kubernetes
-
-To deploy PascalZrbAppName to Kubernetes, you need to have [Pulumi](https://www.pulumi.com/) installed. You also need access to a container registry like [Docker Hub](https://hub.docker.com/) and to the Kubernetes cluster itself.
-
-The easiest way to set up Kubernetes on your local computer is by installing [Docker Desktop](https://www.docker.com/products/docker-desktop/). Once you installed Docker Desktop, you can go to `setting | Kubernetes` to enable your local Kubernetes cluster.
-
-Finally, you can invoke the following command:
-
-```bash
-# Deploy PascalZrbAppName to Kubernetes as a monolith
-zrb project deploy-kebab-zrb-app-name --kebab-zrb-app-name monolith
-
-# Deploy PascalZrbAppName to Kubernetes as a microservices
-zrb project deploy-kebab-zrb-app-name --kebab-zrb-app-name microservices
-```
-
-# Configuration
-
-You can see all available configurations on [`template.env`](src/template.env). If you need to override the configuration, you can provide environment variables with `ZRB_ENV_PREFIX_` prefix to the ones specified in the `template.env`.
-
-There are several configurations you need to know.
-
-Auth related config
-
-- `ZRB_ENV_PREFIX_APP_AUTH_ADMIN_ACTIVE`: determine whether there is an admin user or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_ADMIN_USERNAME`: Admin username
-    - default value: `root`
-- `ZRB_ENV_PREFIX_ADMIN_PASSWORD`: Admin password
-    - default value: `toor`
-- `ZRB_ENV_PREFIX_APP_PORT`: Application port
-    - default value: `zrbAppHttpPort`
-
-Messaging config:
-
-- `ZRB_ENV_PREFIX_APP_BROKER_TYPE`: Messaging platform to be used (i.e., `rabbitmq`, `kafka`, or `mock`)
-    - default value: `rabbitmq`
-
-Feature flags:
-
-- `ZRB_ENV_PREFIX_APP_ENABLE_EVENT_HANDLER`: Whether enable event handler or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_RPC_SERVER`: Whether enable RPC server or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_FRONTEND`: Whether enable Frontend or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_API`: Whether enable API or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_AUTH_MODULE`: Whether enable Auth module or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_LOG_MODULE`: Whether enable Log module or not
-    - default value: `true`
-- `ZRB_ENV_PREFIX_APP_ENABLE_<MODULE_NAME>_MODULE`: Whether enable `<MODULE_NAME>` module or not
-    - default value: `true`
-
-
-# Adding modules, entities, or fields
-
-There are CLI commands to help you add modules, entities, and fields into PascalZrbAppName.
-
-For simple CRUD, you won't need to code at all. Please see [Zrb tutorial](https://github.com/state-alchemists/zrb/blob/main/docs/tutorials/development-to-deployment-low-code.md) for more details.
-
-
-# Prerequisites
-
-Main prerequisites
-
-- Python 3.10 or higher
-- Pip
-- Venv
-- Node version 18 or higher
-- Npm
-
-If you want to run PascalZrbAppName on containers, you will also need `Docker` with the `Docker-compose` plugin.
-
-You will also need `Pulumi` if you want to deploy PascalZrbAppName into your Kubernetes cluster.
-
-# Directory Structure
-
-- `docker-compose.yml`: A multi-profile docker-compose file. This helps you to run your application as a monolith/microservices.
-- `all-module-disabled.env`: Feature flags to be used when you deactivate all modules.
-- `all-module-enabled.env`: Feature flags to be used when you activate all modules.
-- `deployment/`: Deployment directory. By default, we put deployment along with the source code to make it easier to maintain/manage. You can later move your deployments to another repository if you think you need to.
-    - `/helm-charts`: Helm charts for Rabbitmq, Redpanda, and Postgre.
-    - `__main__.py`: Main Pulumi script.
-    - `template.env`: Default configuration for deployment
-- `src/`: PascalZrbAppName source code, including backend and frontend.
-    - `Dockerfile`: Dockerfile to build PascalZrbAppName
-    - `template.env`: Default configuration to run PascalZrbAppName
-    - `requirements.txt`: Pip packages, list of PascalZrbAppName dependencies. If you need to use external libraries in PascalZrbAppName, make sure to list them here.
-    - `main.py`: PascalZrbAppName's application entry point. This module exposes an `app` object that will be picked up by Uvicorn.
-    - `config.py`: PascalZrbAppName's configuration loader.
-    - `migrate.py`: A script to perform database migration.
-    - `integration/`: Initialization of components you want to use in your application. Typically containing scripts to instantiate `app` objects, DB connections, Message bus connections, etc. This is where you create and connect components.
-    - `component/`: Interface and component class definitions.
-    - `frontend/`: Frontend source code
-        - `package.json`: NPM configuration for PascalZrbAppName frontend.
-        - `svelte.config.json`: Svelte configuration.
-        - `tailwind.config.json`: Tailwind configuration.
-        - `vite.config.ts`: Vite configuration.
-        - `src/`: PascalZrbAppName frontend source code.
-            - `lib/`: Frontend components and helpers.
-            - `routes/`: Frontend page definitions.
-        - `build/`: Frontend build result.
-        - `static/`: Static files like images, favicon, etc.
-    - `helper/`: Common helper scripts. Typically stateless.
-    - `schema/`: Common Pydantic schemas.
-    - `module/`: Module definition. Each module can be deployed as a microservice. Thus, modules should be isolated from each other.
-        - `<module_name>/`: Module resources.
-            - `api.py`: HTTP request handler for the current module.
-            - `event.py`: Event handler for the current module.
-            - `rpc.py`: RPC handler for the current module.
-            - `register_module.py`: A script to register the module to the main application.
-            - `migrate.py`: A script to perform migration for the current module.
-            - `integration/`: Initialization of components for the current module.
-                - `model/`
-                - `repo/`
-            - `component/`: Interface and component class definition for the current module.
-            - `entity/`: Entity related resources.
-                - `<entity_name>/`: Resources for current entity.
-                    - `api.py`
-                    - `rpc.py`
-                    - `model.py`
-                    - `repo.py`
-            - `schema/`: Pydantic schemas for the current module.
-- `test/`: Test scripts.
-    - `<modules-name>/`: Test scripts for modules.
-    - `test_*.py`: Core test scripts.
-
-
-# Decisions and Constraints
-
-## Frontend
-- PascalZrbAppName's Frontend is served as static files and is built before runtime (not SSR/Server Side Rendering). That's mean.
-    - The SEO is probably not good.
-    - The page load is sensibly good.
-- We use Svelte for Frontend because it is easier to read/learn compared to React, Vue, or Angular.
-- At the moment, the frontend use:
-    - Sveltekit
-    - TailwindCSS
-    - DaisyUI
-
-## Database
-
-- PascalZrbAppName uses SQLAlchemy to handle
-    - Database connection
-    - Database migration
-    - Data manipulation
-- To create a custom database implementation, you need to create an implementation that complies with `core.repo.Repo`.
-
-## Messaging
-
-- Currently, PascalZrbAppName supports some messaging platforms:
-    - Rabbitmq (default):
-        - `APP_BROKER_TYPE=rabbitmq`
-    - Kafka/Redpanda
-        - `APP_BROKER_TYPE=kafka`
-    - No messaging platform, a.k.a: in memory. This will only work properly if you run PascalZrbAppName as a monolith.
-        - `APP_BROKER_TYPE=mock`
-- To create custom event handlers, you need to implement two interfaces:
-    - `core.messagebus.Publisher`
-    - `core.messagebus.Server`
-
-## RPC
-
-- Currently, RPC implementation depends on the messaging platforms. It is possible to override this behavior by creating you custom implementation. There are two interfaces you need to override:
-    - `core.rpc.Caller`
-    - `core.rpc.Server`