coloco 0.4.7__tar.gz → 0.4.8__tar.gz

{coloco-0.4.7 → coloco-0.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: coloco
-Version: 0.4.7
+Version: 0.4.8
 Summary: A kit for creating FastAPI + Svelte applications
 Author-Email: Channel Cat <channelcat@gmail.com>
 License: MIT

{coloco-0.4.7 → coloco-0.4.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "coloco"
-version = "0.4.7"
+version = "0.4.8"
 description = "A kit for creating FastAPI + Svelte applications"
 authors = [
     { name = "Channel Cat", email = "channelcat@gmail.com" },

{coloco-0.4.7 → coloco-0.4.8}/src/coloco/cli/createapp.py

@@ -1,6 +1,5 @@
-from rich import print
-from .node import install
 import os
+from rich import print
 
 
 def createapp(name: str):
@@ -11,6 +10,7 @@ def createapp(name: str):
 
     template_vars = {
         "project_name": name,
+        "coloco_version": "0.4.8",
     }
 
     # Create directory
@@ -28,9 +28,7 @@ def createapp(name: str):
                     content = f.read()
                 for key, value in template_vars.items():
                     content = content.replace(f"{{{{ {key} }}}}", value)
-                with open(
-                    os.path.join(install_dir, relative_path, file[:-4]), "w"
-                ) as f:
+                with open(os.path.join(install_dir, relative_path, file[:-4]), "w") as f:
                     f.write(content)
 
     print(f"App created in {install_dir}")

{coloco-0.4.7 → coloco-0.4.8}/src/coloco/cli/dev.py

@@ -10,7 +10,7 @@ app = cyclopts.App()
 
 
 @app.default()
-def dev(app: str | None = None, host: str = "127.0.0.1"):
+def dev(app: str | None = None, host: str = "127.0.0.1", port: int = 5172):
     if not app:
         app = get_coloco_config().get("app") or "src.main.app"
 
@@ -26,7 +26,7 @@ def dev(app: str | None = None, host: str = "127.0.0.1"):
     _serve(
         app=app,
         host=host,
-        port=5172,
+        port=port,
         log_level="debug",
         mode="dev",
         reload=True,

{coloco-0.4.7 → coloco-0.4.8}/src/coloco/cli/node.py

@@ -23,8 +23,8 @@ def _run_npm(command):
         raise SystemExit(1)
 
 
-def _setup_dev_env():
-    os.environ["API_HOST"] = "http://localhost:5172"
+def _setup_dev_env(port: int = 5172):
+    os.environ["VITE_API_HOST"] = f"http://localhost:{port}"
 
 
 @app.command()

coloco-0.4.8/src/coloco/codegen.py

@@ -0,0 +1,92 @@
+from contextlib import contextmanager
+from fastapi import FastAPI
+from fastapi.routing import APIRoute
+import json
+from subprocess import run
+
+import os
+import shutil
+import filecmp
+
+
+def compare_and_copy(source_dir, target_dir):
+    """
+    Compares files in two directories and copies files from source to target if they differ, creating target directories if needed.
+
+    Args:
+        source_dir (str): Path to the source directory.
+        target_dir (str): Path to the target directory.
+    """
+    for root, _, files in os.walk(source_dir):
+        rel_path = os.path.relpath(root, source_dir)  # Get relative path from source
+        target_path = os.path.join(target_dir, rel_path)
+        os.makedirs(target_path, exist_ok=True)  # Create target directory if it doesn't exist
+
+        for file in files:
+            source_file = os.path.join(root, file)
+            target_file = os.path.join(target_path, file)
+
+            if not os.path.exists(target_file) or not filecmp.cmp(source_file, target_file):
+                shutil.copy2(source_file, target_file)
+
+
+def custom_generate_unique_id(route: APIRoute) -> str:
+    return f"{route.name}"
+
+
+def generate_openapi_schema(app: FastAPI, path="/tmp/openapi.json"):
+    with open(path, "w") as f:
+        json.dump(app.openapi(), f)
+
+
+@contextmanager
+def ensure_openapi_ts_config(config_path="./openapi-ts.config.ts", output_path="./api/app"):
+    """
+    Ensures an openapi-ts config file is present, otherwise temporarily generates one
+    """
+    generated = False
+    try:
+        if not os.path.exists(config_path):
+            with open(config_path, "w") as f:
+                generated = True
+                f.write(
+                    f"""
+                        import {{ defaultPlugins }} from '@hey-api/openapi-ts';
+                        import {{ codegenConfig }} from '@coloco/api-client-svelte';
+
+                        export default {{
+                            plugins: [
+                                ...defaultPlugins,
+                                '@hey-api/client-fetch',
+                                codegenConfig({{ name: 'coloco-codegen', outputPath: '{output_path}' }}),
+                            ],
+                        }};
+                    """
+                )
+        yield
+    finally:
+        if generated:
+            os.remove(config_path)
+
+
+def generate_openapi_code(
+    host,
+    spec_path="/tmp/openapi.json",
+    output_dir="./src/app/.generated/client",
+    config_path="./openapi-ts.config.ts",
+    diff_files=False,
+):
+    temp_dir = "/tmp/backend_api"
+    output_path = os.path.join(os.getcwd(), output_dir)
+
+    with ensure_openapi_ts_config(config_path):
+        run(
+            f"npx openapi-ts "
+            f"--base {host} "
+            f"--file {config_path} "
+            f"--input {spec_path} "
+            f"--output {temp_dir if diff_files else output_path} ".split(),
+            cwd=os.getcwd(),
+        )
+        if diff_files:
+            compare_and_copy(temp_dir, output_dir)

coloco-0.4.8/src/coloco/config.py

@@ -0,0 +1,22 @@
+import tomllib
+import os
+
+
+def get_pyproject_config(path: str = "pyproject.toml"):
+    # Read project toml
+    if not os.path.exists(path):
+        raise LookupError(f"{path} not found")
+    with open(path, "rb") as f:
+        config = tomllib.load(f)
+    return config
+
+
+def get_coloco_config():
+    # Read project toml
+    config = get_pyproject_config()
+
+    # Get coloco config
+    coloco_config = config.get("tool", {}).get("coloco")
+    if not coloco_config:
+        raise LookupError("coloco config not found in pyproject.toml under [tool.coloco]")
+    return coloco_config

{coloco-0.4.7 → coloco-0.4.8}/src/coloco/exceptions.py

@@ -11,6 +11,7 @@ class UserError(Exception):
     def __init__(self, *args: object, status_code=400, code="bad_request") -> None:
         super().__init__(*args)
         self.code = code
+        self.status_code = status_code
 
 
 class ServerError(Exception):

coloco-0.4.8/src/coloco/templates/standard/.gitignore-tpl

@@ -0,0 +1,20 @@
+# Node
+node_modules
+.vite
+
+# Python
+__pycache__
+
+# UV generated
+.venv
+.python-version
+
+# App Generated
+dist
+src/app/.generated
+
+# Local database
+db.sqlite3*
+
+# Local settings
+.env

coloco-0.4.8/src/coloco/templates/standard/README.md-tpl

@@ -0,0 +1,3 @@
+# {{ project_name }}
+
+Created using Coloco, A kit for creating FastAPI + Svelte applications

{coloco-0.4.7/src/coloco/templates/standard/+node → coloco-0.4.8/src/coloco/templates/standard}/package.json-tpl

@@ -1,5 +1,5 @@
 {
-  "name": "{{ project_name }}",
+  "name": "couchquest",
   "private": true,
   "version": "1.0.0",
   "type": "module",
@@ -10,16 +10,21 @@
     "check": "svelte-check --tsconfig ./tsconfig.app.json && tsc -p tsconfig.node.json"
   },
   "devDependencies": {
-    "@coloco/api-client-svelte": "^0.4.10",
-    "@coloco/router": "^0.1.15",
+    "@coloco/api-client-svelte": "^0.4.12",
+    "@coloco/router": "^0.1.18",
+    "@coloco/vite": "^0.1.1",
     "@hey-api/client-fetch": "^0.8.2",
     "@hey-api/openapi-ts": "^0.64.7",
     "@sveltejs/vite-plugin-svelte": "^5.0.3",
     "@tsconfig/svelte": "^5.0.4",
     "@types/node": "^22.13.4",
+    "autoprefixer": "^10.4.20",
     "svelte": "^5.19.6",
     "svelte-check": "^4.1.4",
-    "typescript": "~5.7.2",
-    "vite": "^6.1.0"
+    "typescript": "~5.8.2",
+    "vite": "^6.3.3"
+  },
+  "dependencies": {
+    "@mateothegreat/svelte5-router": "^2.14.1"
   }
 }

coloco-0.4.8/src/coloco/templates/standard/pyproject.toml-tpl

@@ -0,0 +1,17 @@
+[project]
+name = "{{ project_name }}"
+version = "0.1.0"
+description = "Your project description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "coloco>={{ coloco_version }}",
+    "tortoise-pathway>=0.2.0",
+]
+
+[tool.coloco]
+app = "src.main.app"
+migrations_dir = "+migrations"
+
+[tool.uv.sources]
+tortoise-pathway = { git = "https://github.com/channelcat/tortoise-pathway", rev = "iterate-migration-apply" }

coloco-0.4.8/src/coloco/templates/standard/src/app/example/index.svelte-tpl

@@ -0,0 +1,13 @@
+<script lang="ts">
+  import { test } from "./api";
+
+  const results = test({ name: "Testy McTesterson" });
+</script>
+
+{#await results}
+  <p>Loading...</p>
+{:then response}
+  <p>Hello {response.data}</p>
+{:catch error}
+  <p>Error: {error}</p>
+{/await}

coloco-0.4.8/src/coloco/templates/standard/src/app/index.svelte-tpl

@@ -0,0 +1 @@
+I am the home page!

coloco-0.4.8/src/coloco/templates/standard/src/app.svelte-tpl

@@ -0,0 +1,38 @@
+<script lang="ts">
+  import "./app.css";
+
+  import { Router, getRoutes, route } from "@coloco/router";
+  import { setDefaultClient } from "@coloco/api-client-svelte";
+
+  import FavIcon from "@/assets/favicon.png";
+
+  import Index from "@app/index.svelte";
+  import NotFound from "@app/404.svelte";
+
+  import { client } from "./lib/client";
+
+  setDefaultClient(client);
+
+  const routes = getRoutes({
+    index: Index,
+    notFound: NotFound,
+  });
+</script>
+
+<svelte:head>
+  <link rel="icon" type="image/x-icon" href={FavIcon} />
+</svelte:head>
+
+<main>
+  Main Page
+
+  <br /><br />
+
+  <a use:route href="/">Home</a><br />
+  <a use:route href="/example">Example</a><br />
+  <a use:route href="/missing">Missing</a>
+
+  <br /><br />
+
+  <Router basePath="/" {routes} />
+</main>

coloco-0.4.8/src/coloco/templates/standard/src/lib/client.ts-tpl

@@ -0,0 +1,15 @@
+import { makeClient } from "@coloco/api-client-svelte";
+
+export const client = makeClient({
+  baseUrl: import.meta.env.VITE_API_HOST,
+  throwOnError: true,
+  fetch: (request) => {
+    return fetch(request, {
+      credentials: "include",
+    });
+  },
+  errorHandler: (error) => {
+    console.error(error.stack);
+    alert(error.message);
+  },
+});

coloco-0.4.8/src/coloco/templates/standard/src/main.py-tpl

@@ -0,0 +1,6 @@
+from coloco import create_app
+
+app = create_app(
+    name="{{ project_name }}",
+    database_url="sqlite://db.sqlite3",
+)

{coloco-0.4.7/src/coloco/templates/standard/+app → coloco-0.4.8/src/coloco/templates/standard/src}/main.ts-tpl

@@ -1,9 +1,8 @@
 import { mount } from 'svelte'
-import './app.css'
 import App from './app.svelte'
 
 const app = mount(App, {
-  target: document.getElementById('app')!,
+  target: document.getElementById('app') as HTMLElement,
 })
 
 export default app

coloco-0.4.8/src/coloco/templates/standard/tsconfig.json-tpl

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    // Coloco auto-generated APIs
+    "rootDirs": ["./src", "./src/app/.generated/client/api"],
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "lib": ["esnext", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "module": "esnext",
+    "noEmit": true,
+    "target": "esnext",
+    // Project
+    "allowJs": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    // Coloco Paths
+    "paths": {
+      "@api/*": ["./src/app/.generated/client/api/app/*"],
+      "@app/*": ["./src/app/*"],
+      "@client/*": ["./src/app/.generated/client/*"],
+      "@/*": ["./src/*", "./src/app/.generated/client/api/*"]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.js",
+    "./src/**/*.svelte",
+    "./vite.config.ts",
+    "./vite-env.d.ts"
+  ]
+}

coloco-0.4.8/src/coloco/templates/standard/vite-env.d.ts-tpl

@@ -0,0 +1,11 @@
+/// <reference types="svelte" />
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly VITE_API_HOST: string
+  // Add other environment variables here as needed
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv
+} 

coloco-0.4.8/src/coloco/templates/standard/vite.config.ts-tpl

@@ -0,0 +1,30 @@
+import path, { dirname, resolve, relative } from "node:path";
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vite";
+import { svelte } from "@sveltejs/vite-plugin-svelte";
+import tailwindcss from "@tailwindcss/vite";
+import { coloco, colocoAliases } from "@coloco/vite";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const root = resolve(__dirname, "./src");
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [tailwindcss(), svelte(), coloco()],
+  root: root,
+  server: {
+    host: "0.0.0.0",
+    port: 5173,
+  },
+  build: {
+    outDir: "../dist/app",
+    emptyOutDir: true,
+  },
+  clearScreen: false,
+  resolve: {
+    alias: [
+      ...colocoAliases(),
+      { find: "$lib", replacement: path.resolve("./src/lib") },
+    ],
+  },
+});

coloco-0.4.7/src/coloco/codegen.py

@@ -1,62 +0,0 @@
-from fastapi import FastAPI
-from fastapi.routing import APIRoute
-import json
-from subprocess import run
-
-import os
-import shutil
-import filecmp
-
-
-def compare_and_copy(source_dir, target_dir):
-    """
-    Compares files in two directories and copies files from source to target if they differ, creating target directories if needed.
-
-    Args:
-        source_dir (str): Path to the source directory.
-        target_dir (str): Path to the target directory.
-    """
-    for root, _, files in os.walk(source_dir):
-        rel_path = os.path.relpath(root, source_dir)  # Get relative path from source
-        target_path = os.path.join(target_dir, rel_path)
-        os.makedirs(
-            target_path, exist_ok=True
-        )  # Create target directory if it doesn't exist
-
-        for file in files:
-            source_file = os.path.join(root, file)
-            target_file = os.path.join(target_path, file)
-
-            if not os.path.exists(target_file) or not filecmp.cmp(
-                source_file, target_file
-            ):
-                shutil.copy2(source_file, target_file)
-
-
-def custom_generate_unique_id(route: APIRoute) -> str:
-    return f"{route.name}"
-
-
-def generate_openapi_schema(app: FastAPI, path="/tmp/openapi.json"):
-    with open(path, "w") as f:
-        json.dump(app.openapi(), f)
-
-
-def generate_openapi_code(
-    host,
-    spec_path="/tmp/openapi.json",
-    output_dir="./src/app/.generated/client",
-    diff_files=False,
-):
-    temp_dir = "/tmp/backend_api"
-    output_path = os.path.join(os.getcwd(), output_dir)
-
-    run(
-        f"npx openapi-ts "
-        f"--base {host} "
-        f"--input {spec_path} "
-        f"--output {temp_dir if diff_files else output_path} ".split(),
-        cwd=os.getcwd(),
-    )
-    if diff_files:
-        compare_and_copy(temp_dir, output_dir)

coloco-0.4.7/src/coloco/config.py

@@ -1,18 +0,0 @@
-import tomllib
-import os
-
-
-def get_coloco_config():
-    # Read project toml
-    if not os.path.exists("pyproject.toml"):
-        raise LookupError("pyproject.toml not found")
-    with open("pyproject.toml", "rb") as f:
-        config = tomllib.load(f)
-
-    # Get coloco config
-    coloco_config = config.get("tool", {}).get("coloco")
-    if not coloco_config:
-        raise LookupError(
-            "coloco config not found in pyproject.toml under [tool.coloco]"
-        )
-    return coloco_config

coloco-0.4.7/src/coloco/templates/standard/+app/app.svelte-tpl

@@ -1,29 +0,0 @@
-<script lang="ts">
-  import { makeClient, setDefaultClient } from "@coloco/api-client-svelte";
-  import { route, Router, getRoutes } from "@coloco/router";
-
-  import Index from "./index.svelte";
-  import NotFound from "./404.svelte";
-
-  const client = makeClient({ baseUrl: import.meta.env.API_HOST });
-  const routes = getRoutes({
-    index: Index,
-    notFound: NotFound,
-  });
-  
-  setDefaultClient(client);
-</script>
-
-<main>
-  Main Page
-  
-  <br /><br />
-
-  <a use:route href="/">Home</a><br />
-  <a use:route href="/example">Example</a><br />
-  <a use:route href="/missing">Missing</a>
-  
-  <br /><br />
-
-  <Router basePath="/" {routes} />
-</main>

coloco-0.4.7/src/coloco/templates/standard/+app/index.svelte-tpl

@@ -1 +0,0 @@
-I am the home page!

coloco-0.4.7/src/coloco/templates/standard/+node/openapi-ts.config.ts-tpl

@@ -1,10 +0,0 @@
-import { defaultPlugins } from '@hey-api/openapi-ts';
-import { codegenConfig } from '@coloco/api-client-svelte';
-
-export default {
-  plugins: [
-    ...defaultPlugins,
-    '@hey-api/client-fetch',
-    codegenConfig({ name: 'coloco-codegen', outputPath: './api' }),
-  ],
-};

coloco-0.4.7/src/coloco/templates/standard/+node/tsconfig.json-tpl

@@ -1,43 +0,0 @@
-{
-    "compilerOptions": {
-        "rootDirs": [
-            "..",
-            "../+app/.generated/client/api"
-        ],
-        "verbatimModuleSyntax": true,
-        "isolatedModules": true,
-        "lib": [
-            "esnext",
-            "DOM",
-            "DOM.Iterable"
-        ],
-        "moduleResolution": "bundler",
-        "module": "esnext",
-        "noEmit": true,
-        "target": "esnext",
-        // Project
-        "allowJs": true,
-        "checkJs": true,
-        "esModuleInterop": true,
-        "forceConsistentCasingInFileNames": true,
-        "resolveJsonModule": true,
-        "skipLibCheck": true,
-        "sourceMap": true,
-        "strict": true,
-        "paths": {
-            "@api/*": [
-                "../+app/.generated/client/api/*"
-            ]
-        },
-    },
-    "include": [
-        "../**/*.ts",
-        "../**/*.js",
-        "../**/*.svelte",
-        "./vite.config.ts"
-    ],
-    "exclude": [
-        "../node_modules/**",
-        "../dist/**"
-    ]
-}

coloco-0.4.7/src/coloco/templates/standard/+node/vite-env.d.ts-tpl

@@ -1,2 +0,0 @@
-/// <reference types="svelte" />
-/// <reference types="vite/client" />

coloco-0.4.7/src/coloco/templates/standard/+node/vite.config.ts-tpl

@@ -1,48 +0,0 @@
-import path, { dirname, resolve, relative } from 'node:path'
-import { fileURLToPath } from 'node:url'
-import { defineConfig } from 'vite'
-import { svelte } from '@sveltejs/vite-plugin-svelte'
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const root = resolve(__dirname, '../');
-
-// https://vite.dev/config/
-export default defineConfig({
-  plugins: [svelte()],
-  root: resolve(root, '+app'),
-  server: {
-    host: "0.0.0.0",
-    port: 5173,
-  },
-  build: {
-    outDir: '../dist/app',
-    emptyOutDir: true, // also necessary
-  },
-  clearScreen: false,
-  resolve: {
-    // @ts-ignore
-    alias: [{
-      find: './api',
-      customResolver: (_, filePath: string) => {
-        const subFolder = path.relative(root, dirname(filePath));
-        const apiFile = resolve(root, `+app/.generated/client/api/${subFolder}/api.ts`);
-        return apiFile;
-      }
-    },
-    // @ts-ignore
-    {
-      find: '@api',
-      replacement: '/.generated/client/api'
-    },
-    // @ts-ignore
-    {
-      find: '@app/',
-      replacement: '/'
-    },
-    // @ts-ignore
-    {
-      find: '@root',
-      replacement: '/..'
-    }]
-  }
-})

coloco-0.4.7/src/coloco/templates/standard/.gitignore-tpl

@@ -1,6 +0,0 @@
-.env
-node_modules
-dist
-+app/.generated
-.vite
-__pycache__

coloco-0.4.7/src/coloco/templates/standard/README.md-tpl

@@ -1,3 +0,0 @@
-# {{ project_name }}
-
-A kit for creating FastAPI + Svelte applications

coloco-0.4.7/src/coloco/templates/standard/example/index.svelte-tpl

@@ -1,7 +0,0 @@
-<script lang="ts">
-  import { test } from "./api";
-
-  const results = test({ name: "Testy McTesterson" });
-</script>
-
-Calling server... {$results.loading} - {$results.data} - {$results.error}

coloco-0.4.7/src/coloco/templates/standard/main.py-tpl

@@ -1,3 +0,0 @@
-from coloco import create_app
-
-app = create_app(name="{{ project_name }}")

coloco-0.4.7/src/coloco/templates/standard/pyproject.toml-tpl

@@ -1,13 +0,0 @@
-[project]
-name = "{{ project_name }}"
-version = "0.1.0"
-description = "Your project description here"
-readme = "README.md"
-requires-python = ">=3.11"
-dependencies = [
-    "coloco>=0.2.0",
-]
-
-[tool.coloco]
-app = "main.app"
-migrations_dir = "./+migrations"

coloco-0.4.7/src/coloco/templates/standard/tsconfig.json-tpl

@@ -1,3 +0,0 @@
-{
-    "extends": "./+node/tsconfig.json"
-}