zrb 1.0.0a1__py3-none-any.whl → 1.0.0a3__py3-none-any.whl

zrb/builtin/project/add/fastapp_template/module/auth/service/user/repository/db_repository.py

@@ -0,0 +1,39 @@
+from fastapp_template.common.db_repository import BaseDBRepository
+from fastapp_template.common.error import NotFoundError
+from fastapp_template.module.auth.service.user.repository.repository import (
+    UserRepository,
+)
+from fastapp_template.schema.user import User, UserCreate, UserResponse, UserUpdate
+from passlib.context import CryptContext
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlmodel import Session, select
+
+# Password hashing context
+pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
+
+
+def hash_password(password: str) -> str:
+    return pwd_context.hash(password)
+
+
+class UserDBRepository(
+    BaseDBRepository[User, UserResponse, UserCreate, UserUpdate], UserRepository
+):
+    db_model = User
+    response_model = UserResponse
+    create_model = UserCreate
+    update_model = UserUpdate
+    entity_name = "user"
+    column_preprocessors = {"password": hash_password}
+
+    async def get_by_credentials(self, username: str, password: str) -> UserResponse:
+        statement = select(User).where(User.username == username)
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                user = await session.exec(statement).first
+        else:
+            with Session(self.engine) as session:
+                user = session.exec(statement).first()
+        if not user or not pwd_context.verify(password, user.hashed_password):
+            raise NotFoundError(f"{self.entity_name} not found")
+        return self._to_response(user)

zrb/builtin/project/add/fastapp_template/module/auth/service/user/repository/factory.py

@@ -0,0 +1,13 @@
+from fastapp_template.common.db_engine import engine
+from fastapp_template.config import APP_REPOSITORY_TYPE
+from fastapp_template.module.auth.service.user.repository.db_repository import (
+    UserDBRepository,
+)
+from fastapp_template.module.auth.service.user.repository.repository import (
+    UserRepository,
+)
+
+if APP_REPOSITORY_TYPE == "db":
+    user_repository: UserRepository = UserDBRepository(engine)
+else:
+    user_repository: UserRepository = None

zrb/builtin/project/add/fastapp_template/module/auth/service/user/repository/repository.py

@@ -0,0 +1,34 @@
+from abc import ABC, abstractmethod
+
+from fastapp_template.schema.user import User, UserCreate, UserResponse, UserUpdate
+
+
+class UserRepository(ABC):
+
+    @abstractmethod
+    async def create(self, user_data: UserCreate) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def get_by_id(self, user_id: str) -> User:
+        pass
+
+    @abstractmethod
+    async def get_all(self) -> list[User]:
+        pass
+
+    @abstractmethod
+    async def update(self, user_id: str, user_data: UserUpdate) -> User:
+        pass
+
+    @abstractmethod
+    async def delete(self, user_id: str) -> User:
+        pass
+
+    @abstractmethod
+    async def create_bulk(self, user_data_list: list[UserCreate]) -> list[UserResponse]:
+        pass
+
+    @abstractmethod
+    async def get_by_credentials(self, username: str, password: str) -> UserResponse:
+        pass

zrb/builtin/project/add/fastapp_template/module/auth/service/user/usecase.py

@@ -0,0 +1,45 @@
+from fastapp_template.common.usecase import BaseUsecase
+from fastapp_template.module.auth.service.user.repository.factory import user_repository
+from fastapp_template.schema.user import UserCreate, UserResponse, UserUpdate
+
+
+class UserUsecase(BaseUsecase):
+
+    @BaseUsecase.route(
+        "/api/v1/users/{user_id}", methods=["get"], response_model=UserResponse
+    )
+    async def get_user_by_id(self, user_id: str) -> UserResponse:
+        return await user_repository.get_by_id(user_id)
+
+    @BaseUsecase.route(
+        "/api/v1/users", methods=["get"], response_model=list[UserResponse]
+    )
+    async def get_all_users(self) -> list[UserResponse]:
+        return await user_repository.get_all()
+
+    @BaseUsecase.route(
+        "/api/v1/users",
+        methods=["post"],
+        response_model=UserResponse | list[UserResponse],
+    )
+    async def create_user(
+        self, data: UserCreate | list[UserCreate]
+    ) -> UserResponse | list[UserResponse]:
+        if isinstance(data, UserCreate):
+            return await user_repository.create(data)
+        return await user_repository.create_bulk(data)
+
+    @BaseUsecase.route(
+        "/api/v1/users/{user_id}", methods=["put"], response_model=UserResponse
+    )
+    async def update_user(self, user_id: str, data: UserUpdate) -> UserResponse:
+        return await user_repository.update(user_id, data)
+
+    @BaseUsecase.route(
+        "/api/v1/users/{user_id}", methods=["delete"], response_model=UserResponse
+    )
+    async def delete_user(self, user_id: str) -> UserResponse:
+        return await user_repository.delete(user_id)
+
+
+user_usecase = UserUsecase()

zrb/builtin/project/add/fastapp_template/module/gateway/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/module/gateway/migration/README

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

zrb/builtin/project/add/fastapp_template/module/gateway/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.gateway.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_gateway"
+# 🔥 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/module/gateway/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/module/gateway/migration_metadata.py

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

zrb/builtin/project/add/fastapp_template/module/gateway/route.py

@@ -0,0 +1,27 @@
+from fastapp_template.common.app import app
+from fastapp_template.common.schema import BasicResponse
+from fastapp_template.config import APP_MODE, APP_MODULES
+from fastapp_template.module.auth.client.factory import client as auth_client
+from fastapp_template.schema.user import UserCreate, UserResponse
+
+if APP_MODE == "monolith" or "gateway" in APP_MODULES:
+
+    if APP_MODE == "monolith" or (len(APP_MODULES) > 0 and APP_MODULES[0] == "gateway"):
+
+        @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")
+
+    @app.get("/api/v1/users", response_model=list[UserResponse])
+    async def auth_get_all_users() -> UserResponse:
+        return await auth_client.get_all_users()
+
+    @app.post("/api/v1/users", response_model=UserResponse | list[UserResponse])
+    async def auth_create_user(data: UserCreate | list[UserCreate]):
+        return await auth_client.create_user(data)

zrb/builtin/project/add/fastapp_template/requirements.txt

@@ -0,0 +1,6 @@
+fastapi[standard]==0.115.4
+aiosqlite==0.20.0
+alembic==1.14.0
+sqlmodel==0.0.22
+ulid-py==1.1.0
+passlib==1.7.4

zrb/builtin/project/add/fastapp_template/schema/role.py

@@ -0,0 +1,31 @@
+import datetime
+
+import ulid
+from sqlmodel import Field, SQLModel
+
+
+class RoleBase(SQLModel):
+    name: str
+
+
+class RoleCreate(RoleBase):
+    description: str
+
+
+class RoleUpdate(SQLModel):
+    name: str | None = None
+    description: str | None = None
+
+
+class RoleResponse(RoleBase):
+    id: str
+
+
+class Role(SQLModel, table=True):
+    id: str = Field(default_factory=lambda: ulid.new().str, primary_key=True)
+    created_at: datetime.datetime | None
+    created_by: str | None
+    updated_at: datetime.datetime | None
+    updated_by: str | None
+    name: str
+    description: str

zrb/builtin/project/add/fastapp_template/schema/user.py

@@ -0,0 +1,31 @@
+import datetime
+
+import ulid
+from sqlmodel import Field, SQLModel
+
+
+class UserBase(SQLModel):
+    username: str
+
+
+class UserCreate(UserBase):
+    password: str
+
+
+class UserUpdate(SQLModel):
+    username: str | None = None
+    password: str | None = None
+
+
+class UserResponse(UserBase):
+    id: str
+
+
+class User(SQLModel, table=True):
+    id: str = Field(default_factory=lambda: ulid.new().str, primary_key=True)
+    created_at: datetime.datetime
+    created_by: str
+    updated_at: datetime.datetime
+    updated_by: str
+    username: str
+    password: str

zrb/builtin/project/add/fastapp_template/template.env

@@ -0,0 +1,2 @@
+export APP_NAME_MODE=monolith
+export APP_NAME_PORT=3000

zrb/builtin/project/create/create.py

@@ -0,0 +1,41 @@
+import os
+
+from zrb.builtin.group import project_group
+from zrb.input.str_input import StrInput
+from zrb.task.scaffolder import Scaffolder
+from zrb.task.task import Task
+
+_DIR = os.path.dirname(__file__)
+
+scaffold_project = Scaffolder(
+    name="scaffold-project",
+    description="🌟 Create project",
+    input=[
+        StrInput(
+            name="project-dir",
+            description="Project directory",
+            prompt="Project directory",
+            default_str=lambda _: os.getcwd(),
+        ),
+        StrInput(
+            name="project-name",
+            description="Project name",
+            prompt="Project name",
+            default_str=lambda ctx: os.path.basename(ctx.input["project-dir"]),
+        ),
+    ],
+    source_path=os.path.join(_DIR, "project-template"),
+    auto_render_source_path=False,
+    destination_path="{ctx.input['project-dir']}",
+    transform_content={"Project Name": "{ctx.input['project-name'].title()}"},
+    retries=0,
+)
+
+create_project = project_group.add_task(
+    Task(
+        name="create-project",
+        description="🌟 Create project",
+    ),
+    alias="create",
+)
+scaffold_project >> create_project

zrb/builtin/project/create/project-template/README.md

@@ -0,0 +1,3 @@
+# Project Name
+
+Welcome to Project Name

zrb/builtin/project/create/project-template/zrb_init.py

@@ -0,0 +1,7 @@
+import os
+
+from zrb import load_file
+
+_DIR = os.path.dirname(__file__)
+
+assert load_file

zrb/builtin/python.py

@@ -0,0 +1,11 @@
+from zrb.builtin.group import python_group
+from zrb.task.cmd_task import CmdTask
+
+format_python_code = python_group.add_task(
+    CmdTask(
+        name="format-code",
+        description="✏️ Format Python code",
+        cmd=["isort .", "black ."],
+    ),
+    alias="format",
+)

zrb/builtin/shell/__init__.py

@@ -1,5 +0,0 @@
-from . import autocomplete
-from ._group import shell_group
-
-assert autocomplete
-assert shell_group

zrb/builtin/shell/autocomplete/__init__.py

@@ -1,9 +0,0 @@
-from ._group import shell_autocomplete_group
-from .bash import make_bash_autocomplete
-from .subcmd import get_shell_subcommands
-from .zsh import make_zsh_autocomplete
-
-assert shell_autocomplete_group
-assert make_bash_autocomplete
-assert make_zsh_autocomplete
-assert get_shell_subcommands

zrb/builtin/shell/autocomplete/bash.py

@@ -1,6 +1,6 @@
-from ....context.context import Context
-from ....task.make_task import make_task
-from ._group import shell_autocomplete_group
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.task.make_task import make_task
 
 _COMPLETION_SCRIPT = """
 # Bash dynamic completion script
@@ -33,9 +33,8 @@ complete -F _zrb_complete zrb
 @make_task(
     name="make-bash-autocomplete",
     description="Create Zrb autocomplete script for bash",
+    group=shell_autocomplete_group,
+    alias="bash",
 )
 def make_bash_autocomplete(ctx: Context):
     return _COMPLETION_SCRIPT
-
-
-shell_autocomplete_group.add_task(make_bash_autocomplete, "bash")

zrb/builtin/shell/autocomplete/subcmd.py

@@ -1,13 +1,15 @@
-from ....context.context import Context
-from ....runner.cli import cli
-from ....task.make_task import make_task
-from ....util.cli.subcommand import get_group_subcommands
-from ._group import shell_autocomplete_group
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.runner.cli import cli
+from zrb.task.make_task import make_task
+from zrb.util.cli.subcommand import get_group_subcommands
 
 
 @make_task(
     name="get-shell-subcommands",
     description="Get subcommand of any Zrb command",
+    group=shell_autocomplete_group,
+    alias="subcmd",
 )
 def get_shell_subcommands(ctx: Context):
     subcommands = get_group_subcommands(cli)
@@ -15,6 +17,3 @@ def get_shell_subcommands(ctx: Context):
         if subcommand.paths == ctx.args:
             return " ".join(subcommand.nexts)
     return ""
-
-
-shell_autocomplete_group.add_task(get_shell_subcommands, "subcmd")

zrb/builtin/shell/autocomplete/zsh.py

@@ -1,6 +1,6 @@
-from ....context.context import Context
-from ....task.make_task import make_task
-from ._group import shell_autocomplete_group
+from zrb.builtin.group import shell_autocomplete_group
+from zrb.context.context import Context
+from zrb.task.make_task import make_task
 
 _COMPLETION_SCRIPT = """
 # Zsh dynamic completion script
@@ -30,9 +30,8 @@ compdef _zrb_complete zrb
 @make_task(
     name="make-zsh-autocomplete",
     description="Create Zrb autocomplete script for zsh",
+    group=shell_autocomplete_group,
+    alias="zsh",
 )
 def make_zsh_autocomplete(ctx: Context):
     return _COMPLETION_SCRIPT
-
-
-shell_autocomplete_group.add_task(make_zsh_autocomplete, "zsh")