fastapi-startkit 0.21.0__tar.gz → 0.24.0__tar.gz

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi-startkit
-Version: 0.21.0
+Version: 0.24.0
 Summary: Fastapi Starter kit components
 Author: Bedram Tamang
 Author-email: Bedram Tamang <tmgbedu@gmail.com>

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-startkit"
-version = "0.21.0"
+version = "0.24.0"
 description = "Fastapi Starter kit components"
 authors = [
     {name = "Bedram Tamang", email = "tmgbedu@gmail.com"}

fastapi_startkit-0.24.0/src/fastapi_startkit/__init__.py

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

fastapi_startkit-0.24.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.21.0/src/fastapi_startkit/console.py → fastapi_startkit-0.24.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.24.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.21.0/src/fastapi_startkit/commands → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/fastapi/__init__.py

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

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.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
 
 
@@ -11,22 +11,22 @@ class ServeCommand(Command):
             "port",
             "p",
             flag=False,
-            default="8000",
-            description="The port to serve the application on",
+            default=None,
+            description="The port to serve the application on (overrides fastapi config)",
         ),
         option(
             "host",
             None,
             flag=False,
-            default="127.0.0.1",
-            description="The host to bind to",
+            default=None,
+            description="The host to bind to (overrides fastapi config)",
         ),
         option(
             "reload",
             "r",
             flag=False,
-            default=True,
-            description="Enable auto-reload on code changes",
+            default=None,
+            description="Enable auto-reload on code changes (overrides fastapi config)",
         ),
         option(
             "app",
@@ -39,12 +39,20 @@ class ServeCommand(Command):
 
     def handle(self):
         import uvicorn
+        from fastapi_startkit import Config
         from fastapi_startkit.container import Container
 
-        port = int(self.option("port"))
-        host = self.option("host")
+        # Resolve server settings: CLI flag > fastapi config > uvicorn default (None)
+        cfg_host = Config.get("fastapi.host", "127.0.0.1")
+        cfg_port = Config.get("fastapi.port", 8000)
+        cfg_reload = Config.get("fastapi.reload", True)
+        cfg_reload_dirs = Config.get("fastapi.reload_dirs") or None
+        cfg_reload_excludes = Config.get("fastapi.reload_excludes") or None
+
+        host = self.option("host") or cfg_host
+        port = int(self.option("port") or cfg_port)
+        reload = cfg_reload if self.option("reload") is None else self.option("reload")
         app = self.option("app")
-        reload = self.option("reload")
 
         exist = self.is_app_exist()
 
@@ -59,11 +67,13 @@ class ServeCommand(Command):
             kwargs.update(
                 {
                     "app": app,
-                    "reload": reload,
                     "factory": True,
-                    "reload_excludes": ["*.log", "tests/*"],
                 }
             )
+            if cfg_reload_dirs is not None:
+                kwargs["reload_dirs"] = cfg_reload_dirs
+            if cfg_reload_excludes is not None:
+                kwargs["reload_excludes"] = cfg_reload_excludes
 
             self.line(
                 f"<info>Starting Uvicorn server on {host}:{port} [{app}]...</info>"

fastapi_startkit-0.24.0/src/fastapi_startkit/fastapi/config/__init__.py

@@ -0,0 +1,3 @@
+from .fastapi import FastAPIConfig
+
+__all__ = ["FastAPIConfig"]

fastapi_startkit-0.24.0/src/fastapi_startkit/fastapi/config/fastapi.py

@@ -0,0 +1,24 @@
+import dataclasses
+
+from fastapi_startkit.environment import env
+
+
+@dataclasses.dataclass
+class FastAPIConfig:
+    """Server configuration for the uvicorn/FastAPI serve command.
+
+    All fields can be overridden via environment variables or by publishing a
+    ``config/fastapi.py`` file in the application root.
+    """
+
+    host: str = dataclasses.field(default_factory=lambda: env("APP_HOST", "127.0.0.1"))
+    port: int = dataclasses.field(default_factory=lambda: env("APP_PORT", 8000))
+    reload: bool = dataclasses.field(default_factory=lambda: env("APP_RELOAD", True))
+    reload_dirs: list | None = None
+    reload_excludes: list = dataclasses.field(
+        default_factory=lambda: [
+            "*.log",
+            "tests/*",
+            "node_modules/*",
+        ]
+    )

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/fastapi/providers/fastapi_provider.py

@@ -2,12 +2,18 @@ from fastapi_startkit.fastapi.exceptions import HTTPExceptionHandler, Validation
 from fastapi import FastAPI
 
 from fastapi_startkit.fastapi.commands import ServeCommand
+from fastapi_startkit.fastapi.config import FastAPIConfig
 from fastapi_startkit.providers import Provider
 
 
 class FastAPIProvider(Provider):
+    provider_key = "fastapi"
+
     def register(self) -> None:
         """Create a FastAPI instance and register routers."""
+        config = self.resolve_config(FastAPIConfig)
+        self.merge_config_from(config, self.provider_key)
+
         fastapi = FastAPI(
             title="Jobins AI Agent (LangChain)",
             version="1.0.0",
@@ -16,9 +22,16 @@ class FastAPIProvider(Provider):
         self.app.use_fastapi(fastapi)
 
     def boot(self):
+        import os
+
         self.commands([ServeCommand])
         self._register_exception_handlers()
 
+        source = os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "../config/fastapi.py")
+        )
+        self.publishes({source: "config/fastapi.py"})
+
     def _register_exception_handlers(self):
         """Wire exception_manager as a catch-all handler for all exceptions."""
         from fastapi import HTTPException

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/masoniteorm/__init__.py

@@ -1,6 +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"]
+__all__ = ["DatabaseProvider", "PostgresConfig", "MySQLConfig", "SQLiteConfig", "Model", "DB", "Migration", "Migrator"]

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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.21.0 → fastapi_startkit-0.24.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)

{fastapi_startkit-0.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/masoniteorm/commands/MigrateResetCommand.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 MigrateResetCommand(Command):
-    name = "migrate:reset"
+    name = "db:migrate:reset"
     description = "Reset migrations."
 
     options = [
@@ -21,13 +22,6 @@ class MigrateResetCommand(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",
@@ -43,14 +37,21 @@ class MigrateResetCommand(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.reset(self.option("migration"))
+
+    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.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/masoniteorm/commands/MigrateRollbackCommand.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 MigrateRollbackCommand(Command):
@@ -21,19 +22,6 @@ class MigrateRollbackCommand(Command):
             default="default",
             description="The connection you want to run migrations on",
         ),
-        option(
-            "show",
-            "s",
-            flag=True,
-            description="Shows the output of SQL for migrations that would be running",
-        ),
-        option(
-            "schema",
-            None,
-            flag=False,
-            default=None,
-            description="Sets the schema to be migrated",
-        ),
         option(
             "directory",
             "d",
@@ -49,12 +37,21 @@ class MigrateRollbackCommand(Command):
         return asyncio.run(self.handle_async())
 
     async def handle_async(self):
-        from ..migrations import Migration
+        directory = self.resolve_migration_path()
 
-        await Migration(
+        migration = Migrator(
             command_class=self,
             connection=self.option("connection"),
-            migration_directory=self.option("directory"),
-            config_path=self.option("config"),
-            schema=self.option("schema"),
-        ).rollback(migration=self.option("migration"), output=self.option("show"))
+            migration_directory=directory,
+        )
+
+        await migration.rollback(migration=self.option("migration"))
+
+    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.21.0 → fastapi_startkit-0.24.0}/src/fastapi_startkit/masoniteorm/commands/MigrateStatusCommand.py

@@ -1,6 +1,6 @@
 from cleo.helpers import option
-from ..migrations import Migration
-from .Command import Command
+from fastapi_startkit.console import Command
+from fastapi_startkit.masoniteorm.migrations.Migrator import Migrator
 
 
 class MigrateStatusCommand(Command):
@@ -15,13 +15,6 @@ class MigrateStatusCommand(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",
@@ -37,16 +30,17 @@ class MigrateStatusCommand(Command):
         return asyncio.run(self.handle_async())
 
     async def handle_async(self):
-        migration = Migration(
+        directory = self.resolve_migration_path()
+
+        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.create_table_if_not_exists()
         table = self.table()
-        table.set_header_row(["Ran?", "Migration", "Batch"])
+        table.set_headers(["Ran?", "Migration", "Batch"])
         migrations = []
 
         ran_migrations = await migration.get_ran_migrations()
@@ -74,4 +68,13 @@ class MigrateStatusCommand(Command):
 
         table.set_rows(migrations)
 
-        table.render(self.io)
+        table.render()
+
+    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)