zrb 0.28.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/config.py

@@ -0,0 +1,94 @@
+import os
+
+TRUE_STRS = ["true", "1", "yes", "y", "active", "on"]
+FALSE_STRS = ["false", "0", "no", "n", "inactive", "off"]
+
+APP_PATH = os.path.dirname(__file__)
+APP_VERSION = "0.1.0"
+
+APP_GATEWAY_VIEW_PATH = os.path.join(APP_PATH, "module", "gateway", "view")
+APP_GATEWAY_VIEW_DEFAULT_TEMPLATE_PATH = os.getenv(
+    "MY_APP_NAME_GATEWAY_VIEW_DEFAULT_TEMPLATE_PATH",
+    os.path.join("template", "default.html"),
+)
+APP_GATEWAY_PICO_CSS_COLOR = os.getenv("MY_APP_NAME_GATEWAY_PICO_CSS_COLOR", "")
+APP_GATEWAY_PICO_CSS_PATH = (
+    "/static/pico-css/pico.min.css"
+    if APP_GATEWAY_PICO_CSS_COLOR == ""
+    else f"/static/pico-css/pico.{APP_GATEWAY_PICO_CSS_COLOR}.min.css"
+)
+APP_GATEWAY_CSS_PATH_LIST = [
+    path
+    for path in os.getenv("MY_APP_NAME_GATEWAY_CSS_PATH", "").split(":")
+    if path != ""
+]
+APP_GATEWAY_JS_PATH_LIST = [
+    path
+    for path in os.getenv("MY_APP_NAME_GATEWAY_JS_PATH", "").split(":")
+    if path != ""
+]
+APP_GATEWAY_TITLE = os.getenv("MY_APP_NAME_GATEWAY_TITLE", "My App Name")
+APP_GATEWAY_SUBTITLE = os.getenv("MY_APP_NAME_GATEWAY_SUBTITLE", "Just Another App")
+APP_GATEWAY_LOGO_PATH = os.getenv(
+    "MY_APP_NAME_GATEWAY_LOGO", "/static/images/android-chrome-192x192.png"
+)
+APP_GATEWAY_FOOTER = os.getenv(
+    "MY_APP_NAME_GATEWAY_FOOTER", f"{APP_GATEWAY_TITLE} © 2025"
+)
+APP_GATEWAY_FAVICON_PATH = os.getenv(
+    "MY_APP_NAME_GATEWAY_FAVICON", "/static/images/favicon-32x32.png"
+)
+
+APP_MODE = os.getenv("MY_APP_NAME_MODE", "monolith")
+APP_MODULES = [
+    module.strip()
+    for module in os.getenv("MY_APP_NAME_MODULES", "").split(",")
+    if module.strip() != ""
+]
+APP_MAIN_MODULE = APP_MODULES[0] if len(APP_MODULES) > 0 else None
+APP_PORT = int(os.getenv("MY_APP_NAME_PORT", "3000"))
+APP_COMMUNICATION = os.getenv(
+    "MY_APP_NAME_COMMUNICATION", "direct" if APP_MODE == "monolith" else "api"
+)
+APP_REPOSITORY_TYPE = os.getenv("APP_REPOSITORY_TYPE", "db")
+APP_DB_URL = os.getenv(
+    "MY_APP_NAME_DB_URL",
+    (
+        f"sqlite:///{APP_PATH}/monolith.db"
+        if APP_MODE == "monolith" or len(APP_MODULES) == 0
+        else f"sqlite:///{APP_PATH}/{APP_MODULES[0]}_microservices.db"
+    ),
+)
+APP_AUTH_SUPER_USER = os.getenv("MY_APP_NAME_AUTH_SUPER_USER", "admin")
+APP_AUTH_SUPER_USER_PASSWORD = os.getenv(
+    "MY_APP_NAME_AUTH_SUPER_USER_PASSWORD", "my-secure-password"
+)
+APP_AUTH_GUEST_USER = os.getenv("MY_APP_NAME_AUTH_GUEST_USER", "user")
+APP_AUTH_GUEST_USER_PERMISSIONS = [
+    permission_name.strip()
+    for permission_name in os.getenv(
+        "MY_APP_NAME_AUTH_GUEST_USER_PERMISSIONS", ""
+    ).split(",")
+    if permission_name.strip() != ""
+]
+APP_AUTH_MAX_PARALLEL_SESSION = int(
+    os.getenv("MY_APP_NAME_AUTH_MAX_PARALLEL_SESSION", "1")
+)
+APP_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES = int(
+    os.getenv("MY_APP_NAME_AUTH_ACCESS_TOKEN_EXPIRE_MINUTES", "30")
+)
+APP_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES = int(
+    os.getenv("MY_APP_NAME_AUTH_REFRESH_TOKEN_EXPIRE_MINUTES", "1440")
+)
+APP_AUTH_ACCESS_TOKEN_COOKIE_NAME = os.getenv(
+    "MY_APP_NAME_AUTH_ACCESS_TOKEN_COOKIE_NAME", "access_token"
+)
+APP_AUTH_REFRESH_TOKEN_COOKIE_NAME = os.getenv(
+    "MY_APP_NAME_AUTH_REFRESH_TOKEN_COOKIE_NAME", "refresh_token"
+)
+APP_AUTH_SECRET_KEY = os.getenv("MY_APP_NAME_AUTH_SECRET_KEY", "my-secret-key")
+APP_AUTH_PRIORITIZE_NEW_SESSION = (
+    os.getenv("MY_APP_NAME_AUTH_PRIORITIZE_NEW_SESSION", "1").lower() in TRUE_STRS
+)
+
+APP_AUTH_BASE_URL = os.getenv("MY_APP_NAME_AUTH_BASE_URL", "http://localhost:3001")

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/main.py

@@ -0,0 +1,7 @@
+from my_app_name.common.app_factory import app
+from my_app_name.module.auth import route as auth_route
+from my_app_name.module.gateway import route as gateway_route
+
+assert app
+assert gateway_route
+assert auth_route

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/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/fastapp_template/my_app_name/module/auth/client/auth_api_client.py

@@ -0,0 +1,16 @@
+from my_app_name.config import APP_AUTH_BASE_URL
+from my_app_name.module.auth.client.auth_client import AuthClient
+from my_app_name.module.auth.service.permission.permission_service_factory import (
+    permission_service,
+)
+from my_app_name.module.auth.service.role.role_service_factory import role_service
+from my_app_name.module.auth.service.user.user_service_factory import user_service
+
+
+class AuthAPIClient(
+    permission_service.as_api_client(base_url=APP_AUTH_BASE_URL),
+    role_service.as_api_client(base_url=APP_AUTH_BASE_URL),
+    user_service.as_api_client(base_url=APP_AUTH_BASE_URL),
+    AuthClient,
+):
+    pass

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/client/auth_client.py

@@ -0,0 +1,190 @@
+from abc import ABC, abstractmethod
+
+from my_app_name.schema.permission import (
+    MultiplePermissionResponse,
+    PermissionCreateWithAudit,
+    PermissionResponse,
+    PermissionUpdateWithAudit,
+)
+from my_app_name.schema.role import (
+    MultipleRoleResponse,
+    RoleCreateWithPermissionsAndAudit,
+    RoleResponse,
+    RoleUpdateWithPermissionsAndAudit,
+)
+from my_app_name.schema.user import (
+    AuthUserResponse,
+    MultipleUserResponse,
+    UserCreateWithRolesAndAudit,
+    UserCredentials,
+    UserResponse,
+    UserSessionResponse,
+    UserUpdateWithRolesAndAudit,
+)
+
+
+class AuthClient(ABC):
+
+    @abstractmethod
+    async def get_current_user(self, access_token: str) -> AuthUserResponse:
+        """Get current user based on access token"""
+
+    @abstractmethod
+    async def create_user_session(
+        self, credential: UserCredentials
+    ) -> UserSessionResponse:
+        """Create new user session"""
+
+    @abstractmethod
+    async def update_user_session(self, refresh_token: str) -> UserSessionResponse:
+        """Update user session"""
+
+    @abstractmethod
+    async def delete_user_session(self, refresh_token: str) -> UserSessionResponse:
+        """Delete user session"""
+
+    # Permission related methods
+
+    @abstractmethod
+    async def get_permission_by_id(self, permission_id: str) -> PermissionResponse:
+        """Get permission by id"""
+
+    @abstractmethod
+    async def get_permissions(
+        self,
+        page: int = 1,
+        page_size: int = 10,
+        sort: str | None = None,
+        filter: str | None = None,
+    ) -> MultiplePermissionResponse:
+        """Get permissions by filter and sort"""
+
+    @abstractmethod
+    async def create_permission_bulk(
+        self, data: list[PermissionCreateWithAudit]
+    ) -> list[PermissionResponse]:
+        """Create new permissions"""
+
+    @abstractmethod
+    async def create_permission(
+        self, data: PermissionCreateWithAudit
+    ) -> PermissionResponse:
+        """Create a new permission"""
+
+    @abstractmethod
+    async def update_permission_bulk(
+        self, permission_ids: list[str], data: PermissionUpdateWithAudit
+    ) -> PermissionResponse:
+        """Update some permissions"""
+
+    @abstractmethod
+    async def update_permission(
+        self, permission_id: str, data: PermissionUpdateWithAudit
+    ) -> PermissionResponse:
+        """Update a permission"""
+
+    @abstractmethod
+    async def delete_permission_bulk(
+        self, permission_ids: str, deleted_by: str
+    ) -> PermissionResponse:
+        """Delete some permissions"""
+
+    @abstractmethod
+    async def delete_permission(
+        self, permission_id: str, deleted_by: str
+    ) -> PermissionResponse:
+        """Delete a permission"""
+
+    # Role related methods
+
+    @abstractmethod
+    async def get_role_by_id(self, role_id: str) -> RoleResponse:
+        """Get role by id"""
+
+    @abstractmethod
+    async def get_roles(
+        self,
+        page: int = 1,
+        page_size: int = 10,
+        sort: str | None = None,
+        filter: str | None = None,
+    ) -> MultipleRoleResponse:
+        """Get roles by filter and sort"""
+
+    @abstractmethod
+    async def create_role_bulk(
+        self, data: list[RoleCreateWithPermissionsAndAudit]
+    ) -> list[RoleResponse]:
+        """Create new roles"""
+
+    @abstractmethod
+    async def create_role(
+        self, data: RoleCreateWithPermissionsAndAudit
+    ) -> RoleResponse:
+        """Create a new role"""
+
+    @abstractmethod
+    async def update_role_bulk(
+        self, role_ids: list[str], data: RoleUpdateWithPermissionsAndAudit
+    ) -> RoleResponse:
+        """Update some roles"""
+
+    @abstractmethod
+    async def update_role(
+        self, role_id: str, data: RoleUpdateWithPermissionsAndAudit
+    ) -> RoleResponse:
+        """Update a role"""
+
+    @abstractmethod
+    async def delete_role_bulk(self, role_ids: str, deleted_by: str) -> RoleResponse:
+        """Delete some roles"""
+
+    @abstractmethod
+    async def delete_role(self, role_id: str, deleted_by: str) -> RoleResponse:
+        """Delete a role"""
+
+    # User related methods
+
+    @abstractmethod
+    async def get_user_by_id(self, user_id: str) -> UserResponse:
+        """Get user by id"""
+
+    @abstractmethod
+    async def get_users(
+        self,
+        page: int = 1,
+        page_size: int = 10,
+        sort: str | None = None,
+        filter: str | None = None,
+    ) -> MultipleUserResponse:
+        """Get users by filter and sort"""
+
+    @abstractmethod
+    async def create_user_bulk(
+        self, data: list[UserCreateWithRolesAndAudit]
+    ) -> list[UserResponse]:
+        """Create new users"""
+
+    @abstractmethod
+    async def create_user(self, data: UserCreateWithRolesAndAudit) -> UserResponse:
+        """Create a new user"""
+
+    @abstractmethod
+    async def update_user_bulk(
+        self, user_ids: list[str], data: UserUpdateWithRolesAndAudit
+    ) -> UserResponse:
+        """Update some users"""
+
+    @abstractmethod
+    async def update_user(
+        self, user_id: str, data: UserUpdateWithRolesAndAudit
+    ) -> UserResponse:
+        """Update a user"""
+
+    @abstractmethod
+    async def delete_user_bulk(self, user_ids: str, deleted_by: str) -> UserResponse:
+        """Delete some users"""
+
+    @abstractmethod
+    async def delete_user(self, user_id: str, deleted_by: str) -> UserResponse:
+        """Delete a user"""

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/client/auth_client_factory.py

@@ -0,0 +1,9 @@
+from my_app_name.config import APP_COMMUNICATION
+from my_app_name.module.auth.client.auth_api_client import AuthAPIClient
+from my_app_name.module.auth.client.auth_client import AuthClient
+from my_app_name.module.auth.client.auth_direct_client import AuthDirectClient
+
+if APP_COMMUNICATION == "direct":
+    auth_client: AuthClient = AuthDirectClient()
+elif APP_COMMUNICATION == "api":
+    auth_client: AuthClient = AuthAPIClient()

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/client/auth_direct_client.py

@@ -0,0 +1,15 @@
+from my_app_name.module.auth.client.auth_client import AuthClient
+from my_app_name.module.auth.service.permission.permission_service_factory import (
+    permission_service,
+)
+from my_app_name.module.auth.service.role.role_service_factory import role_service
+from my_app_name.module.auth.service.user.user_service_factory import user_service
+
+
+class AuthDirectClient(
+    permission_service.as_direct_client(),
+    role_service.as_direct_client(),
+    user_service.as_direct_client(),
+    AuthClient,
+):
+    pass

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/migration/README

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

zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/module/auth/migration/env.py

@@ -0,0 +1,106 @@
+from logging.config import fileConfig
+
+from alembic import context
+from my_app_name.config import APP_DB_URL
+from my_app_name.module.auth.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_auth"
+# 🔥 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"},
+        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,
+            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/fastapp_template/my_app_name/module/auth/migration/script.py.mako

@@ -0,0 +1,27 @@
+"""${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
+import sqlmodel  # 🔥 FastApp Modification
+${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"}