fastapi-startkit 0.20.0__tar.gz → 0.22.0__tar.gz

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi-startkit
-Version: 0.20.0
+Version: 0.22.0
 Summary: Fastapi Starter kit components
 Author: Bedram Tamang
 Author-email: Bedram Tamang <tmgbedu@gmail.com>
@@ -15,6 +15,8 @@ Requires-Dist: faker>=40.13.0 ; extra == 'database'
 Requires-Dist: sqlalchemy[asyncio]>=2.0.38 ; extra == 'database'
 Requires-Dist: fastapi[standard]>=0.124.4,<0.125.0 ; extra == 'fastapi'
 Requires-Dist: itsdangerous>=2.2.0 ; extra == 'fastapi'
+Requires-Dist: jinja2>=3.1 ; extra == 'inertia'
+Requires-Dist: markupsafe>=2.0 ; extra == 'inertia'
 Requires-Dist: aiomysql>=0.2.0 ; extra == 'mysql'
 Requires-Dist: asyncpg>=0.29.0 ; extra == 'postgres'
 Requires-Dist: aiosqlite>=0.22.1 ; extra == 'sqlite'
@@ -22,6 +24,7 @@ Requires-Dist: jinja2>=3.1 ; extra == 'vite'
 Requires-Python: >=3.12, <4.0
 Provides-Extra: database
 Provides-Extra: fastapi
+Provides-Extra: inertia
 Provides-Extra: mysql
 Provides-Extra: postgres
 Provides-Extra: sqlite

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-startkit"
-version = "0.20.0"
+version = "0.22.0"
 description = "Fastapi Starter kit components"
 authors = [
     {name = "Bedram Tamang", email = "tmgbedu@gmail.com"}
@@ -42,6 +42,11 @@ vite=[
     "jinja2>=3.1",
 ]
 
+inertia = [
+    "jinja2>=3.1",
+    "markupsafe>=2.0",
+]
+
 [dependency-groups]
 dev = [
     "dumpdie>=1.5.0",

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/__init__.py

@@ -1,4 +1,5 @@
 from .application import Application
+from .console import ConsoleApplication
 from .configuration.config import Config
 
 __all__ = ["Application", "Config"]

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/application.py

@@ -112,6 +112,12 @@ class Application(Container, Generic[TConfig]):
     def use_base_path(self, path: str):
         return self.base_path / path
 
+    def storage_path(self, path: str = "") -> str:
+        return str(self.base_path / "storage" / path)
+
+    def public_path(self, path: str = "") -> str:
+        return str(self.base_path / "public" / path)
+
     def get(self, path: str, **kwargs) -> Callable:
         return self.fastapi.get(path, **kwargs)
 

fastapi_startkit-0.22.0/src/fastapi_startkit/console/__init__.py

@@ -0,0 +1,7 @@
+from .application import ConsoleApplication
+from .command import Command
+
+__all__ = [
+    "ConsoleApplication",
+    "Command"
+]

fastapi_startkit-0.20.0/src/fastapi_startkit/console.py → fastapi_startkit-0.22.0/src/fastapi_startkit/console/application.py

@@ -1,19 +1,26 @@
+from typing import TYPE_CHECKING
+
 from cleo.application import Application as BaseApplication
 from cleo.io.io import IO
-from fastapi_startkit.application import Application
+
+if TYPE_CHECKING:
+    from fastapi_startkit.application import Application
 
 
 class ConsoleApplication(BaseApplication):
-    def __init__(self, app: Application):
+    def __init__(self, app: "Application"):
         super().__init__()
         self.app = app
 
         # Register commands from Application
         for command in self.app.commands:
             if isinstance(command, type):
-                self.add(command())
+                instance = command()
             else:
-                self.add(command)
+                instance = command
+
+            instance.set_container(self.app)
+            self.add(instance)
 
     def render_error(self, error: Exception, io: IO) -> None:
         self.app.exception_manager.report(error)

fastapi_startkit-0.22.0/src/fastapi_startkit/console/command.py

@@ -0,0 +1,14 @@
+from typing import TYPE_CHECKING
+
+from .can_override_config import CanOverrideConfig
+from .can_override_default_options import CanOverrideOptionsDefault
+
+if TYPE_CHECKING:
+    from fastapi_startkit import Application
+
+
+class Command(CanOverrideOptionsDefault, CanOverrideConfig):
+    container: "Application"
+
+    def set_container(self, container: "Application") -> None:
+        self.container = container

{fastapi_startkit-0.20.0/src/fastapi_startkit/commands → fastapi_startkit-0.22.0/src/fastapi_startkit/console}/publish_command.py

@@ -2,7 +2,7 @@ import os
 import shutil
 from typing import TYPE_CHECKING
 
-from cleo.commands.command import Command
+from fastapi_startkit.console import Command
 from cleo.helpers import option
 from fastapi_startkit.helpers.string import Str
 

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/exceptions/__init__.py

@@ -27,6 +27,7 @@ from .exceptions import (
     InvalidPackageName,
     LoaderNotFound,
     QueueException,
+    ValidationException,
     AmbiguousError,
     MethodNotAllowedException,
     ModelNotFoundException,

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/exceptions/exceptions.py

@@ -216,3 +216,9 @@ class InvalidPackageName(Exception):
 
 class LoaderNotFound(Exception):
     pass
+
+
+class ValidationException(Exception):
+    def __init__(self, errors: dict):
+        super().__init__("The given data was invalid.")
+        self.errors = errors

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/facades/__init__.py

@@ -11,7 +11,6 @@ from .Auth import Auth
 from .Config import Config
 from .Loader import Loader
 from .Notification import Notification
-from .Storage import Storage
 from .Dump import Dump
 from .Queue import Queue
 from .Cache import Cache

fastapi_startkit-0.22.0/src/fastapi_startkit/fastapi/__init__.py

@@ -0,0 +1,5 @@
+from .providers.fastapi_provider import FastAPIProvider
+from .routers.router import Router
+from .requests.model import RequestModel
+
+__all__ = ["FastAPIProvider", "Router", "RequestModel"]

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/fastapi/commands/serve_command.py

@@ -1,4 +1,4 @@
-from cleo.commands.command import Command
+from fastapi_startkit.console.command import Command
 from cleo.helpers import option
 
 

fastapi_startkit-0.22.0/src/fastapi_startkit/fastapi/exceptions.py

@@ -0,0 +1,70 @@
+class HTTPExceptionHandler:
+    """
+    The base exception handler for FastAPI applications.
+    """
+
+    async def render(self, request, exc):
+        import traceback
+        from fastapi.responses import JSONResponse
+        from fastapi_startkit.container import Container
+
+        app = Container.instance()
+        if app.is_debug():
+            tb = exc.__traceback__
+            frames = traceback.extract_tb(tb)
+            content = {
+                "message": str(exc),
+                "exception": f"{type(exc).__module__}.{type(exc).__qualname__}",
+                "file": frames[-1].filename if frames else None,
+                "line": frames[-1].lineno if frames else None,
+                "trace": [
+                    {"file": f.filename, "line": f.lineno, "function": f.name}
+                    for f in frames
+                ],
+            }
+        else:
+            content = {"message": "Server Error"}
+
+        return JSONResponse(status_code=500, content=content)
+
+
+class ValidationExceptionHandler:
+    """
+    Handles RequestValidationError with content negotiation.
+
+    JSON requests (API clients) receive a 422 Unprocessable Entity response.
+    Non-JSON requests (browser/Inertia) have errors flashed to the session
+    and are redirected back to the referring page.
+    """
+
+    def report(self, exc) -> None:
+        pass
+
+    async def render(self, request, exc):
+        accept = request.headers.get("accept", "")
+        content_type = request.headers.get("content-type", "")
+
+        wants_json = (
+            "application/json" in accept
+            or content_type.startswith("application/json")
+        )
+
+        errors = {}
+        for err in exc.errors():
+            field = ".".join(str(x) for x in err["loc"][1:])
+            errors.setdefault(field, []).append(err["msg"])
+
+        if wants_json:
+            from fastapi.responses import JSONResponse
+
+            return JSONResponse(status_code=422, content={"errors": errors})
+
+        if "session" in request.scope:
+            request.session["errors"] = errors
+
+        from starlette.responses import RedirectResponse
+
+        return RedirectResponse(
+            url=request.headers.get("referer", "/"),
+            status_code=303,
+        )

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/fastapi/providers/fastapi_provider.py

@@ -1,4 +1,4 @@
-from fastapi_startkit.fastapi.exceptions import HTTPExceptionHandler
+from fastapi_startkit.fastapi.exceptions import HTTPExceptionHandler, ValidationExceptionHandler
 from fastapi import FastAPI
 
 from fastapi_startkit.fastapi.commands import ServeCommand
@@ -21,10 +21,19 @@ class FastAPIProvider(Provider):
 
     def _register_exception_handlers(self):
         """Wire exception_manager as a catch-all handler for all exceptions."""
+        from fastapi import HTTPException
+        from fastapi.exceptions import RequestValidationError
+
         exception_manager = self.app.exception_manager
         exception_manager.register_handler(Exception, HTTPExceptionHandler())
+        exception_manager.register_handler(HTTPException, HTTPExceptionHandler())
+        exception_manager.register_handler(RequestValidationError, ValidationExceptionHandler())
 
         async def handler(request, exc):
             return await exception_manager.handle(exc, {"request": request})
 
+        # FastAPI registers its own handlers for these two types internally,
+        # so they must be overridden explicitly
+        self.app.fastapi.add_exception_handler(HTTPException, handler)
+        self.app.fastapi.add_exception_handler(RequestValidationError, handler)
         self.app.fastapi.add_exception_handler(Exception, handler)

fastapi_startkit-0.22.0/src/fastapi_startkit/fastapi/requests/model.py

@@ -0,0 +1,34 @@
+import inspect
+
+from fastapi import Form
+from fastapi.params import Query as QueryParam
+from pydantic import BaseModel
+
+
+class RequestModel(BaseModel):
+    @classmethod
+    def __pydantic_init_subclass__(cls, **kwargs):
+        super().__pydantic_init_subclass__(**kwargs)
+
+        params = []
+        for name, field in cls.model_fields.items():
+            if isinstance(field, QueryParam):
+                default = field
+            elif field.is_required():
+                default = Form(...)
+            else:
+                default = Form(default=field.default)
+
+            params.append(
+                inspect.Parameter(
+                    name,
+                    inspect.Parameter.POSITIONAL_OR_KEYWORD,
+                    default=default,
+                    annotation=field.annotation,
+                )
+            )
+
+        cls.__signature__ = inspect.Signature(params)
+
+    def validated(self) -> dict:
+        return {k: v for k, v in self.model_dump().items() if v}

fastapi_startkit-0.22.0/src/fastapi_startkit/helpers/app.py

@@ -0,0 +1,9 @@
+def storage_path(path: str = "") -> str:
+    """Get the path to the storage directory."""
+    from fastapi_startkit.application import app
+    return app().storage_path(path)
+
+def public_path(path: str = "") -> str:
+    """Get the path to the public directory."""
+    from fastapi_startkit.application import app
+    return app().public_path(path)

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/inertia/middleware.py

@@ -94,7 +94,7 @@ class InertiaMiddleware(BaseHTTPMiddleware):
     def resolve_validation_errors(request: Request) -> dict:
         if "session" not in request.scope:
             return {}
-        return request.session.get("errors", {})
+        return request.session.pop("errors", {})
 
     @staticmethod
     def reflash(request: Request) -> None:

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/inertia/provider.py

@@ -1,4 +1,5 @@
 import json
+from markupsafe import Markup
 from fastapi_startkit.providers import Provider
 from .inertia import Inertia
 from .middleware import InertiaMiddleware
@@ -8,33 +9,20 @@ class InertiaProvider(Provider):
     provider_key = "inertia"
 
     def register(self) -> None:
-        """Bind the Inertia class to the container."""
         self.app.bind("inertia", Inertia)
 
     def boot(self) -> None:
-        """Configure template globals and middleware."""
-        # 1. Register Middleware
-        # We add it to the FastAPI instance via the application helper
         self.app.add_middleware(InertiaMiddleware)
 
-        # 2. Register Template Globals
         if self.app.has("templates"):
             templates = self.app.make("templates")
 
-            try:
-                from markupsafe import Markup
-            except ImportError:
-                Markup = str
-
             def inertia_helper(page):
-                """Jinja2 helper to render the root div for Inertia."""
                 encoded_page = json.dumps(page)
-                # Ensure single quotes are used for the attribute to avoid conflict with JSON double quotes
                 return Markup(
                     f'<script data-page="app" type="application/json">{encoded_page}</script><div id="app"></div>'
                 )
 
             templates.env.globals["inertia"] = inertia_helper
-
-            # Also share the inertia instance itself if needed
             templates.env.globals["Inertia"] = self.app.make("inertia")
+

fastapi_startkit-0.22.0/src/fastapi_startkit/masoniteorm/__init__.py

@@ -0,0 +1,8 @@
+from .config.config import MySQLConfig, PostgresConfig, SQLiteConfig
+from .facades import DB
+from .migrations.Migration import Migration
+from .migrations.Migrator import Migrator
+from .models import Model
+from .providers import DatabaseProvider
+
+__all__ = ["DatabaseProvider", "PostgresConfig", "MySQLConfig", "SQLiteConfig", "Model", "DB", "Migration", "Migrator"]

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/DBMigrateCommand.py

@@ -1,7 +1,10 @@
 import os
-from .Command import Command
+
 from cleo.helpers import option
 
+from fastapi_startkit.console import Command
+from fastapi_startkit.masoniteorm.migrations.Migrator import Migrator
+
 
 class DBMigrateCommand(Command):
     name = "db:migrate"
@@ -28,12 +31,6 @@ class DBMigrateCommand(Command):
             flag=True,
             description="Force migrations without prompt in production",
         ),
-        option(
-            "show",
-            "s",
-            flag=True,
-            description="Shows the output of SQL for migrations that would be running",
-        ),
         option(
             "directory",
             "d",
@@ -49,29 +46,42 @@ class DBMigrateCommand(Command):
         return asyncio.run(self.handle_async())
 
     async def handle_async(self):
-        from ..migrations import Migration
+        self.confirm_to_proceed()
 
-        # prompt user for confirmation in production
-        if os.getenv("APP_ENV") == "production" and not self.option("force"):
-            answer = ""
-            while answer not in ["y", "n"]:
-                answer = input(
-                    "Do you want to run migrations in PRODUCTION ? (y/n)\n"
-                ).lower()
-            if answer != "y":
-                self.info("Migrations cancelled")
-                exit(0)
-        migration = Migration(
+        directory = self.resolve_migration_path()
+
+        migration = Migrator(
             command_class=self,
             connection=self.option("connection"),
-            migration_directory=self.option("directory"),
+            migration_directory=directory,
         )
+
         await migration.create_table_if_not_exists()
         if not await migration.get_unran_migrations():
             self.info("Nothing To Migrate!")
             return
 
         migration_name = self.option("migration")
-        show_output = self.option("show")
 
-        await migration.migrate(migration=migration_name, output=show_output)
+        await migration.migrate(migration=migration_name)
+
+    def resolve_migration_path(self) -> str:
+        path = self.option('directory')
+
+        config = self.container.make('config').get('database.migrations')
+        default_directory = config.get('directory')
+
+        migration_directory = path or default_directory
+        return self.container.use_base_path(migration_directory)
+
+    def confirm_to_proceed(self) -> None:
+        # prompt user for confirmation in production
+        if os.getenv("APP_ENV") == "production" and not self.option("force"):
+            answer = ""
+            while answer not in ["y", "n"]:
+                answer = input(
+                    "Do you want to run migrations in PRODUCTION ? (y/n)\n"
+                ).lower()
+            if answer != "y":
+                self.info("Migrations cancelled")
+                exit(0)

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/DBSeedCommand.py

@@ -1,7 +1,7 @@
 from cleo.helpers import argument, option
 from inflection import camelize, underscore
 
-from .Command import Command
+from fastapi_startkit.console import Command
 
 
 class DBSeedCommand(Command):

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MakeMigrationCommand.py

@@ -4,7 +4,7 @@ import pathlib
 from inflection import tableize
 from cleo.helpers import argument, option
 from fastapi_startkit.helpers.string import Str
-from .Command import Command
+from fastapi_startkit.console import Command
 
 
 class MakeMigrationCommand(Command):

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MakeModelCommand.py

@@ -1,7 +1,7 @@
 import os
 import pathlib
 from inflection import camelize, tableize, underscore
-from .Command import Command
+from fastapi_startkit.console import Command
 from cleo.helpers import argument, option
 
 

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MakeModelDocstringCommand.py

@@ -1,6 +1,6 @@
 from cleo.helpers import argument, option
 from ..config import load_config
-from .Command import Command
+from fastapi_startkit.console import Command
 
 
 class MakeModelDocstringCommand(Command):

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MakeObserverCommand.py

@@ -2,7 +2,7 @@ from cleo.helpers import argument, option
 import os
 import pathlib
 from inflection import camelize, underscore
-from .Command import Command
+from fastapi_startkit.console import Command
 
 
 class MakeObserverCommand(Command):

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MakeSeedCommand.py

@@ -2,7 +2,7 @@ from cleo.helpers import argument, option
 import os
 import pathlib
 from inflection import camelize, underscore
-from .Command import Command
+from fastapi_startkit.console import Command
 
 
 class MakeSeedCommand(Command):

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MigrateFreshCommand.py

@@ -1,5 +1,6 @@
 from cleo.helpers import option
-from .Command import Command
+from fastapi_startkit.console import Command
+from fastapi_startkit.masoniteorm.migrations.Migrator import Migrator
 
 
 class MigrateFreshCommand(Command):
@@ -49,12 +50,12 @@ class MigrateFreshCommand(Command):
         return asyncio.run(self.handle_async())
 
     async def handle_async(self):
-        from ..migrations import Migration
+        directory = self.resolve_migration_path()
 
-        migration = Migration(
+        migration = Migrator(
             command_class=self,
             connection=self.option("connection"),
-            migration_directory=self.option("directory"),
+            migration_directory=directory,
         )
 
         await migration.fresh(ignore_fk=not self.option("no-fk"))
@@ -69,3 +70,12 @@ class MigrateFreshCommand(Command):
                 "seed:run",
                 f"{self.option('seed')} --directory {self.option('seed-directory')} --connection {self.option('connection')}",
             )
+
+    def resolve_migration_path(self) -> str:
+        path = self.option('directory')
+
+        config = self.container.make('config').get('database.migrations')
+        default_directory = config.get('directory')
+
+        migration_directory = path or default_directory
+        return self.container.use_base_path(migration_directory)

{fastapi_startkit-0.20.0 → fastapi_startkit-0.22.0}/src/fastapi_startkit/masoniteorm/commands/MigrateRefreshCommand.py

@@ -1,9 +1,10 @@
 from cleo.helpers import option
-from .Command import Command
+from fastapi_startkit.console import Command
+from fastapi_startkit.masoniteorm.migrations.Migrator import Migrator
 
 
 class MigrateRefreshCommand(Command):
-    name = "migrate:refresh"
+    name = "db:migrate:refresh"
     description = "Refresh migrations."
 
     options = [
@@ -21,13 +22,6 @@ class MigrateRefreshCommand(Command):
             default="default",
             description="The connection you want to run migrations on",
         ),
-        option(
-            "schema",
-            None,
-            flag=False,
-            default=None,
-            description="Sets the schema to be migrated",
-        ),
         option(
             "directory",
             "d",
@@ -57,14 +51,12 @@ class MigrateRefreshCommand(Command):
         return asyncio.run(self.handle_async())
 
     async def handle_async(self):
-        from ..migrations import Migration
+        directory = self.resolve_migration_path()
 
-        migration = Migration(
+        migration = Migrator(
             command_class=self,
             connection=self.option("connection"),
-            migration_directory=self.option("directory"),
-            config_path=self.option("config"),
-            schema=self.option("schema"),
+            migration_directory=directory,
         )
 
         await migration.refresh(self.option("migration"))
@@ -79,3 +71,12 @@ class MigrateRefreshCommand(Command):
                 "seed:run",
                 f"{self.option('seed')} --directory {self.option('seed-directory')} --connection {self.option('connection')}",
             )
+
+    def resolve_migration_path(self) -> str:
+        path = self.option('directory')
+
+        config = self.container.make('config').get('database.migrations')
+        default_directory = config.get('directory')
+
+        migration_directory = path or default_directory
+        return self.container.use_base_path(migration_directory)