zrb 0.28.1__py3-none-any.whl → 1.0.0a8__py3-none-any.whl

zrb/builtin/project/add/fastapp/module/_helper/append_deployment_template_env.py

@@ -1,25 +0,0 @@
-import os
-
-from zrb.helper.file.text import append_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def append_deployment_template_env(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    deployment_template_env_path = os.path.join(
-        project_dir, "src", kebab_app_name, "deployment", "template.env"
-    )
-    new_env_str = "\n".join(
-        [
-            f"REPLICA_{upper_snake_module_name}_SERVICE=1",
-        ]
-    )
-    task.print_out(f"Add new environment to: {deployment_template_env_path}")
-    await append_text_file_async(deployment_template_env_path, new_env_str)

zrb/builtin/project/add/fastapp/module/_helper/append_src_template_env.py

@@ -1,25 +0,0 @@
-import os
-
-from zrb.helper.file.text import append_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def append_src_template_env(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    src_template_env_path = os.path.join(
-        project_dir, "src", kebab_app_name, "src", "template.env"
-    )
-    new_env_str = "\n".join(
-        [
-            f"APP_ENABLE_{upper_snake_module_name}_MODULE=true",
-        ]
-    )
-    task.print_out(f"Add new environment to: {src_template_env_path}")
-    await append_text_file_async(src_template_env_path, new_env_str)

zrb/builtin/project/add/fastapp/module/_helper/create_app_config.py

@@ -1,29 +0,0 @@
-import os
-
-from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def create_app_config(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    config_file_path = os.path.join(
-        project_dir, "src", kebab_app_name, "src", "config.py"
-    )
-    config_code = "\n".join(
-        [
-            f"APP_ENABLE_{upper_snake_module_name}_MODULE = str_to_boolean(os.environ.get(",  # noqa
-            f"    'APP_ENABLE_{upper_snake_module_name}_MODULE', 'true'" "))",
-        ]
-    )
-    task.print_out(f"Read config from: {config_file_path}")
-    code = await read_text_file_async(config_file_path)
-    code += "\n" + config_code
-    task.print_out(f"Write config to: {config_file_path}")
-    await write_text_file_async(config_file_path, code)

zrb/builtin/project/add/fastapp/module/_helper/create_microservice_config.py

@@ -1,157 +0,0 @@
-import asyncio
-import os
-from collections.abc import Mapping
-from typing import Any
-
-import jsons
-from dotenv import dotenv_values
-
-from zrb.helper.docker_compose.file import add_services
-from zrb.helper.file.text import (
-    append_text_file_async,
-    read_text_file_async,
-    write_text_file_async,
-)
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def create_microservice_config(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    modules = await _create_automation_json_config(
-        task, project_dir, app_name, module_name
-    )
-    return await asyncio.gather(
-        asyncio.create_task(
-            _add_docker_compose_service(
-                task, modules, project_dir, app_name, module_name
-            )
-        ),
-        asyncio.create_task(
-            _append_compose_env(task, modules, project_dir, app_name, module_name)
-        ),
-    )
-
-
-@typechecked
-async def _add_docker_compose_service(
-    task: Task, modules: list[str], project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    module_app_port = 8080 + len(modules)
-    module_app_port_str = str(module_app_port)
-    docker_compose_file_path = os.path.join(
-        project_dir, "src", kebab_app_name, "docker-compose.yml"
-    )
-    app_container_port_env_name = f"APP_{upper_snake_module_name}_MODULE_PORT"
-    app_container_port_env = (
-        "${" + app_container_port_env_name + ":-" + module_app_port_str + "}"
-    )
-    app_host_port_env_name = f"APP_{upper_snake_module_name}_HOST_MODULE_PORT"
-    app_host_port_env = "${" + app_host_port_env_name + ":-" + module_app_port_str + "}"
-    service_definition = _get_new_docker_compose_service_definition(
-        app_name=app_name,
-        module_name=module_name,
-        app_host_port_env=app_host_port_env,
-        app_container_port_env=app_container_port_env,
-    )
-    task.print_out(f"Add service at: {docker_compose_file_path}")
-    add_services(
-        file_name=docker_compose_file_path,
-        new_services=service_definition,
-    )
-
-
-@typechecked
-def _get_new_docker_compose_service_definition(
-    app_name: str, module_name: str, app_host_port_env: str, app_container_port_env: str
-) -> Mapping[str, Any]:
-    kebab_app_name = to_kebab_case(app_name)
-    kebab_module_name = to_kebab_case(module_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    return {
-        f"{kebab_app_name}-{kebab_module_name}-service": {
-            "build": {"dockerfile": "Dockerfile", "context": "./src"},
-            "image": "${IMAGE:-" + kebab_app_name + "}",
-            "container_name": "${CONTAINER_PREFIX:-my}-"
-            + f"{kebab_app_name}-{kebab_module_name}-service",  # noqa
-            "hostname": f"{kebab_app_name}-{kebab_module_name}-service",
-            "env_file": ["src/template.env", "all-module-disabled.env"],
-            "environment": {
-                "APP_NAME": "${APP_NAME:-"
-                + kebab_app_name
-                + "}-"
-                + f"{kebab_module_name}-service",  # noqa
-                "APP_ENABLE_OTEL": "${APP_ENABLE_OTEL:-0}",
-                "APP_PORT": app_container_port_env,
-                "APP_ENABLE_EVENT_HANDLER": "true",
-                "APP_ENABLE_RPC_SERVER": "true",
-                "APP_ENABLE_API": "false",
-                "APP_ENABLE_FRONTEND": "false",
-                f"APP_ENABLE_{upper_snake_module_name}_MODULE": "true",
-            },
-            "ports": [f"{app_host_port_env}:{app_container_port_env}"],
-            "restart": "unless-stopped",
-            "profiles": ["microservices"],
-            "healthcheck": {
-                "test": f"curl --fail http://localhost:{app_container_port_env}/readiness || killall uvicorn",  # noqa
-                "interval": "20s",
-                "timeout": "3s",
-                "retries": 10,
-                "start_period": "20s",
-            },
-            "networks": ["zrb"],
-        }
-    }
-
-
-@typechecked
-async def _create_automation_json_config(
-    task: Task,
-    project_dir: str,
-    app_name: str,
-    module_name: str,
-):
-    snake_app_name = to_snake_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    json_modules_file_path = os.path.join(
-        project_dir, "_automate", snake_app_name, "config", "modules.json"
-    )
-    task.print_out(f"Read json config from: {json_modules_file_path}")
-    json_str = await read_text_file_async(json_modules_file_path)
-    task.print_out(f'Add "{snake_module_name}" to json config')
-    modules: list[str] = jsons.loads(json_str)
-    modules.append(snake_module_name)
-    json_str = jsons.dumps(modules)
-    task.print_out(f"Write new json config to: {json_modules_file_path}")
-    await write_text_file_async(json_modules_file_path, json_str)
-    return modules
-
-
-@typechecked
-async def _append_compose_env(
-    task: Task, modules: list[str], project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    upper_snake_module_name = snake_module_name.upper()
-    compose_template_env_path = os.path.join(
-        project_dir, "src", kebab_app_name, "docker-compose.env"
-    )
-    compose_env_map = dotenv_values(compose_template_env_path)
-    host_port = int(compose_env_map.get("APP_GATEWAY_HOST_PORT", "8080"))
-    module_app_port = host_port + len(modules)
-    new_env_str = "\n".join(
-        [
-            f"APP_{upper_snake_module_name}_HOST_MODULE_PORT={module_app_port}",
-            f"APP_{upper_snake_module_name}_MODULE_PORT={module_app_port}",
-        ]
-    )
-    task.print_out(f"Add new environment to: {compose_template_env_path}")
-    await append_text_file_async(compose_template_env_path, new_env_str)

zrb/builtin/project/add/fastapp/module/_helper/register_migration.py

@@ -1,35 +0,0 @@
-import os
-
-from zrb.helper.codemod.add_import_module import add_import_module
-from zrb.helper.codemod.append_code_to_function import append_code_to_function
-from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def register_migration(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    app_migration_file_path = os.path.join(
-        project_dir, "src", kebab_app_name, "src", "migrate.py"
-    )
-    import_module_path = ".".join(["module", snake_module_name, "migrate"])
-    function_name = f"migrate_{snake_module_name}"
-    task.print_out(f"Read code from: {app_migration_file_path}")
-    code = await read_text_file_async(app_migration_file_path)
-    task.print_out(
-        f'Add import "{function_name}" from "{import_module_path}" to the code'
-    )
-    code = add_import_module(
-        code=code, module_path=import_module_path, resource=function_name
-    )
-    task.print_out(f'Add "{function_name}" call to the code')
-    code = append_code_to_function(
-        code=code, function_name="migrate", new_code=f"await {function_name}()"
-    )
-    task.print_out(f"Write modified code to: {app_migration_file_path}")
-    await write_text_file_async(app_migration_file_path, code)

zrb/builtin/project/add/fastapp/module/_helper/register_module.py

@@ -1,33 +0,0 @@
-import os
-
-from zrb.helper.codemod.add_function_call import add_function_call
-from zrb.helper.codemod.add_import_module import add_import_module
-from zrb.helper.file.text import read_text_file_async, write_text_file_async
-from zrb.helper.typecheck import typechecked
-from zrb.helper.util import to_kebab_case, to_snake_case
-from zrb.task.task import Task
-
-
-@typechecked
-async def register_module(
-    task: Task, project_dir: str, app_name: str, module_name: str
-):
-    kebab_app_name = to_kebab_case(app_name)
-    snake_module_name = to_snake_case(module_name)
-    app_main_file_path = os.path.join(
-        project_dir, "src", kebab_app_name, "src", "main.py"
-    )
-    import_module_path = ".".join(["module", snake_module_name, "register_module"])
-    function_name = f"register_{snake_module_name}"
-    task.print_out(f"Read code from: {app_main_file_path}")
-    code = await read_text_file_async(app_main_file_path)
-    task.print_out(
-        f'Add import "{function_name}" from "{import_module_path}" to the code'
-    )
-    code = add_import_module(
-        code=code, module_path=import_module_path, resource=function_name
-    )
-    task.print_out(f'Add "{function_name}" call to the code')
-    code = add_function_call(code=code, function_name=function_name, parameters=[])
-    task.print_out(f"Write modified code to: {app_main_file_path}")
-    await write_text_file_async(app_main_file_path, code)

zrb/builtin/project/add/fastapp/module/_input.py

@@ -1,9 +0,0 @@
-from zrb.task_input.str_input import StrInput
-
-module_name_input = StrInput(
-    name="module-name",
-    shortcut="m",
-    description="module name",
-    prompt="module name",
-    default="library",
-)

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

@@ -1,115 +0,0 @@
-import asyncio
-import os
-from typing import Any
-
-from zrb.builtin.project._helper import validate_existing_project_dir
-from zrb.builtin.project._input import project_dir_input
-from zrb.builtin.project.add.fastapp._group import project_add_fastapp_group
-from zrb.builtin.project.add.fastapp.app._input import app_name_input
-from zrb.builtin.project.add.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.project.add.fastapp.module._input import module_name_input
-from zrb.helper import util
-from zrb.helper.accessories.color import colored
-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__)
-
-
-@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="module",
-    group=project_add_fastapp_group,
-    description="Add Fastapp module",
-    inputs=[
-        project_dir_input,
-        app_name_input,
-        module_name_input,
-    ],
-    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")
-    await asyncio.gather(
-        asyncio.create_task(
-            create_microservice_config(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(register_module(task, project_dir, app_name, module_name)),
-        asyncio.create_task(
-            register_migration(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(
-            create_app_config(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(
-            append_all_enabled_env(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(
-            append_all_disabled_env(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(
-            append_src_template_env(task, project_dir, app_name, module_name)
-        ),
-        asyncio.create_task(
-            append_deployment_template_env(task, project_dir, app_name, module_name)
-        ),
-    )
-    task.print_out(colored("Fastapp crud added", color="yellow"))

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/api.py

@@ -1,16 +0,0 @@
-from logging import Logger
-
-from component.messagebus import Publisher
-from component.rpc import Caller
-from fastapi import FastAPI
-from module.auth.component import Authorizer
-
-
-def register_api(
-    logger: Logger,
-    app: FastAPI,
-    authorizer: Authorizer,
-    rpc_caller: Caller,
-    publisher: Publisher,
-):
-    logger.info('🥪 Register API for "snake_zrb_module_name"')

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/entity/table.py

@@ -1,23 +0,0 @@
-from module.snake_zrb_module_name.integration.base import Base
-from sqlalchemy import Column, ForeignKey, Integer, Table
-
-"""
-You should put any "many-to-many" table declarations in this file.
-For example:
-```
-# Many-to-many table to relate users and permissions
-user_permission = Table(
-    "user_permission",
-    Base.metadata,
-    Column("user_id", Integer, ForeignKey("users.id")),
-    Column("permission_id", Integer, ForeignKey("permissions.id")),
-)
-```
-
-Remove the following assertions:
-"""
-assert Column
-assert Integer
-assert Table
-assert ForeignKey
-assert Base

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/event.py

@@ -1,10 +0,0 @@
-from logging import Logger
-
-from component.messagebus import Consumer, Publisher
-from component.rpc import Caller
-
-
-def register_event(
-    logger: Logger, consumer: Consumer, rpc_caller: Caller, publisher: Publisher
-):
-    logger.info('🥪 Register event handlers for "snake_zrb_module_name"')

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/integration/__init__.py

@@ -1,3 +0,0 @@
-from module.snake_zrb_module_name.integration.base import Base
-
-assert Base

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/integration/base.py

@@ -1,5 +0,0 @@
-from sqlalchemy.orm import DeclarativeBase
-
-
-class Base(DeclarativeBase):
-    pass

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/migrate.py

@@ -1,13 +0,0 @@
-from config import APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE
-from helper.migration import migrate
-from integration.db_connection import engine
-from integration.log import logger
-from module.snake_zrb_module_name.integration import Base
-
-
-async def migrate_snake_zrb_module_name():
-    if not APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE:
-        logger.info('🥪 Skip DB migration for "snake_zrb_module_name"')
-        return
-    logger.info('🥪 Perform DB migration for "snake_zrb_module_name"')
-    await migrate(engine=engine, Base=Base)

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/register_module.py

@@ -1,39 +0,0 @@
-from config import (
-    APP_ENABLE_API,
-    APP_ENABLE_EVENT_HANDLER,
-    APP_ENABLE_RPC_SERVER,
-    APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE,
-)
-from integration.app.app import app
-from integration.log import logger
-from integration.messagebus import consumer, publisher
-from integration.rpc import rpc_caller, rpc_server
-from module.auth.integration import authorizer
-from module.snake_zrb_module_name.api import register_api
-from module.snake_zrb_module_name.event import register_event
-from module.snake_zrb_module_name.rpc import register_rpc
-
-
-def register_snake_zrb_module_name():
-    if not APP_ENABLE_SNAKE_ZRB_MODULE_NAME_MODULE:
-        logger.info('🥪 Skip registering "snake_zrb_module_name"')
-        return
-    if APP_ENABLE_API:
-        register_api(
-            logger=logger,
-            app=app,
-            authorizer=authorizer,
-            rpc_caller=rpc_caller,
-            publisher=publisher,
-        )
-    if APP_ENABLE_EVENT_HANDLER:
-        register_event(
-            logger=logger, consumer=consumer, rpc_caller=rpc_caller, publisher=publisher
-        )
-    if APP_ENABLE_RPC_SERVER:
-        register_rpc(
-            logger=logger,
-            rpc_server=rpc_server,
-            rpc_caller=rpc_caller,
-            publisher=publisher,
-        )

zrb/builtin/project/add/fastapp/module/template/src/kebab-zrb-app-name/src/module/snake_zrb_module_name/rpc.py

@@ -1,11 +0,0 @@
-from logging import Logger
-from typing import Any
-
-from component.messagebus import Publisher
-from component.rpc import Caller, Server
-
-
-def register_rpc(
-    logger: Logger, rpc_server: Server, rpc_caller: Caller, publisher: Publisher
-):
-    logger.info('🥪 Register RPC handlers for "snake_zrb_module_name"')

zrb/builtin/project/add/plugin/__init__.py

@@ -1,3 +0,0 @@
-from zrb.builtin.project.add.plugin.plugin import add_plugin
-
-assert add_plugin

zrb/builtin/project/add/plugin/_input.py

@@ -1,74 +0,0 @@
-import os
-
-from zrb.helper.accessories.name import get_random_name
-from zrb.task_input.str_input import StrInput
-
-SYSTEM_USER = os.getenv("USER", "incognito")
-
-package_name_input = StrInput(
-    name="package-name",
-    shortcut="p",
-    description="Package name",
-    prompt="Package name",
-    default=get_random_name(),
-)
-
-package_description_input = StrInput(
-    name="package-description",
-    description="Package description",
-    prompt="Package description",
-    default="Just another package",
-)
-
-package_homepage_input = StrInput(
-    name="package-homepage",
-    description="Package homepage",
-    prompt="Package homepage",
-    default="".join(
-        [
-            "https://github.com/",
-            SYSTEM_USER,
-            "/{{util.to_kebab_case(input.package_name)}}",
-        ]
-    ),
-)
-
-package_repository_input = StrInput(
-    name="package-repository",
-    description="Package repository",
-    prompt="Package repository",
-    default="".join(
-        [
-            "https://github.com/",
-            SYSTEM_USER,
-            "/{{util.to_kebab_case(input.package_name)}}",
-        ]
-    ),
-)
-
-package_documentation_input = StrInput(
-    name="package-documentation",
-    description="Package documentation",
-    prompt="Package documentation",
-    default="".join(
-        [
-            "https://github.com/",
-            SYSTEM_USER,
-            "/{{util.to_kebab_case(input.package_name)}}",
-        ]
-    ),
-)
-
-package_author_name_input = StrInput(
-    name="package-author-name",
-    prompt="Package author name",
-    description="Package author name",
-    default=SYSTEM_USER,
-)
-
-package_author_email_input = StrInput(
-    name="package-author-email",
-    prompt="Package author email",
-    description="Package author email",
-    default=f"{SYSTEM_USER}@gmail.com",
-)