coloco 0.3.5__tar.gz → 0.3.6__tar.gz

{coloco-0.3.5 → coloco-0.3.6}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.1
 Name: coloco
-Version: 0.3.5
+Version: 0.3.6
 Summary: A kit for creating FastAPI + Svelte applications
 Author-Email: Channel Cat <channelcat@gmail.com>
 License: MIT
-Requires-Python: >=3.11
-Requires-Dist: aerich[toml]>=0.8.1
+Requires-Python: >=3.12
+Requires-Dist: cyclopts>=3.18.0
 Requires-Dist: fastapi>=0.115.0
 Requires-Dist: PyJWT>=2.10.1
 Requires-Dist: tortoise-orm[asyncpg]>=0.24.0
-Requires-Dist: type-less>=0.1.8
-Requires-Dist: typer>=0.15.2
+Requires-Dist: tortoise-pathway==0.1.6
+Requires-Dist: type-less>=0.1.16
 Requires-Dist: uvicorn>=0.31.0
 Description-Content-Type: text/markdown
 
@@ -69,23 +69,28 @@ This framework is opinionated and combines the following excellent tools:
 - svelte5-router (file-based routing)
 - tortoise-orm (optional)
 
-# Plans
+# TBD Required features for launch
 
 - Deploy tools
-- Migrations for ORM - `aerich` (Improvements needed, watching `tortoise-pathway`)
+- Swap migrations to `tortoise-pathway` once cross-app migrations are supported
+- Config with secrets encryption
+- Package/share modules with git
+- Docs
+
+# Features in development
+
 - CRUD
 - Caching
-- Package/share modules with git
-- 
+- User module
+- Dev tools module
+- Admin panel module
 
 # Dreams
 
 - Move `node_modules` into `+node`
-- Somehow clean up litter from `uv`
 
-# TODO
+# Other TODO
 
-- Swap to `cyclopts` for CLI
 - Swap to `copier` for template creation
 - `Textual` CLI app / installer / dev tools?
-- Common dev `admin` module
+- Resolve duplicate types in openapi spec (due to model serializers)

{coloco-0.3.5 → coloco-0.3.6}/README.md

@@ -53,23 +53,28 @@ This framework is opinionated and combines the following excellent tools:
 - svelte5-router (file-based routing)
 - tortoise-orm (optional)
 
-# Plans
+# TBD Required features for launch
 
 - Deploy tools
-- Migrations for ORM - `aerich` (Improvements needed, watching `tortoise-pathway`)
+- Swap migrations to `tortoise-pathway` once cross-app migrations are supported
+- Config with secrets encryption
+- Package/share modules with git
+- Docs
+
+# Features in development
+
 - CRUD
 - Caching
-- Package/share modules with git
-- 
+- User module
+- Dev tools module
+- Admin panel module
 
 # Dreams
 
 - Move `node_modules` into `+node`
-- Somehow clean up litter from `uv`
 
-# TODO
+# Other TODO
 
-- Swap to `cyclopts` for CLI
 - Swap to `copier` for template creation
 - `Textual` CLI app / installer / dev tools?
-- Common dev `admin` module
+- Resolve duplicate types in openapi spec (due to model serializers)

{coloco-0.3.5 → coloco-0.3.6}/pyproject.toml

@@ -1,20 +1,20 @@
 [project]
 name = "coloco"
-version = "0.3.5"
+version = "0.3.6"
 description = "A kit for creating FastAPI + Svelte applications"
 authors = [
     { name = "Channel Cat", email = "channelcat@gmail.com" },
 ]
 dependencies = [
-    "aerich[toml]>=0.8.1",
+    "cyclopts>=3.18.0",
     "fastapi>=0.115.0",
     "PyJWT>=2.10.1",
     "tortoise-orm[asyncpg]>=0.24.0",
-    "type-less>=0.1.8",
-    "typer>=0.15.2",
+    "tortoise-pathway==0.1.6",
+    "type-less>=0.1.16",
     "uvicorn>=0.31.0",
 ]
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 readme = "README.md"
 
 [project.license]
@@ -31,3 +31,7 @@ build-backend = "pdm.backend"
 
 [tool.pdm]
 distribution = true
+
+[tool.uv.sources.tortoise-pathway]
+git = "https://github.com/channelcat/tortoise-pathway"
+rev = "multi-app-support"

{coloco-0.3.5 → coloco-0.3.6}/src/coloco/__main__.py

@@ -1,16 +1,16 @@
-import typer
 from .cli.dev import dev
 from .cli.api import app as api_app
 from .cli.node import app as node_app
 from .cli.createapp import createapp
 from .cli.build import build
 from .cli.serve import serve
+import cyclopts
 
-app = typer.Typer()
+app = cyclopts.App()
 
-app.command()(dev)
-app.add_typer(node_app, name="node")
-app.add_typer(api_app, name="api")
+app.command(dev, name="dev")
+app.command(node_app, name="node")
+app.command(api_app, name="api")
 app.command()(build)
 app.command()(createapp)
 app.command()(serve)
@@ -19,7 +19,7 @@ app.command()(serve)
 try:
     from .cli.db import app as db_app
 
-    app.add_typer(db_app, name="db")
+    app.command(db_app, name="db")
 except ImportError:
     pass
 

{coloco-0.3.5 → coloco-0.3.6}/src/coloco/api.py

@@ -4,19 +4,33 @@ from .codegen import (
     generate_openapi_schema,
 )
 from contextlib import asynccontextmanager
+from dataclasses import dataclass
 from .exceptions import bind_exceptions
 from fastapi import APIRouter, FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from .lifespan import execute_lifespan, register_lifespan
 import logging
 from os import environ
-from type_less import fill_type_hints
 from threading import Thread
+from type_less import fill_type_hints
+from typing import Callable, TypeVar
 
 
 logging.basicConfig(level=logging.INFO)
 
 
+T = TypeVar("T")
+
+
+@dataclass
+class ColocoRoute:
+    args: tuple
+    kwargs: dict
+    func: Callable
+    method: str
+    module_name: str
+
+
 def _generate_openapi_thread(app: FastAPI):
     # TODO: diff check the schema json
     # TODO: diff check not working
@@ -35,16 +49,17 @@ async def generate_openapi(app: FastAPI):
 
 
 def create_api(is_dev: bool = False):
+    kwargs = {
+        "lifespan": execute_lifespan,
+    }
     if not is_dev:
         kwargs = {
+            **kwargs,
             "openapi_url": None,
             "docs_url": None,
             "redoc_url": None,
         }
     else:
-        kwargs = {
-            "lifespan": execute_lifespan,
-        }
         register_lifespan(generate_openapi)
 
     api = FastAPI(
@@ -62,7 +77,6 @@ def create_api(is_dev: bool = False):
         allow_headers=["*"],
     )
 
-    # bind_static(api)
     bind_exceptions(api, debug=is_dev)
 
     return api
@@ -70,7 +84,7 @@ def create_api(is_dev: bool = False):
 
 # ========================= Global routing =========================
 
-global_router = APIRouter()
+global_routes: list[ColocoRoute] = []
 
 
 def api(func):
@@ -79,8 +93,6 @@ def api(func):
 
 
 def _add_global_route(args, kwargs, func, method: str):
-    fill_type_hints(func, use_literals=True)
-
     module_name = func.__module__.lstrip("src.app")
 
     # Prepend module name to path
@@ -101,18 +113,11 @@ def _add_global_route(args, kwargs, func, method: str):
     else:
         kwargs["path"] = path
 
-    return global_router.api_route(
-        *args,
-        **{
-            **kwargs,
-            "summary": (kwargs.get("summary", "") + f" ({module_name})").strip(),
-            "methods": [method],
-        },
-    )(func)
+    return global_routes.append(ColocoRoute(args, kwargs, func, method, module_name))
 
 
-def _make_route_decorator(method: str):
-    def route_wrapper(*args, **kwargs):
+def _make_route_decorator(method: str) -> Callable[..., Callable[[T], T]]:
+    def route_wrapper(*args, **kwargs) -> Callable[[T], T]:
         def handler_wrapper(func):
             return _add_global_route(args, kwargs, func, method)
 

{coloco-0.3.5 → coloco-0.3.6}/src/coloco/app.py

@@ -1,13 +1,17 @@
-from .api import create_api, global_router
+from .api import create_api, global_routes
 from dataclasses import dataclass
-from .db import get_orm_config, create_lifecycle_connect_database
-from fastapi import FastAPI
+from .db import (
+    get_orm_config,
+    inject_model_serializers,
+    register_db_lifecycle,
+)
+from fastapi import APIRouter, FastAPI
 from importlib import import_module
-from .lifespan import register_lifespan
 import os
 from rich import print
 from .static import bind_static
 import traceback
+from type_less import fill_type_hints
 from typing import Literal
 
 
@@ -53,8 +57,10 @@ def create_app(name: str, database_url: str = None) -> ColocoApp:
     mode: Literal["dev", "prod"] = os.environ.get("COLOCO_MODE", "dev")
     api = create_api(is_dev=mode == "dev")
 
+    src_path = "src"
+
     # Discover all api.py files from root, excluding node_modules and +app
-    api_files = discover_files(".", name="api.py", is_dev=mode == "dev")
+    api_files = discover_files(src_path, name="api.py", is_dev=mode == "dev")
     for api_file in api_files:
         # convert python file path to module path
         module_name = api_file.replace("./", "").replace(".py", "").replace("/", ".")
@@ -65,27 +71,46 @@ def create_app(name: str, database_url: str = None) -> ColocoApp:
             print(traceback.format_exc())
             continue
 
-    api.include_router(global_router)
-
-    # Production mode serves dist
-    if mode == "prod":
-        bind_static(api)
+    # Inject type hints
+    for route in global_routes:
+        fill_type_hints(route.func, use_literals=True)
 
     # Setup Database
-    if database_url:
+    # We need this first to grab the models for route type hints
+    has_database = bool(database_url)
+    if has_database:
         orm_config = get_orm_config(
             database_url,
-            model_files=discover_files(".", name="models.py", is_dev=mode == "dev"),
+            model_files=discover_files(src_path, name="models.py", is_dev=mode == "dev"),
         )
+        inject_model_serializers(orm_config, global_routes)
     else:
         orm_config = None
 
-    CURRENT_APP = ColocoApp(
-        api=api, name=name, database_url=database_url, orm_config=orm_config
-    )
+    router = APIRouter()
+    for route in global_routes:
+        router.api_route(
+            *route.args,
+            **{
+                **route.kwargs,
+                **{
+                    "summary": (
+                        route.kwargs.get("summary", "") + f" ({route.module_name})"
+                    ).strip(),
+                    "methods": [route.method],
+                },
+            },
+        )(route.func)
+    api.include_router(router)
+
+    # Production mode serves dist
+    if mode == "prod":
+        bind_static(api)
+
+    CURRENT_APP = ColocoApp(api=api, name=name, database_url=database_url, orm_config=orm_config)
 
     if database_url:
-        register_lifespan(create_lifecycle_connect_database(CURRENT_APP))
+        register_db_lifecycle(CURRENT_APP)
 
     return CURRENT_APP
 

{coloco-0.3.5 → coloco-0.3.6}/src/coloco/cli/api.py

@@ -1,15 +1,15 @@
 from ..app import ColocoApp
 from ..codegen import generate_openapi_schema, generate_openapi_code
+import cyclopts
 from importlib import import_module
 import os
 from rich import print
 import sys
-import typer
 from typing import Literal
 import uvicorn
 
 
-app = typer.Typer()
+app = cyclopts.App()
 
 
 def _verify_app(app: str = "src.main.app") -> ColocoApp:
@@ -17,7 +17,7 @@ def _verify_app(app: str = "src.main.app") -> ColocoApp:
         print(
             "[red]App should be the name of a variable in a python file, example: main.py -> api = main.api[/red]"
         )
-        raise typer.Abort()
+        raise SystemExit(1)
 
     module_name, var_name = app.rsplit(".", 1)
     try:
@@ -26,17 +26,17 @@ def _verify_app(app: str = "src.main.app") -> ColocoApp:
         module = import_module(module_name)
     except ModuleNotFoundError:
         print(f"[red]Module or python file {module_name} not found[/red]")
-        raise typer.Abort()
+        raise SystemExit(1)
 
     if not hasattr(module, var_name):
         print(f"[red]Variable {var_name} not found in module {module_name}[/red]")
-        raise typer.Abort()
+        raise SystemExit(1)
 
     var = getattr(module, var_name)
 
     if not isinstance(var, ColocoApp):
         print(f"[red]{var_name} is not a ColocoApp.  Please use create_app[/red]")
-        raise typer.Abort()
+        raise SystemExit(1)
 
     return var
 
@@ -50,12 +50,12 @@ def _verify_is_packaged():
         print(
             f"[red]Dist dir {dist_dir} does not exist.  Run [green]coloco build[/green] to package the app.[/red]"
         )
-        raise typer.Abort()
+        raise SystemExit(1)
     if not os.path.exists(app_dir):
         print(
             f"[red]App is missing from package directory {app_dir}.  Run [green]coloco build[/green] to package the app.[/red]"
         )
-        raise typer.Abort()
+        raise SystemExit(1)
 
 
 def _serve(

coloco-0.3.6/src/coloco/cli/build.py

@@ -0,0 +1,66 @@
+from .api import _verify_app, codegen
+from ..config import get_coloco_config
+from .node import build as build_node
+import os
+from pathlib import Path
+from rich import print
+import shutil
+
+
+def build(
+    app: str | None = None,
+):
+    if not app:
+        app = get_coloco_config().get("app") or "src.main.app"
+
+    _verify_app(app)
+
+    cwd = Path(os.getcwd())
+    source_dir = cwd / "src"
+    dist_dir = cwd / "dist"
+    api_dir = dist_dir / "src"
+    frontend_dir = dist_dir / "static"
+
+    print(f"Clearing {dist_dir}...")
+    shutil.rmtree(dist_dir, ignore_errors=True)
+
+    # # Codegen API
+    codegen(app)
+
+    # # Build node app
+    print(f"Packaging app...")
+    build_node(dir=frontend_dir)
+
+    print(f"Adding source files...")
+
+    api_dir.mkdir(parents=True, exist_ok=True)
+
+    # Collect backend files
+    package_api_files = get_coloco_config().get("package_api_files") or ["*.py"]
+    for glob_pattern in package_api_files:
+        # If glob_pattern starts with /, assume non-recursive
+        files = (
+            source_dir.glob(glob_pattern[1:])
+            if glob_pattern.startswith("/")
+            else source_dir.rglob(glob_pattern)
+        )
+        for file in files:
+            # Skip dev files
+            if "/-" in str(file):
+                continue
+
+            destination = api_dir / file.relative_to(source_dir)
+            destination.parent.mkdir(parents=True, exist_ok=True)
+            shutil.copy(file, destination)
+            print(f" |- {file.relative_to(cwd)}")
+
+    print(f"Adding project files...")
+    shutil.copy(cwd / "pyproject.toml", dist_dir / "pyproject.toml")
+    shutil.copy(cwd / "uv.lock", dist_dir / "uv.lock")
+
+    print(
+        f"App packaged into {dist_dir}.\n"
+        f"From the [yellow]{dist_dir}[/yellow] directory:\n"
+        f"  Run [green]uv sync --frozen[/green] to install dependencies.\n"
+        f"  Run [green]coloco serve[/green] to start the app in production mode.\n"
+    )

coloco-0.3.6/src/coloco/cli/db.py

@@ -0,0 +1,144 @@
+from .api import _verify_app
+from ..app import ColocoApp, get_current_app
+from asyncio import run
+import cyclopts
+import functools
+import logging
+import os
+from pathlib import Path
+from rich import print
+from tortoise import Tortoise
+from tortoise.log import logger as tortoise_logger
+from tortoise_pathway.migration_manager import MigrationManager
+from typing import Callable, TypeVar
+
+
+T = TypeVar("T")
+
+
+app = cyclopts.App()
+
+
+def _get_model_apps(coloco_app: ColocoApp):
+    return [app for app in coloco_app.orm_config["apps"]]
+
+
+def _get_coloco_app():
+    _verify_app()
+    return get_current_app()
+
+
+def _get_app_migrations_path_func(migrations_dir: str) -> Callable[[str], Path]:
+    def _get_app_migrations_path(self, app) -> Path:
+        return Path(os.path.join("src", "app", app, migrations_dir))
+
+    return _get_app_migrations_path
+
+
+def db_command(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        tortoise_logger.setLevel(logging.WARNING)
+        run(func(*args, **kwargs))
+        run(Tortoise.close_connections())
+
+    return app.command(name=func.__name__)(wrapper)
+
+
+async def get_migration_manager():
+    coloco_app = _get_coloco_app()
+    apps = _get_model_apps(coloco_app)
+    await Tortoise.init(config=coloco_app.orm_config)
+
+    # TODO: propose a patch for this
+    MigrationManager.get_migrations_dir = _get_app_migrations_path_func(coloco_app.migrations_dir)
+
+    manager = MigrationManager(apps, coloco_app.migrations_dir)
+    await manager.initialize()
+
+    return manager
+
+
+# ----------------------------- Commands -----------------------------
+
+
+@db_command
+async def makemigrations(
+    app: str | None = None, name: str | None = None, empty: bool = False
+) -> None:
+    """Create new migration(s) based on model changes."""
+    manager = await get_migration_manager()
+
+    print(f"Making migrations for {app or 'all apps'}...", end="", flush=True)
+
+    migrations = await manager.create_migration(name, app=app, auto=True)
+
+    if not migrations:
+        print("[gray]no changes[/gray]")
+        return
+
+    print()
+    for migration in migrations:
+        print(f" |- [yellow]{migration.display_name()}[/yellow] @ {migration.path()}")
+
+
+@db_command
+async def migrate(app: str | None = None) -> None:
+    """Apply migrations to the database."""
+    manager = await get_migration_manager()
+
+    pending = manager.get_pending_migrations(app=app)
+
+    if not pending:
+        print("[gray]No pending migrations.[/gray]")
+        return
+
+    s = "s" if len(pending) > 1 else ""
+    print(f"Applying [cyan]{len(pending)}[/cyan] migration{s}:")
+
+    applied = []
+    async for migration in manager.apply_migrations_async(app=app):
+        print(f" |- [cyan]{migration.display_name()}[/cyan]")
+        applied.append(migration)
+
+    if applied:
+        print(f"[green]Successfully applied {len(applied)} migration{s}[/green]")
+    else:
+        print("[gray]No migrations were applied.[/gray]")
+
+
+@db_command
+async def rollback(app: str | None = None, migration: str | None = None) -> None:
+    """Revert the most recent migration."""
+    manager = await get_migration_manager()
+
+    reverted = await manager.revert_migration(migration=migration, app=app)
+
+    if reverted:
+        print(f"Successfully reverted migration: [yellow]{reverted.display_name()}[/yellow]")
+    else:
+        print("[gray]No migration was reverted.[/gray]")
+
+
+@db_command
+async def showmigrations(app: str | None = None) -> None:
+    """Show migration status."""
+    manager = await get_migration_manager()
+
+    applied = manager.get_applied_migrations(app=app)
+    pending = manager.get_pending_migrations(app=app)
+
+    print(f"Migrations for {app}:" if app else "All Migrations:")
+    print("\nApplied migrations:")
+    if applied:
+        for migration in applied:
+            print(f"  [X] {migration.display_name()}")
+    else:
+        print("  (none)")
+
+    print("\nPending migrations:")
+    if pending:
+        for migration in pending:
+            print(f"  [ ] {migration.display_name()}")
+    else:
+        print("  (none)")

{coloco-0.3.5 → coloco-0.3.6}/src/coloco/cli/dev.py

@@ -1,24 +1,28 @@
 from .api import _verify_app, _serve
+import cyclopts
 from ..config import get_coloco_config
 from .node import install, _setup_dev_env
 import os
 from rich import print
 from subprocess import Popen
 
+app = cyclopts.App()
 
-def dev(app: str = None, host: str = "127.0.0.1"):
+
+@app.default()
+def dev(app: str | None = None, host: str = "127.0.0.1"):
     if not app:
         app = get_coloco_config().get("app") or "src.main.app"
 
     _verify_app(app)
 
-    # Check Node Modules
-    if not os.path.exists(os.path.join(os.getcwd(), "node_modules")):
-        print("[yellow]Node modules not found, installing...[/yellow]")
-        install()
+    # # Check Node Modules
+    # if not os.path.exists(os.path.join(os.getcwd(), "node_modules")):
+    #     print("[yellow]Node modules not found, installing...[/yellow]")
+    #     install()
 
-    _setup_dev_env()
-    node = Popen([f"npm run dev"], shell=True)
+    # _setup_dev_env()
+    # node = Popen([f"npm run dev"], shell=True)
     _serve(
         app=app,
         host=host,