zrb 1.0.0a10__py3-none-any.whl → 1.0.0a14__py3-none-any.whl

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

@@ -0,0 +1,43 @@
+from fastapp_template._zrb.helper import (
+    get_existing_module_names,
+    get_existing_schema_names,
+)
+
+from zrb import OptionInput, StrInput
+from zrb.util.string.conversion import pluralize
+
+new_module_input = StrInput(
+    name="module", description="Module name", prompt="New module name"
+)
+
+existing_module_input = OptionInput(
+    name="module",
+    description="Module name",
+    prompt="Module name",
+    options=lambda _: get_existing_module_names(),
+)
+
+new_entity_input = StrInput(
+    name="entity", description="Entity name", prompt="New entity name"
+)
+
+existing_entity_input = OptionInput(
+    name="entity",
+    description="Entity name",
+    prompt="Entity name",
+    options=lambda _: get_existing_schema_names(),
+)
+
+plural_entity_input = StrInput(
+    name="plural",
+    description="Plural entity name",
+    prompt="Plural entity name",
+    default_str=lambda ctx: pluralize(ctx.input.entity),
+)
+
+new_entity_column_input = StrInput(
+    name="column",
+    description="Entity's column name",
+    prompt="New entity's column name",
+    default_str="name",
+)

zrb/builtin/project/add/fastapp_template/_zrb/main.py

@@ -1,8 +1,10 @@
 import os
 
+from fastapp_template._zrb.column.create_column_task import create_my_app_name_column
 from fastapp_template._zrb.config import ACTIVATE_VENV_SCRIPT, APP_DIR
+from fastapp_template._zrb.entity.create_entity_task import create_my_app_name_entity
 from fastapp_template._zrb.group import (
-    app_create_group,
+    app_create_migration_group,
     app_migrate_group,
     app_run_group,
 )
@@ -11,48 +13,55 @@ from fastapp_template._zrb.helper import (
     migrate_module,
     run_microservice,
 )
+from fastapp_template._zrb.module.create_module_task import create_my_app_name_module
 from fastapp_template._zrb.venv_task import prepare_venv
 
 from zrb import CmdTask, Env, EnvFile, Task
 
+assert create_my_app_name_entity
+assert create_my_app_name_module
+assert create_my_app_name_column
+
 # 🚀 Run/Migrate All ===========================================================
 
 run_all = app_run_group.add_task(
     Task(
-        name="run-app-name", description="🟢 Run App Name as monolith and microservices"
+        name="run-my-app-name",
+        description="🟢 Run My App Name as monolith and microservices",
     ),
     alias="all",
 )
 
 migrate_all = app_migrate_group.add_task(
     Task(
-        name="migrate-app-name",
-        description="📦 Run App Name DB migration for monolith and microservices",
+        name="migrate-my-app-name",
+        description="📦 Run My App Name DB migration for monolith and microservices",
     ),
     alias="all",
 )
 
-create_all_migration = app_create_group.add_task(
+create_all_migration = app_create_migration_group.add_task(
     Task(
-        name="create-app-name-migration", description="📦 Create App Name DB migration"
+        name="create-my-app-name-migration",
+        description="📦 Create My App Name DB migration",
     ),
-    alias="migration",
+    alias="all",
 )
 
 # 🗿 Run/Migrate Monolith =====================================================
 
 run_monolith = app_run_group.add_task(
     CmdTask(
-        name="run-monolith-app-name",
-        description="🗿 Run App Name as a monolith",
+        name="run-monolith-my-app-name",
+        description="🗿 Run My App Name as a monolith",
         env=[
             EnvFile(path=os.path.join(APP_DIR, "template.env")),
-            Env(name="APP_NAME_MODE", default="monolith"),
+            Env(name="MY_APP_NAME_MODE", default="monolith"),
         ],
         cwd=APP_DIR,
         cmd=[
             ACTIVATE_VENV_SCRIPT,
-            'fastapi dev main.py --port "${APP_NAME_PORT}"',
+            'fastapi dev main.py --port "${MY_APP_NAME_PORT}"',
         ],
         render_cmd=False,
         retries=2,
@@ -63,8 +72,8 @@ prepare_venv >> run_monolith >> run_all
 
 migrate_monolith = app_migrate_group.add_task(
     Task(
-        name="migrate-monolith-app-name",
-        description="🗿 Run App Name DB migration for monolith",
+        name="migrate-monolith-my-app-name",
+        description="🗿 Run My App Name DB migration for monolith",
     ),
     alias="monolith",
 )
@@ -74,8 +83,8 @@ migrate_monolith >> migrate_all
 
 run_microservices = app_run_group.add_task(
     Task(
-        name="run-microservices-app-name",
-        description="🌐 Run App Name as microservices",
+        name="run-microservices-my-app-name",
+        description="🌐 Run My App Name as microservices",
     ),
     alias="microservices",
 )
@@ -83,8 +92,8 @@ run_microservices >> run_all
 
 migrate_microservices = app_migrate_group.add_task(
     Task(
-        name="migrate-microservices-app-name",
-        description="🌐 Run App Name DB migration for microservices",
+        name="migrate-microservices-my-app-name",
+        description="🌐 Run My App Name DB migration for microservices",
     ),
     alias="microservices",
 )
@@ -97,8 +106,8 @@ run_gateway = app_run_group.add_task(
 )
 prepare_venv >> run_gateway >> run_microservices
 
-create_gateway_migration = app_create_group.add_task(
-    create_migration("gateway", "gateway"), alias="gateway-migration"
+create_gateway_migration = app_create_migration_group.add_task(
+    create_migration("gateway", "gateway"), alias="gateway"
 )
 prepare_venv >> create_gateway_migration >> create_all_migration
 
@@ -118,8 +127,8 @@ run_auth = app_run_group.add_task(
 )
 prepare_venv >> run_auth >> run_microservices
 
-create_auth_migration = app_create_group.add_task(
-    create_migration("auth", "auth"), alias="auth-migration"
+create_auth_migration = app_create_migration_group.add_task(
+    create_migration("auth", "auth"), alias="auth"
 )
 prepare_venv >> create_auth_migration >> create_all_migration
 

zrb/builtin/project/add/fastapp_template/_zrb/module/create_module_task.py

@@ -0,0 +1,136 @@
+import os
+
+from fastapp_template._zrb.config import APP_DIR
+from fastapp_template._zrb.group import app_create_group
+from fastapp_template._zrb.helper import get_existing_module_names
+from fastapp_template._zrb.input import new_module_input
+
+from zrb import AnyContext, Scaffolder, Task, make_task
+from zrb.util.string.conversion import to_kebab_case, to_pascal_case, to_snake_case
+
+
+@make_task(
+    name="validate-create-my-app-name-module",
+    input=new_module_input,
+    retries=0,
+)
+async def validate_create_my_app_name_module(ctx: AnyContext):
+    if ctx.input.module in get_existing_module_names():
+        raise ValueError(f"Module already exists: {ctx.input.module}")
+
+
+scaffold_my_app_name_module = Scaffolder(
+    name="scaffold-my-app-name-module",
+    input=new_module_input,
+    source_path=os.path.join(os.path.dirname(__file__), "module_template"),
+    render_source_path=False,
+    destination_path=lambda ctx: os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+    ),
+    transform_content={
+        "module_template": "{to_snake_case(ctx.input.module)}",
+        "MY_MODULE_NAME": "{to_snake_case(ctx.input.module).upper()}",
+    },
+    retries=0,
+    upstream=validate_create_my_app_name_module,
+)
+
+
+@make_task(
+    name="register-my-app-name-module-config",
+    input=new_module_input,
+    upstream=validate_create_my_app_name_module,
+    retries=0,
+)
+async def register_my_app_name_module_config(ctx: AnyContext):
+    """Registering module to config.py"""
+    existing_module_names = get_existing_module_names()
+    module_port = 3000 + len(
+        [
+            module_name
+            for module_name in existing_module_names
+            if module_name != to_snake_case(ctx.input.module)
+        ]
+    )
+    module_base_url = f"http://localhost:{module_port}"
+    config_file_name = os.path.join(APP_DIR, "config.py")
+    upper_module_name = to_snake_case(ctx.input.module).upper()
+    config_name = f"APP_{upper_module_name}_BASE_URL"
+    env_name = f"MY_APP_NAME_{upper_module_name}_BASE_URL"
+    # TODO: check before write
+    with open(config_file_name, "a") as f:
+        f.write(f'{config_name} = os.getenv("{env_name}", "{module_base_url}")\n')
+
+
+@make_task(
+    name="register-my-app-name-module",
+    input=new_module_input,
+    upstream=validate_create_my_app_name_module,
+    retries=0,
+)
+async def register_my_app_name_module(ctx: AnyContext):
+    """Registering module to application's main.py"""
+    app_main_file_name = os.path.join(APP_DIR, "main.py")
+    module_name = to_snake_case(ctx.input.module)
+    import_code = f"from fastapp_template.module.{module_name} import route as {module_name}_route"  # noqa
+    assert_code = f"assert {module_name}_route"
+    with open(app_main_file_name, "r") as f:
+        code = f.read()
+    new_code = "\n".join([import_code, code.strip(), assert_code, ""])
+    # TODO: check before write
+    with open(app_main_file_name, "w") as f:
+        f.write(new_code)
+
+
+@make_task(
+    name="register-my-app-name-module-runner",
+    input=new_module_input,
+    upstream=validate_create_my_app_name_module,
+    retries=0,
+)
+async def register_my_app_name_module_runner(ctx: AnyContext):
+    """Registering module to _zrb's main.py"""
+    task_main_file_name = os.path.join(APP_DIR, "_zrb", "main.py")
+    existing_module_names = get_existing_module_names()
+    module_port = 3001 + len(
+        [
+            module_name
+            for module_name in existing_module_names
+            if module_name != to_snake_case(ctx.input.module)
+        ]
+    )
+    module_snake_name = to_snake_case(ctx.input.module)
+    module_kebab_name = to_kebab_case(ctx.input.module)
+    module_pascal_name = to_pascal_case(ctx.input.module)
+    with open(os.path.join(os.path.dirname(__file__), "run_module.template.py")) as f:
+        module_runner_code = (
+            f.read()
+            .replace("my_module", module_snake_name)
+            .replace("my-module", module_kebab_name)
+            .replace("My Module", module_pascal_name)
+            .replace("3000", f"{module_port}")
+        )
+    with open(task_main_file_name, "r") as f:
+        code = f.read()
+    new_code = "\n".join([code.strip(), "", module_runner_code, ""])
+    # TODO: check before write
+    with open(task_main_file_name, "w") as f:
+        f.write(new_code)
+
+
+create_my_app_name_module = app_create_group.add_task(
+    Task(
+        name="create-my-app-name-module",
+        description="🧩 Create new module on My App Name",
+        retries=0,
+    ),
+    alias="module",
+)
+create_my_app_name_module << [
+    scaffold_my_app_name_module,
+    register_my_app_name_module,
+    register_my_app_name_module_config,
+    register_my_app_name_module_runner,
+]

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migration
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = ../..
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migration/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migration/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/client/api_client.py

@@ -0,0 +1,6 @@
+from fastapp_template.config import APP_MY_MODULE_NAME_BASE_URL
+from fastapp_template.module.module_template.client.any_client import BaseClient
+
+
+class APIClient(BaseClient):
+    pass

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/client/direct_client.py

@@ -0,0 +1,6 @@
+from fastapp_template.module.module_template.client.any_client import BaseClient
+from fastapp_template.module.module_template.service.user.usecase import user_usecase
+
+
+class DirectClient(BaseClient):
+    pass

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/client/factory.py

@@ -0,0 +1,9 @@
+from fastapp_template.config import APP_COMMUNICATION
+from fastapp_template.module.module_template.client.any_client import BaseClient
+from fastapp_template.module.module_template.client.api_client import APIClient
+from fastapp_template.module.module_template.client.direct_client import DirectClient
+
+if APP_COMMUNICATION == "direct":
+    client: BaseClient = DirectClient()
+elif APP_COMMUNICATION == "api":
+    client: BaseClient = APIClient()

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/migration/README

@@ -0,0 +1 @@
+Generic single-database configuration.

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/migration/env.py

@@ -0,0 +1,108 @@
+from logging.config import fileConfig
+
+from alembic import context
+from fastapp_template.config import APP_DB_URL
+from fastapp_template.module.my_module.migration_metadata import metadata
+from sqlalchemy import engine_from_config, pool
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# 🔥 FastApp Modification
+MIGRATION_TABLE = "_migration_my_module"
+# 🔥 FastApp Modification
+config.set_section_option(config.config_ini_section, "sqlalchemy.url", APP_DB_URL)
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+# 🔥 FastApp Modification
+def include_object(object, name, type_, reflected, compare_to):
+    """
+    Filter which objects Alembic should include in migrations.
+    Args:
+        object: The SQLAlchemy object (table, column, etc.)
+        name: The name of the object
+        type_: The type of the object ("table", "column", etc.)
+        reflected: True if the object is reflected from the database
+        compare_to: The object being compared against
+    Returns:
+        bool: True to include, False to exclude
+    """
+    # Exclude tables not in metadata
+    if type_ == "table" and name not in target_metadata.tables:
+        return False  # Skip this table
+    return True
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+        imports=["import sqlmodel"],  # 🔥 FastApp Modification
+        version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
+        include_object=include_object,  # 🔥 FastApp Modification
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            imports=["import sqlmodel"],  # 🔥 FastApp Modification
+            version_table=MIGRATION_TABLE,  # 🔥 FastApp Modification
+            include_object=include_object,  # 🔥 FastApp Modification
+        )
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/migration/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/migration/versions/3093c7336477_add_user_table.py

@@ -0,0 +1,37 @@
+"""Add user table
+
+Revision ID: 3093c7336477
+Revises:
+Create Date: 2024-11-20 05:57:01.684118
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+import sqlmodel
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "3093c7336477"
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "user",
+        sa.Column("id", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("username", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.Column("password", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("user")
+    # ### end Alembic commands ###

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/migration_metadata.py

@@ -0,0 +1,3 @@
+from sqlalchemy import MetaData
+
+metadata = MetaData()

zrb/builtin/project/add/fastapp_template/_zrb/module/module_template/route.py

@@ -0,0 +1,19 @@
+from fastapp_template.common.app import app
+from fastapp_template.common.schema import BasicResponse
+from fastapp_template.config import APP_MODE, APP_MODULES
+
+if APP_MODE == "microservices" and "auth" in APP_MODULES:
+
+    if APP_MODE == "microservices" and (
+        len(APP_MODULES) > 0 and APP_MODULES[0] == "auth"
+    ):
+
+        @app.api_route("/health", methods=["GET", "HEAD"], response_model=BasicResponse)
+        async def health():
+            return BasicResponse(message="ok")
+
+        @app.api_route(
+            "/readiness", methods=["GET", "HEAD"], response_model=BasicResponse
+        )
+        async def readiness():
+            return BasicResponse(message="ok")

zrb/builtin/project/add/fastapp_template/_zrb/module/run_module.template.py

@@ -0,0 +1,26 @@
+# 🔐 Run/Migrate My Module ==========================================================
+
+run_my_module = app_run_group.add_task(
+    run_microservice("my-module", 3000, "my_module"), alias="microservices-my_module"
+)
+prepare_venv >> run_my_module >> run_microservices
+
+create_my_module_migration = app_create_migration_group.add_task(
+    create_migration("my-module", "my_module"), alias="my_module"
+)
+prepare_venv >> create_my_module_migration >> create_all_migration
+
+migrate_monolith_my_module = migrate_module(
+    "my_module", "my_module", as_microservices=False
+)
+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",
+)
+(
+    prepare_venv
+    >> migrate_microservices_my_module
+    >> [migrate_microservices, run_my_module]
+)