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

zrb/builtin/generator/fastapp/template/src/kebab-zrb-app-name/deployment/helm-charts/signoz/charts/k8s-infra/.helmignore

@@ -1,23 +0,0 @@
-# Patterns to ignore when building packages.
-# This supports shell glob matching, relative path matching, and
-# negation (prefixed with !). Only one pattern per line.
-.DS_Store
-# Common VCS dirs
-.git/
-.gitignore
-.bzr/
-.bzrignore
-.hg/
-.hgignore
-.svn/
-# Common backup files
-*.swp
-*.bak
-*.tmp
-*.orig
-*~
-# Various IDEs
-.project
-.idea/
-*.tmproj
-.vscode/

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

@@ -1,120 +0,0 @@
-🔖 [Table of Contents](../README.md)
-
-# Modular Monolith
-
-PascalZrbAppName has several features that you can activate/deactivate using environment variables. It also has some communication patterns like API, RPC, or Event.
-
-![Modular monolith](images/fastapp.png)
-
-## Frontend, API, Event, and RPC
-
-First, you have Frontend and API.
-
-Frontend is intended to be accessed by users. It has buttons, links, and a nice user interface. This user interface usually needs to access API endpoints to translate user action into server requests.
-
-Aside from the Frontend, the API endpoints are also accessible by external systems. You might have third-party client apps, webhook, or even IOT devices.
-
-In PascalZrbAppName, most API requests will be translated into events/RPC calls. The difference between events and RPC calls is as follows:
-
-- Event
-    - Once an event is fired, event handlers will pick up the message.
-    - PascalZrbAppName will not wait for the process to be completed. It just fires the event, lets the event handler handles the message, and continues with other processes.
-    - You usually use events if you don't need an immediate response. For example:
-        - You train a machine learning model. The process can take hours or even days. You just want to trigger the training, and you don't need immediate results. Once the training has been completed, you can let the event handler send a notification email to the user.
-        - You deal with warehouse fulfillment progress. The fulfillment might take a very long time, you can't make sure that the user will get immediate feedback.
-- RPC (Remote procedure call)
-    - Once an RPC call is fired, RPC Server will pick up the message.
-    - PascalZrbAppName will wait for the RPC Server to return the result before continuing with other processes.
-    - You usually use RPC calls if you need an immediate response. For example:
-        - You want to fetch user data from the database. You can't give any HTTP Response before you get the result from the database
-        - You want to update a product description. You can only return HTTP Response to the user once the process is completed (or failed).
-
-## Feature flags
-
-The following are some feature flags to activate/deactivate the features:
-
-- Frontend:
-    - `ZRB_ENV_PREFIX_APP_ENABLE_FRONTEND=true`
-- API:
-    - `ZRB_ENV_PREFIX_APP_ENABLE_API=true`
-- RPC Caller/Event Publisher: This feature is always activated
-- Auth module:
-    - Auth API:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_AUTH_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_API=true`
-    - Auth RPC Server:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_AUTH_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_RPC_SERVER=true`
-    - Auth Event Handler:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_AUTH_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_EVENT_HANDLER=true`
-- Log module:
-    - Log API:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_LOG_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_API=true`
-    - Log RPC Server:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_LOG_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_RPC_SERVER=true`
-    - Log Event Handler:
-        - `ZRB_ENV_PREFIX_APP_ENABLE_LOG_MODULE=true`
-        - `ZRB_ENV_PREFIX_APP_ENABLE_EVENT_HANDLER=true`
-
-By activating/deactivating the feature flags, you can control PascalZrbAppName's communication pattern. You can make it respond to all API requests, events, and RPC calls. Or you can make it respond to API requests but ignores RPC/Event calls.
-
-
-# PascalZrbAppName as a monolith
-
-PascalZrbAppName will behave like a monolith if you activate all the features.
-
-![Monolith](images/fastapp-monolith.png)
-
-A Monolith handles everything. Compared to microservices, a monolith is easier to maintain/deploy.
-
-If you only have a single developer team, a monolith is much preferable.
-
-However, since everything run in a single application, a problem in any component can affect the whole system. For example, if your Auth RPC Server takes up a lot of CPU usage, you might not be able to handle the event log.
-
-Scaling a monolith application might also be challenging. The easiest way to scale up a monolith application is by using a more resourceful (and expensive) server. This probably won't be a good idea if your application receives spike requests once in a while. You will have to pay for the highest capacity all the time.
-
-# PascalZrbAppName as a microservices
-
-You can spawn multiple PascalZrbAppName, each with different configurations. By doing so, you can have a distributed architecture where some of your applications are deployed on cheaper Virtual Machines (like [Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html)).
-
-Furthermore, you can spawn more services if you encounter spiked requests. For example, there is a flash sale and you only need to spawn more services to handle sales orders. Once the flash sale ended, you can scale down your services.
-
-![Microservices](images/fastapp-microservices.png)
-
-Microservices are more difficult to deploy/maintain since you have multiple instances of your services.
-
-You will likely need different teams to handle each service.
-
-# Run PascalZrbAppName as a Monolith or Microservices
-
-By using [Zrb](https://pypi.org/project/zrb), you will be able to run PascalZrbAppName as either a Monolith or Microservices. You don't need to set the feature flags manually.
-
-```bash
-# Run PascalZrbAppName as a monolith
-zrb project start-kebab-zrb-app-name --kebab-zrb-app-name-run-mode monolith
-
-# Run PascalZrbAppName as a monolith inside a container
-zrb project start-kebab-zrb-app-name-container --kebab-zrb-app-name-run-mode monolith
-
-# Run PascalZrbAppName as microservices
-zrb project start-kebab-zrb-app-name --kebab-zrb-app-name-run-mode microservices
-
-# Run PascalZrbAppName as microservices inside containers
-zrb project start-kebab-zrb-app-name-container --kebab-zrb-app-name-run-mode microservices
-
-# 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
-```
-
-Hopefully this will make your development/deployment process easier.
-
-You can run your application as a monolith in your local computer, and deploy it as microservices later.
-
-
-🔖 [Table of Contents](../README.md)

zrb/builtin/generator/fastapp_crud/add.py

@@ -1,154 +0,0 @@
-import asyncio
-import os
-
-from zrb.builtin.generator.common.helper import validate_existing_project_dir
-from zrb.builtin.generator.common.task_input import (
-    app_name_input,
-    entity_name_input,
-    main_column_name_input,
-    module_name_input,
-    plural_entity_name_input,
-    project_dir_input,
-)
-from zrb.builtin.generator.fastapp_crud.helper import (
-    register_api,
-    register_permission,
-    register_rpc,
-)
-from zrb.builtin.generator.fastapp_crud.task_factory import create_add_navigation_task
-from zrb.builtin.group import project_add_group
-from zrb.helper import util
-from zrb.helper.typing import Any
-from zrb.runner import runner
-from zrb.task.cmd_task import CmdTask
-from zrb.task.decorator import python_task
-from zrb.task.resource_maker import ResourceMaker
-from zrb.task.task import Task
-
-CURRENT_DIR = os.path.dirname(__file__)
-CODEMOD_DIR = os.path.join(CURRENT_DIR, "nodejs", "codemod")
-
-###############################################################################
-# Task Definitions
-###############################################################################
-
-
-@python_task(
-    name="validate",
-    inputs=[project_dir_input, app_name_input, module_name_input, entity_name_input],
-)
-async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get("project_dir")
-    validate_existing_project_dir(project_dir)
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    entity_name = kwargs.get("entity_name")
-    snake_module_name = util.to_snake_case(module_name)
-    snake_entity_name = util.to_snake_case(entity_name)
-    automation_dir = os.path.join(
-        project_dir, "_automate", util.to_snake_case(app_name)
-    )
-    if not os.path.exists(automation_dir):
-        raise Exception(f"Automation directory does not exist: {automation_dir}")
-    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
-    if not os.path.exists(app_dir):
-        raise Exception(f"App directory does not exist: {app_dir}")
-    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
-    if not os.path.exists(module_path):
-        raise Exception(f"Module directory does not exist: {module_path}")
-    entity_path = os.path.join(module_path, "entity", snake_entity_name)
-    if os.path.exists(entity_path):
-        raise Exception(f"Entity directory already exists: {entity_path}")
-
-
-copy_resource = ResourceMaker(
-    name="copy-resource",
-    inputs=[
-        project_dir_input,
-        app_name_input,
-        module_name_input,
-        entity_name_input,
-        plural_entity_name_input,
-        main_column_name_input,
-    ],
-    upstreams=[validate],
-    replacements={
-        "zrbAppName": "{{input.app_name}}",
-        "zrbModuleName": "{{input.module_name}}",
-        "zrbEntityName": "{{input.entity_name}}",
-        "zrbPluralEntityName": "{{input.plural_entity_name}}",
-        "zrbColumnName": "{{input.column_name}}",
-    },
-    template_path=os.path.join(CURRENT_DIR, "template"),
-    destination_path="{{ input.project_dir }}",
-    excludes=[
-        "*/__pycache__",
-    ],
-)
-
-
-@python_task(
-    name="register-crud",
-    inputs=[
-        project_dir_input,
-        app_name_input,
-        module_name_input,
-        entity_name_input,
-        plural_entity_name_input,
-        main_column_name_input,
-    ],
-    upstreams=[
-        copy_resource,
-    ],
-)
-async def register_crud(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get("_task")
-    project_dir = kwargs.get("project_dir", ".")
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    entity_name = kwargs.get("entity_name")
-    kebab_app_name = util.to_kebab_case(app_name)
-    snake_module_name = util.to_snake_case(module_name)
-    snake_entity_name = util.to_snake_case(entity_name)
-    await asyncio.gather(
-        asyncio.create_task(
-            register_api(
-                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
-            )
-        ),
-        asyncio.create_task(
-            register_rpc(
-                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
-            )
-        ),
-        asyncio.create_task(
-            register_permission(
-                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
-            )
-        ),
-    )
-
-
-prepare_codemod = CmdTask(
-    name="prepare-codemod",
-    cwd=CODEMOD_DIR,
-    cmd=["npm install --save-dev", "node_modules/.bin/tsc"],
-)
-
-add_navigation = create_add_navigation_task(
-    upstreams=[
-        copy_resource,
-        prepare_codemod,
-    ]
-)
-
-
-@python_task(
-    name="fastapp-crud",
-    group=project_add_group,
-    upstreams=[register_crud, add_navigation],
-    runner=runner,
-)
-async def add_fastapp_crud(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get("_task")
-    task.print_out("Success")

zrb/builtin/generator/fastapp_crud/task_factory.py

@@ -1,37 +0,0 @@
-import os
-
-from zrb.builtin.generator.common.task_input import (
-    app_name_input,
-    entity_name_input,
-    module_name_input,
-    project_dir_input,
-)
-from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import List
-from zrb.task.any_task import AnyTask
-from zrb.task.cmd_task import CmdTask
-
-CURRENT_DIR = os.path.dirname(__file__)
-CODEMOD_DIR = os.path.join(CURRENT_DIR, "nodejs", "codemod")
-
-NAV_CONFIG_FILE_PATH = "{{input.project_dir}}/src/{{util.to_kebab_case(input.app_name)}}/src/frontend/src/lib/config/navData.ts"  # noqa
-ENV_VAR_NAME = "navData"
-NAV_TITLE = "{{util.to_pascal_case(input.entity_name)}}"
-NAV_URL = "/{{util.to_kebab_case(input.module_name)}}/{{util.to_kebab_case(input.entity_name)}}"  # noqa
-NAV_PERMISSION = "{{util.to_snake_case(input.module_name)}}:{{util.to_snake_case(input.entity_name)}}:get"  # noqa
-
-
-@typechecked
-def create_add_navigation_task(upstreams: List[AnyTask]) -> AnyTask:
-    return CmdTask(
-        name="add-navigation",
-        inputs=[
-            project_dir_input,
-            app_name_input,
-            module_name_input,
-            entity_name_input,
-        ],
-        upstreams=upstreams,
-        retry=0,
-        cmd=f'node {CODEMOD_DIR}/dist/addNav.js "{NAV_CONFIG_FILE_PATH}" "{ENV_VAR_NAME}" "{NAV_TITLE}" "{NAV_URL}" "{NAV_PERMISSION}"',  # noqa
-    )

zrb/builtin/generator/fastapp_field/add.py

@@ -1,196 +0,0 @@
-import asyncio
-import os
-
-from zrb.builtin.generator.common.helper import validate_existing_project_dir
-from zrb.builtin.generator.common.task_input import (
-    app_name_input,
-    column_name_input,
-    column_type_input,
-    entity_name_input,
-    module_name_input,
-    project_dir_input,
-)
-from zrb.builtin.generator.fastapp_field.helper import (
-    add_column_to_delete_page,
-    add_column_to_detail_page,
-    add_column_to_insert_page,
-    add_column_to_list_page,
-    add_column_to_repo,
-    add_column_to_schema,
-    add_column_to_test,
-    add_column_to_update_page,
-)
-from zrb.builtin.group import project_add_group
-from zrb.helper import util
-from zrb.helper.typing import Any
-from zrb.runner import runner
-from zrb.task.decorator import python_task
-from zrb.task.task import Task
-
-CURRENT_DIR = os.path.dirname(__file__)
-
-###############################################################################
-# Task Definitions
-###############################################################################
-
-
-@python_task(
-    name="validate",
-    inputs=[project_dir_input, app_name_input, module_name_input, entity_name_input],
-)
-async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get("project_dir")
-    validate_existing_project_dir(project_dir)
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    entity_name = kwargs.get("entity_name")
-    snake_module_name = util.to_snake_case(module_name)
-    snake_entity_name = util.to_snake_case(entity_name)
-    automation_dir = os.path.join(
-        project_dir, "_automate", util.to_snake_case(app_name)
-    )
-    if not os.path.exists(automation_dir):
-        raise Exception(f"Automation directory does not exist: {automation_dir}")
-    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
-    if not os.path.exists(app_dir):
-        raise Exception(f"App directory does not exist: {app_dir}")
-    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
-    if not os.path.exists(module_path):
-        raise Exception(f"Module directory does not exist: {module_path}")
-    entity_path = os.path.join(module_path, "entity", snake_entity_name)
-    if not os.path.exists(entity_path):
-        raise Exception(f"Entity directory does not exist: {entity_path}")
-
-
-@python_task(
-    name="fastapp-field",
-    group=project_add_group,
-    inputs=[
-        project_dir_input,
-        app_name_input,
-        module_name_input,
-        entity_name_input,
-        column_name_input,
-        column_type_input,
-    ],
-    upstreams=[
-        validate,
-    ],
-    runner=runner,
-)
-async def add_fastapp_field(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get("_task")
-    project_dir = kwargs.get("project_dir", ".")
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    entity_name = kwargs.get("entity_name")
-    column_name = kwargs.get("column_name")
-    column_type = kwargs.get("column_name")
-    kebab_app_name = util.to_kebab_case(app_name)
-    kebab_module_name = util.to_kebab_case(module_name)
-    snake_module_name = util.to_snake_case(module_name)
-    kebab_entity_name = util.to_kebab_case(entity_name)
-    snake_entity_name = util.to_snake_case(entity_name)
-    pascal_entity_name = util.to_pascal_case(entity_name)
-    snake_column_name = util.to_snake_case(column_name)
-    kebab_column_name = util.to_kebab_case(column_name)
-    capitalized_human_readable_column_name = util.to_capitalized_human_readable(  # noqa
-        column_name
-    )
-    await asyncio.gather(
-        asyncio.create_task(
-            add_column_to_test(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_module_name,
-                snake_entity_name,
-                snake_column_name,
-                column_type,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_schema(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_module_name,
-                snake_entity_name,
-                pascal_entity_name,
-                snake_column_name,
-                column_type,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_repo(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_module_name,
-                snake_entity_name,
-                pascal_entity_name,
-                snake_column_name,
-                column_type,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_list_page(
-                task,
-                project_dir,
-                kebab_app_name,
-                kebab_module_name,
-                kebab_entity_name,
-                snake_column_name,
-                capitalized_human_readable_column_name,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_detail_page(
-                task,
-                project_dir,
-                kebab_app_name,
-                kebab_module_name,
-                kebab_entity_name,
-                kebab_column_name,
-                snake_column_name,
-                capitalized_human_readable_column_name,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_delete_page(
-                task,
-                project_dir,
-                kebab_app_name,
-                kebab_module_name,
-                kebab_entity_name,
-                kebab_column_name,
-                snake_column_name,
-                capitalized_human_readable_column_name,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_update_page(
-                task,
-                project_dir,
-                kebab_app_name,
-                kebab_module_name,
-                kebab_entity_name,
-                kebab_column_name,
-                snake_column_name,
-                capitalized_human_readable_column_name,
-            )
-        ),
-        asyncio.create_task(
-            add_column_to_insert_page(
-                task,
-                project_dir,
-                kebab_app_name,
-                kebab_module_name,
-                kebab_entity_name,
-                kebab_column_name,
-                snake_column_name,
-                capitalized_human_readable_column_name,
-            )
-        ),
-    )
-    task.print_out("Success")

zrb/builtin/generator/fastapp_module/add.py

@@ -1,143 +0,0 @@
-import asyncio
-import os
-
-from zrb.builtin.generator.common.helper import validate_existing_project_dir
-from zrb.builtin.generator.common.task_input import (
-    app_name_input,
-    module_name_input,
-    project_dir_input,
-)
-from zrb.builtin.generator.fastapp_module.helper import (
-    append_all_disabled_env,
-    append_all_enabled_env,
-    append_deployment_template_env,
-    append_src_template_env,
-    create_app_config,
-    create_microservice_config,
-    register_migration,
-    register_module,
-)
-from zrb.builtin.group import project_add_group
-from zrb.helper import util
-from zrb.helper.typing import Any
-from zrb.runner import runner
-from zrb.task.decorator import python_task
-from zrb.task.resource_maker import ResourceMaker
-from zrb.task.task import Task
-
-CURRENT_DIR = os.path.dirname(__file__)
-
-###############################################################################
-# Task Definitions
-###############################################################################
-
-
-@python_task(
-    name="validate",
-    inputs=[project_dir_input, app_name_input, module_name_input],
-    retry=0,
-)
-async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get("project_dir")
-    validate_existing_project_dir(project_dir)
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    snake_module_name = util.to_snake_case(module_name)
-    automation_dir = os.path.join(
-        project_dir, "_automate", util.to_snake_case(app_name)
-    )
-    if not os.path.exists(automation_dir):
-        raise Exception(f"Automation directory does not exist: {automation_dir}")
-    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
-    if not os.path.exists(app_dir):
-        raise Exception(f"App directory does not exist: {app_dir}")
-    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
-    if os.path.exists(module_path):
-        raise Exception(f"Module directory already exists: {module_path}")
-
-
-copy_resource = ResourceMaker(
-    name="copy-resource",
-    inputs=[
-        project_dir_input,
-        app_name_input,
-        module_name_input,
-    ],
-    upstreams=[validate],
-    replacements={
-        "zrbAppName": "{{input.app_name}}",
-        "zrbModuleName": "{{input.module_name}}",
-    },
-    template_path=os.path.join(CURRENT_DIR, "template"),
-    destination_path="{{ input.project_dir }}",
-    excludes=[
-        "*/__pycache__",
-    ],
-)
-
-
-@python_task(
-    name="fastapp-module",
-    group=project_add_group,
-    upstreams=[copy_resource],
-    runner=runner,
-)
-async def add_fastapp_module(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get("_task")
-    project_dir = kwargs.get("project_dir", ".")
-    app_name = kwargs.get("app_name")
-    module_name = kwargs.get("module_name")
-    kebab_app_name = util.to_kebab_case(app_name)
-    snake_app_name = util.to_snake_case(app_name)
-    kebab_module_name = util.to_kebab_case(module_name)
-    snake_module_name = util.to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    await asyncio.gather(
-        asyncio.create_task(
-            create_microservice_config(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_app_name,
-                kebab_module_name,
-                snake_module_name,
-                upper_snake_module_name,
-            )
-        ),
-        asyncio.create_task(
-            register_module(task, project_dir, kebab_app_name, snake_module_name)
-        ),
-        asyncio.create_task(
-            register_migration(task, project_dir, kebab_app_name, snake_module_name)
-        ),
-        asyncio.create_task(
-            create_app_config(
-                task,
-                project_dir,
-                kebab_app_name,
-                snake_module_name,
-                upper_snake_module_name,
-            )
-        ),
-        asyncio.create_task(
-            append_all_enabled_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
-        ),
-        asyncio.create_task(
-            append_all_disabled_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
-        ),
-        asyncio.create_task(
-            append_src_template_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
-        ),
-        asyncio.create_task(
-            append_deployment_template_env(
-                task, project_dir, kebab_app_name, upper_snake_module_name
-            )
-        ),
-    )
-    task.print_out("Success")