Compare commits

...
25 Commits
Author SHA1 Message Date
LeoVasanko 1aaf040db7 Make devserver backend health check endpoint configurable, preserved in upgrades and optional. 2026-03-07 23:55:10 +00:00
LeoVasanko aac27da67c Suppress CancelledError along with KeyboardInterrupt as a normal exit from server.run(). 2026-02-18 17:50:34 +00:00
LeoVasanko 79e645a263 Add parse_endpoints helper function that handles complicated listen structures alike server.run() already did, returning a simple list of every endpoint. 2026-02-18 17:05:10 +00:00
LeoVasanko 8b8a24a6b2 Determine app module path correctly even when in a submodule. A bit cleaner dev options. 2026-02-11 20:41:36 +00:00
LeoVasanko cb6017cedf Find custom CLI main before looking up existing DEFAULT_PORT. Cleaner messages when Vue doesn't need patching. 2026-02-11 20:27:35 +00:00
LeoVasanko fab4108e92 Cleaner devserver help message. 2026-02-11 20:06:36 +00:00
LeoVasanko 637f737d4c Restore app module isort by reusing the full format function. 2026-02-11 19:48:45 +00:00
LeoVasanko 0b986717eb Cleaner message 2026-02-11 18:40:58 +00:00
LeoVasanko 9469d57f90 Better patching with existing custom main modules. Print all .new.py needing migration at the end. 2026-02-11 18:35:28 +00:00
LeoVasanko 1ce0fffe3e Use dev port as default fallback in vite-plugin-fastapi, instead of default port. No effect on invocations via devserver script. 2026-02-11 18:15:57 +00:00
LeoVasanko f483cf978c Ruff format 2026-02-10 20:56:06 +00:00
LeoVasanko 0e12e3a531 Improved error message. 2026-02-10 19:51:05 +00:00
LeoVasanko 67bea9a2a7 Remove unnecessary bool() 2026-02-10 19:46:32 +00:00
LeoVasanko a05c8236f6 Format Python modules installed with ruff to target project style. 2026-02-10 19:34:35 +00:00
LeoVasanko fc3d6dc912 README 2026-02-10 19:00:41 +00:00
LeoVasanko c63a375ab2 Use ## to allow command be pasted as a whole. 2026-02-10 17:14:14 +00:00
LeoVasanko c98994fd1a Dry run cleanup, also allow --dry-run. 2026-02-10 17:06:42 +00:00
LeoVasanko 6beaa88418 Improved setup complete message. 2026-02-10 17:00:24 +00:00
LeoVasanko 26a77dcf84 Cleaner messages while running the setup. 2026-02-10 16:39:45 +00:00
LeoVasanko 38c9ffe00b Add --version, rename --dry-run to just --dry. 2026-02-10 16:29:30 +00:00
LeoVasanko b87984af9a Consistent form of CLI arguments. 2026-02-10 16:16:32 +00:00
LeoVasanko d3b6fccce0 The devserver now takes --listen for vite endpoint rather than a positional argument. Changed FRONTEND_URL to VITE_URL and streamlined terminology elsewhere. 2026-02-10 16:09:07 +00:00
LeoVasanko d2ee7395c5 health?from=frontend for logs 2026-02-10 16:01:06 +00:00
LeoVasanko b94608ffe3 Run ruff within local venv (otherwise required system path which did not include the venv with uv tool install). 2026-02-09 16:03:30 +00:00
LeoVasanko ef6bce8f3f Use the CLI script rather than python -m for running the main app from devserver. 2026-02-09 15:55:08 +00:00
11 changed files with 450 additions and 289 deletions
+54 -95
View File
@@ -1,137 +1,96 @@
# fastapi-vue-setup
Tool to create or patch FastAPI project with a Vue frontend, with integrated build and development systems. The Python package will not need any JS runtime because it includes a prebuilt Vue frontend in it. For development (Vite and FastAPI auto reloads) and building the package one of npm, deno or bun is required (node is recommended due to bugs in deno and bun).
Create or patch a FastAPI + Vue project with an integrated dev/build workflow.
## Features
- Development: one command runs Vite + FastAPI (reloads)
- Production: `uv build` bakes the built Vue assets into the Python package (no Node/JS runtime needed to *run* the installed package)
- **No JavaScript**: Your Python package can be installed and used without any JS runtime
- **Integrated build system**: Vue frontend builds into Python package during `uv build`
- **Development server**: Single command runs Vite + FastAPI with hot-reload
- **Optimized static serving**: Caching, zstd compression and SPA support
## Quick start
## Installation
Install [UV](https://docs.astral.sh/uv/) and any JS runtime (node, deno, or bun).
Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
This README uses `my-app` as the example project name:
```sh
uv tool install fastapi-vue-setup
fastapi-vue-setup --help
```
- project directory: `my-app/`
- Python module: `my_app`
- env prefix: `MY_APP`
- CLI command: `my-app`
Or run directly:
Create a new project in `./my-app`:
```sh
uvx fastapi-vue-setup my-app
```
## Usage
Once in your source tree, you will typically use `.` for the path. If there is an existing project, `fastapi-vue-setup` will do its best to find and patch a backend module and create or patch a Vue project in `frontend/`. The integration can be upgraded by running a new version of `fastapi-vue-setup` on it, preserving earlier default ports and user customizations.
The script may be used to create an all new project folder or to patch or update an existing project to use this framework. It autodetects the project folder given and performs the appropriate actions.
## In your project
### Create a new project
️ Everything below is meant to be run within your project source tree.
The setup creates a CLI entry for your package, so that it becomes a command to run, not a Python module nor `fastapi myapp...`. The CLI main can be customized, although --listen should be kept for devserver compatibility.
You can choose the JS runtime with environment `JS_RUNTIME` (e.g. `node`, `deno`, `bun`, or path to one). This is used by the build and the devserver scripts. By default any available runtime on the system is chosen.
### Development server (Vite + FastAPI)
```sh
fastapi-vue-setup my-app
uv run scripts/devserver.py [args]
```
This will:
️ Arguments are forwarded to the main CLI, except that `--listen` controls where Vite listens, and `--backend` is passed to main CLI as `--listen`.
1. Run `uv init my-app`
2. Run `create-vue frontend` (interactive - choose your Vue options)
3. Patch the project with FastAPI integration
4. Install dependencies via `uv add`
### Production
### Patch an existing project
You should have your pyproject.toml at the current working directory, and Vue with its package.json under `frontend/`. If either one is missing, new applications will be initialised. Otherwise we only patch what can be patched without breaking your existing projects.
Build the Python package (this compiles the Vue frontend) and run the production server:
```sh
fastapi-vue-setup .
uv build && uv run my-app [args]
```
### CLI Options
Once happy with it, publish the package
```
fastapi-vue-setup [project-dir] [options]
Options:
--module-name NAME Python module name (auto-detected from pyproject.toml)
--dry-run Preview changes without modifying files
```sh
uv build && uv publish
```
## Port Configuration
Afterwards, you can easily run it anywhere, no JS runtimes required:
In development, you access the Vite dev server at `http://localhost:5173`. Vite proxies `/api/*` requests to FastAPI at port 5180. Ports and hosts of Vite and FastAPI are configurable by `devserver.py` arguments.
In production, FastAPI serves both the API and static files at `http://localhost:5080`. Configurable by `host:port` argument with defaults set in `__main__.py`
## Main CLI
If your project didn't already have `__main__.py`, we create one that runs the FastAPI app with richer configuration than what the FastAPI CLI offers. Running your module starts it in production mode, and optionally host:port may be given as argument to specify where it listens.
If you are running behind a reverse proxy like [Caddy](https://caddyserver.com/) on localhost, your app will trust the proxy headers it sends. However, if you need to configure another proxy host or IP, set `FORWARDED_ALLOW_IPS` env variable before running the server.
The devserver script depends on this CLI entry for running the backend. You will have to modify the `devserver.py` script if your app has its own incompatible main module. Note that we set FastAPI debug mode and Uvicorn reload when configured via `FASTAPI_VUE_BACKEND_URL` env variable (set by `devserver.py`), while for normal production use these stay disabled. The same variable also controls static files serving (disabled in dev mode).
## Vite Plugin Configuration
The `fastapiVue()` plugin in `vite.config.ts` accepts options to customize proxy behavior:
```js
import fastapiVue from "./vite-plugin-fastapi.js";
export default defineConfig({
plugins: [
vue(),
// Default: proxies only /api
fastapiVue(),
// Or specify custom paths to proxy to backend
fastapiVue({ paths: ["/api", "/auth", "/ws"] }),
],
});
```sh
uvx my-app [args]
```
The plugin reads environment `FASTAPI_VUE_BACKEND_URL` (default: `http://localhost:5180`) to determine where to proxy requests. This is set automatically by `devserver.py`.
️ Instead of `uvx` you may consider `uv tool install`, oldskool `pip install` or whatever best suits you.
## Project Structure
### Vite plugin
The generated Vite plugin lives in `frontend/vite-plugin-fastapi.js` and defaults to proxying `/api`.
It reads `MY_APP_BACKEND_URL` to know where to proxy; if unset it falls back to your configured default backend port.
## Project layout (typical)
```
my-app/
├── frontend/ # Vue application
├── frontend/ # Vue app (Vite)
│ ├── src/
│ ├── vite-plugin-fastapi.js
│ ├── vite.config.js
│ └── package.json
├── my_app/ # Python module (files included in sdist)
│ ├── __init__.py
│ ├── __main__.py # CLI entrypoint
── app.py # FastAPI application
│ └── frontend-build/ # Built frontend (gitignored)
── scripts/
├── devserver.py # CLI dev server (only in source tree)
└── fastapi-vue/
├── build-frontend.py
── util.py
└── pyproject.toml
├── my_app/ # Python package
│ ├── __main__.py # CLI entrypoint
│ ├── app.py # FastAPI app
── frontend-build/ # built assets (included in distributions)
├── pyproject.toml
── scripts/
├── devserver.py # Run Vite and FastAPI together in dev mode
└── fastapi-vue/ # Dev utilities (only on the source tree)
├── build-frontend.py
── buildutil.py
└── devutil.py
```
The project directory tree looks roughly like this after project creation or patching. The script finds your existing app module and other files and patches them with minimal changes to enable the Vue-FastAPI interconnection. New Python and Vue projects are created automatically if none exist.
## The fastapi-vue runtime module
## Development Workflow
The backend runs the FastAPI app and serves the frontend build using the companion package in [fastapi-vue/README.md](fastapi-vue/README.md). Your project will depend on Fastapi and this lightweight module.
```bash
# Start dev server (runs both Vite and FastAPI)
uv run scripts/devserver.py
# Build for production
uv build
# Run production server
uv run my-app
```
## Frontend serving
Your FastAPI app will use [fastapi-vue](https://git.zi.fi/LeoVasanko/fastapi-vue) to serve the frontend files. Refer to that package's documentation for further configuration.
️ Development functionality is in `scripts/fastapi-vue/` directly in your source tree, and is not to be confused with this runtime module. Only the runtime is installed with your package.
+39 -18
View File
@@ -1,29 +1,25 @@
# fastapi-vue
Implements Single-Page-App serving at site root with FastAPI, that the standard StaticFiles module cannot handle. This also caches and zstd compresses the files for lightning-fast operation. This is primarily meant for use with Vue frontend, but technically can host any static files in a similar manner.
Runtime helpers for FastAPI + Vite/Vue projects.
## Installation
## Overview
Script [fastapi-vue-setup](https://git.zi.fi/LeoVasanko/fastapi-vue-setup) should normally be used to convert or create a project with connection between FastAPI and Vue. The target project will depend on this package to serve its static files.
This package provides:
```sh
uvx fastapi-vue-setup --help
```
- `fastapi_vue.Frontend`: serves built SPA assets (with SPA support, caching, and optional zstd)
- `fastapi_vue.server.run`: a small Uvicorn runner with convenient `listen` endpoint parsing
Refer to instructions below for further configuration.
## Quickstart
## Usage
Serve built frontend assets from `frontend-build/`:
```python
from pathlib import Path
from contextlib import asynccontextmanager
from fastapi import FastAPI
from fastapi_vue import Frontend
frontend = Frontend(
Path(__file__).with_name("frontend-build"),
spa=True,
cached=["/assets/"],
)
frontend = Frontend(Path(__file__).with_name("frontend-build"), spa=True)
@asynccontextmanager
async def lifespan(app: FastAPI):
@@ -38,10 +34,35 @@ app = FastAPI(lifespan=lifespan)
frontend.route(app, "/")
```
## Configuration
## Frontend
- `directory`: Path to static files directory
- `spa`: Enable SPA mode (serve index.html for unknown routes)
- `cached`: Path prefixes for immutable cache headers (browser won't check for changes)
- `favicon`: Path to serve at `/favicon.ico` (e.g., `"/logo.png"` will be served as `image/png`)
`Frontend` serves a directory with:
- RAM caching, with zstd compression when smaller than original
- Browser caching: ETag + Last-Modified, Immutable assets
- Favicon mapping (serve PNG or other images there instead)
- SPA routing (serve browsers index.html at all paths not otherwise handled)
Dev-mode behavior with `FastAPI(debug=True)`: requests error HTTP 409 with a message telling you to use the Vite dev server instead. Avoids accidentally using outdated `frontend-build` during development.
- `directory`: Path on local filesystem
- `index`: Index file name (default: `index.html`)
- `spa`: Serve index at any path (default: `False`)
- `catch_all`: Register a single catch-all handler instead of a route to each file; default for SPA
- `cached`: Path prefixes treated as immutable (default: `/assets/`)
- `favicon`: Optional path or glob (e.g. `/assets/logo*.png`)
- `zstdlevel`: Compression level (default: 18)
️ Even when your page has a meta tag giving favicon location, browsers still try loading `/favicon.ico` whenever looking at something else. We find it more convenient to simply serve the image where the browser expects it, with correct MIME type. This also allows having a default favicon for your application that can be easily overriden at the reverse proxy (Caddy, Nginx) to serve the company branding if needed in deployment.
## Server runner
When you need more flexibility than `fastapi` CLI can provide (e.g. CLI arguments to your own program), you may use this convenience to run FastAPI app with Uvicorn startup on given `listen` endpoints. Runs in the same process if possible but delegates to `uvicorn.run()` for auto-reloads and multiple workers. This would typically be called from your CLI main, which can set its own env variables to pass information to the FastAPI instances that run (Python imports only work in same-process mode).
```python
from fastapi_vue import server
server.run("my_app.app:app", listen=["localhost:8000"])
```
- As a deployment option, environment `FORWARDED_ALLOW_IPS` controls `X-Forwarded` trusted IPs (default: `127.0.0.1,::1`).
+17
View File
@@ -12,6 +12,7 @@ def parse_endpoint(value: str | None, default_port: int = 0) -> list[dict]:
Returns:
List of dicts with uvicorn bind kwargs (host/port or uds).
Two entries may be returned for IPv4 and IPv6 (all interaces).
Supported forms:
- None or empty -> [{host: "localhost", port: default_port}]
@@ -65,3 +66,19 @@ def parse_endpoint(value: str | None, default_port: int = 0) -> list[dict]:
ipaddress.ip_address(host)
return [{"host": host, "port": port}]
def parse_endpoints(
listen: str | list[str] | None = None, default_port: int = 8000
) -> list[dict]:
"""Parse listen strings into a list of endpoint dicts.
Args:
listen: Endpoint string(s) (see parse_endpoint for formats).
default_port: Port to use when not specified in listen args.
"""
if listen is None:
listen = [f"localhost:{default_port}"]
elif isinstance(listen, str):
listen = [listen]
return [ep for s in listen for ep in parse_endpoint(s, default_port)]
+5 -9
View File
@@ -6,7 +6,7 @@ from contextlib import suppress
import uvicorn
from uvicorn import Config, Server
from .hostutil import parse_endpoint
from .hostutil import parse_endpoints
logger = logging.getLogger(__name__)
@@ -30,13 +30,9 @@ def run(
workers: Number of worker processes (requires uvicorn.run, single endpoint only).
**uvicorn_config: Additional uvicorn config options (overrides all other settings).
"""
if listen is None:
listen = [f"localhost:{default_port}"]
elif isinstance(listen, str):
listen = [listen]
endpoints: list[dict] = []
for ep in listen:
endpoints.extend(parse_endpoint(ep, default_port))
endpoints = parse_endpoints(listen, default_port)
if not endpoints:
raise ValueError("No endpoints to serve; check listen configuration")
conf: dict[str, object] = {"app": app, "reload": reload, "workers": workers}
proxy = os.getenv("FORWARDED_ALLOW_IPS", "127.0.0.1,::1")
@@ -45,7 +41,7 @@ def run(
conf["forwarded_allow_ips"] = proxy
conf.update(uvicorn_config)
with suppress(KeyboardInterrupt):
with suppress(KeyboardInterrupt, asyncio.CancelledError):
if reload or workers:
serve_multiprocess(endpoints, **conf)
else:
+1 -1
View File
@@ -276,6 +276,6 @@ def _devmode_respond(request: Request, name=""):
return JSONResponse(
status_code=409,
content={
"detail": "Frontend assets served by Vite in debug mode. You are on backend, connect to frontend instead."
"detail": "[devmode] Not serving frontend files here. Should you connect to Vite instead?"
},
)
+306 -136
View File
@@ -8,11 +8,12 @@ Usage:
Options:
--module-name NAME Python module name (auto-detected from pyproject.toml)
--ports DEFAULT,VITE,DEV Port configuration (default: 3100,3100,3200)
--dry-run Show what would be done without making changes
--dry Show what would be done without making changes
"""
import argparse
import ast
import importlib.metadata
import os
import re
import shutil
@@ -20,31 +21,73 @@ import subprocess
import sys
from pathlib import Path
from textwrap import indent
from typing import Literal
import tomlkit
# Track Python files written/patched for ruff formatting
_python_files_to_format: list[Path] = []
version = importlib.metadata.version("fastapi-vue-setup")
# Template directory
TEMPLATE_DIR = Path(__file__).parent / "template"
def ruff_sort_imports(files: list[Path], dry_run: bool = False) -> None:
"""Run ruff to sort imports in the given Python files."""
if not files:
return
py_files = [str(f) for f in files if f.suffix == ".py" and f.exists()]
if not py_files:
return
if dry_run:
print(f"🔧 Would run ruff import sorting on {len(py_files)} files")
return
print("🔧 Ruff isort on modified files")
subprocess.run(
["ruff", "check", "--select", "I", "--fix", *py_files],
stdout=subprocess.DEVNULL,
)
def print_boxed(text: str) -> None:
"""Print text in a Unicode rounded box."""
width = len(text) + 2
print(f"{'' * width}")
print(f"{text}")
print(f"{'' * width}")
def ruff_format_content(
content: str, target_path: Path, *, mode: Literal["isort", "full"] = "full"
) -> str:
"""Format Python content using ruff with project settings.
Writes to a temp file next to target, runs ruff check (import sorting)
and optionally ruff format on it, reads back the result, and cleans up.
Returns the formatted content, or original if ruff fails.
mode='isort' only sorts imports; mode='full' also formats.
"""
temp_file = target_path.with_suffix(".new.py")
try:
temp_file.write_text(content, "UTF-8", newline="\n")
# Sort imports first
subprocess.run(
[
"uv",
"run",
"--with",
"ruff",
"ruff",
"check",
"--select",
"I",
"--fix",
str(temp_file),
],
cwd=target_path.parent,
capture_output=True,
)
if mode == "isort":
return temp_file.read_text("UTF-8")
# Then format
result = subprocess.run(
["uv", "run", "--with", "ruff", "ruff", "format", str(temp_file)],
cwd=target_path.parent,
capture_output=True,
)
if result.returncode == 0:
return temp_file.read_text("UTF-8")
except Exception:
pass
finally:
try:
temp_file.unlink(missing_ok=True)
except Exception:
pass
return content
def uv_add_packages(
@@ -67,6 +110,9 @@ def uv_add_packages(
# If vite == dev, dev is incremented by 100
DEFAULT_PORTS = (3100, 3100, 3200)
# Default health check path for devserver backend readiness check
DEFAULT_HEALTH = "/api/health?from=devserver.py"
# Marker comment indicating file can be auto-upgraded
# Users should remove this line to prevent automatic updates
UPGRADE_MARKER = "auto-upgrade@fastapi-vue-setup"
@@ -115,7 +161,7 @@ const backendStatus = ref<'checking' | 'connected' | 'error'>('checking')
onMounted(async () => {
try {
const res = await fetch('/api/health')
const res = await fetch('/api/health?from=frontend')
backendStatus.value = res.ok ? 'connected' : 'error'
} catch {
backendStatus.value = 'error'
@@ -131,7 +177,7 @@ const backendStatus = ref('checking')
onMounted(async () => {
try {
const res = await fetch('/api/health')
const res = await fetch('/api/health?from=frontend')
backendStatus.value = res.ok ? 'connected' : 'error'
} catch {
backendStatus.value = 'error'
@@ -150,17 +196,16 @@ STATUS_SPAN_TEMPLATE = """\
"""
# Setup complete message template
SETUP_COMPLETE_MESSAGE = """
Next steps:
SETUP_COMPLETE_MESSAGE = """\
## Development server: (live reloads, debug)
CD_CMDuv run scripts/devserver.py
1. Build for production:
CD_CMDuv build
## Production build:
CD_CMDuv build && uv run SCRIPT_NAME
2. Start development server:
CD_CMDuv run scripts/devserver.py
3. Run production server:
CD_CMDuv run SCRIPT_NAME
## Release Python package, run anywhere:
CD_CMDuv build && uv publish
uvx SCRIPT_NAME # No Node required
"""
@@ -218,23 +263,20 @@ def find_import_insertion_line(source: str) -> int:
return 2 if source.startswith("#!") else 1
def extract_existing_ports(project_dir: Path) -> tuple[int, int, int] | None:
def extract_existing_ports(
project_dir: Path, main: Path
) -> tuple[int, int, int] | None:
"""Extract existing port configuration from project files.
Returns (default, vite, dev) or None if not found.
"""
module_name = find_module_name(project_dir)
if not module_name:
return None
default_port = None
vite_port = None
dev_port = None
# Try to extract DEFAULT_PORT from __main__.py
main_file = project_dir / module_name / "__main__.py"
if main_file.exists():
content = main_file.read_text("UTF-8")
# Try to extract DEFAULT_PORT from the CLI main module
if main.exists():
content = main.read_text("UTF-8")
match = re.search(r"DEFAULT_PORT\s*=\s*(\d+)", content)
if match:
default_port = int(match.group(1))
@@ -261,6 +303,29 @@ def extract_existing_ports(project_dir: Path) -> tuple[int, int, int] | None:
return None
# Sentinel for "not found" in extract_existing_health
_HEALTH_NOT_FOUND = object()
def extract_existing_health(project_dir: Path) -> str | object:
"""Extract existing health path configuration from devserver.py.
Returns:
- The path string (may be empty to disable)
- _HEALTH_NOT_FOUND sentinel if not found or file doesn't exist
"""
devserver_file = project_dir / "scripts" / "devserver.py"
if not devserver_file.exists():
return _HEALTH_NOT_FOUND
content = devserver_file.read_text("UTF-8")
# Match HEALTH = "/path" or HEALTH = ""
match = re.search(r'^HEALTH\s*=\s*"([^"]*)"', content, re.MULTILINE)
if match:
return match.group(1)
return _HEALTH_NOT_FOUND
def load_template(path: str) -> str:
"""Load a template file from the template directory."""
return (TEMPLATE_DIR / path).read_text("UTF-8")
@@ -392,10 +457,43 @@ def _find_app_in_subpackage(subpkg_dir: Path) -> tuple[Path, str] | None:
return None
def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str | None:
def _add_devmode_to_main(content: str) -> str:
"""Add DEVMODE variable to an existing main module."""
lines = content.splitlines()
# Check if os is imported
has_os_import = any("import os" in line for line in lines)
# Find the first import line
insert_idx = 0
for i, line in enumerate(lines):
stripped = line.strip()
if stripped.startswith("import ") or stripped.startswith("from "):
insert_idx = i + 1
elif stripped and not stripped.startswith("#"):
break
# Insert imports and DEVMODE after existing imports
new_lines = []
if not has_os_import:
new_lines.append("import os")
new_lines.extend(
[
"",
"# Added by fastapi-vue-setup",
'DEVMODE = os.getenv("ENVPREFIX_DEV") == "1"',
"",
]
)
lines[insert_idx:insert_idx] = new_lines
return "\n".join(lines)
def _find_existing_cli_module_path(project_dir: Path, module_name: str) -> str | None:
"""Check if pyproject.toml already has a CLI entrypoint for this module.
Returns the entrypoint string if found, None otherwise.
Returns the module path (e.g., 'module.subpkg.__main__') if found, None otherwise.
"""
pyproject = project_dir / "pyproject.toml"
if not pyproject.exists():
@@ -413,7 +511,10 @@ def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str |
# Look for any script that references our module
for script_name, entry in scripts.items():
if isinstance(entry, str) and entry.startswith(f"{module_name}."):
return f'{script_name} = "{entry}"'
# Extract module path from "module.subpkg.__main__:main"
if ":" in entry:
module_path, _ = entry.rsplit(":", 1)
return module_path
return None
@@ -482,7 +583,7 @@ def render_template(template: str, **kwargs) -> str:
def patch_app_file(
path: Path, module_name: str, app_var: str, dry_run: bool = False
path: Path, main_module_path: str, app_var: str, dry: bool = False
) -> bool:
"""Patch an existing app.py with frontend integration.
@@ -500,7 +601,7 @@ def patch_app_file(
# Check what's already patched
has_frontend = "from fastapi_vue import Frontend" in content
has_devmode = f"from {module_name}.__main__ import DEVMODE" in content
has_devmode = f"from {main_module_path} import DEVMODE" in content
has_debug_arg = re.search(r"FastAPI\s*\([^)]*debug\s*=", content) is not None
has_lifespan = "await frontend.load()" in content
@@ -515,7 +616,7 @@ def patch_app_file(
if not has_frontend:
imports.extend(["from pathlib import Path", "from fastapi_vue import Frontend"])
if not has_devmode:
imports.append(f"from {module_name}.__main__ import DEVMODE")
imports.append(f"from {main_module_path} import DEVMODE")
if imports:
insert_line = find_import_insertion_line(content)
lines = content.splitlines(keepends=True)
@@ -640,12 +741,13 @@ def patch_app_file(
print(f"⚠️ Skipping {path} (no changes needed)")
return False
if dry_run:
if dry:
print(f"✅ Would patch {path}")
return True
# Sort imports only (avoid full formatting of user code)
content = ruff_format_content(content, path, mode="isort")
path.write_text(content, "UTF-8", newline="\n")
_python_files_to_format.append(path)
print(f"✅ Patched {path}")
if not lifespan_patched:
@@ -669,7 +771,7 @@ def patch_app_file(
def patch_vite_config(
path: Path,
module_name: str,
dry_run: bool = False,
dry: bool = False,
) -> bool:
"""Patch an existing vite.config.js/ts by adding fastapi-vue plugin.
@@ -731,7 +833,7 @@ def patch_vite_config(
print(f"️ Skipping {path} (no changes needed)")
return False
if dry_run:
if dry:
print(f"✅ Would patch {path}")
return True
@@ -740,7 +842,7 @@ def patch_vite_config(
return True
def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bool:
def patch_frontend_health_check(frontend_dir: Path, dry: bool = False) -> bool:
"""Patch Vue app to include FastAPI backend health check.
Tries HelloWorld.vue first (full demo), then falls back to App.vue (minimal).
@@ -766,7 +868,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
target_file = app_vue
if target_file is None:
print("️ No Vue file found to patch, skipping frontend health check")
print("️ No default App.vue found to patch, not adding /api/health check")
return False
original_content = target_file.read_text("UTF-8")
@@ -811,7 +913,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
else:
# Minimal App.vue - only patch if it contains the default welcome message
if "<h1>You did it!</h1>" not in content:
print(f"️ Skipping {target_file} (not a default Vue template)")
print(f"️ Skipping {target_file} (not a Vue demo app)")
return False
# Insert before the </p> tag
template_end = content.find("</template>")
@@ -831,7 +933,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
print(f"️ Skipping {target_file} (no changes needed)")
return False
if dry_run:
if dry:
print(f"✅ Would patch {target_file}")
return True
@@ -847,9 +949,7 @@ _OLD_VITE_PLUGIN_SHA256 = (
)
def _upgrade_old_vite_plugin(
path: Path, module_name: str, dry_run: bool = False
) -> None:
def _upgrade_old_vite_plugin(path: Path, module_name: str, dry: bool = False) -> None:
"""Remove old vite-plugin-fastapi.js that lacks auto-upgrade marker.
Old versions didn't have the upgrade marker, so write_file skips them as
@@ -869,7 +969,7 @@ def _upgrade_old_vite_plugin(
digest = hashlib.sha256(normalized.encode()).hexdigest()
if digest != _OLD_VITE_PLUGIN_SHA256:
return # Modified by user, don't touch
if dry_run:
if dry:
print(f"🔄 Would upgrade old {path}")
return
path.unlink()
@@ -884,7 +984,7 @@ def write_file(
path: Path,
content: str,
overwrite: bool = True,
dry_run: bool = False,
dry: bool = False,
executable: bool = False,
fallback_path: Path | None = None,
force: bool = False,
@@ -895,13 +995,20 @@ def write_file(
the content will be written to fallback_path instead of being skipped.
If force=True, always overwrite without checking for upgrade marker.
Python files (.py) are automatically formatted using ruff with the project's
settings before writing.
"""
# Format Python content using project settings before any comparison/writing
if path.suffix == ".py":
content = ruff_format_content(content, path)
exists = path.exists()
if exists and not overwrite:
print(f"⚠️ Skipping {path} (exists)")
return False
# Check if content is the same
# Check if content is the same (new content already formatted)
if exists:
existing_content = path.read_text("UTF-8")
if existing_content == content:
@@ -913,12 +1020,12 @@ def write_file(
if fallback_path is not None:
# Write to fallback path instead
return _write_fallback_file(
path, fallback_path, content, dry_run, executable
path, fallback_path, content, dry, executable
)
print(f"️ Skipping {path} (customized by user)")
return False
if dry_run:
if dry:
action = "overwrite" if exists else "create"
print(f"✅ Would {action} {path}")
return True
@@ -927,8 +1034,6 @@ def write_file(
path.write_text(content, "UTF-8", newline="\n")
if executable and sys.platform != "win32":
path.chmod(path.stat().st_mode | 0o111)
if path.suffix == ".py":
_python_files_to_format.append(path)
action = "Updated" if exists else "Created"
print(f"{action} {path}")
return True
@@ -938,17 +1043,22 @@ def _write_fallback_file(
original_path: Path,
fallback_path: Path,
content: str,
dry_run: bool,
dry: bool,
executable: bool,
) -> bool:
"""Write content to a fallback .new.py file when original can't be overwritten."""
# Check if fallback already has same content
"""Write content to a fallback .new.py file when original can't be overwritten.
Note: content should already be formatted before calling this function.
"""
# Check if fallback already has same content (content already formatted)
if fallback_path.exists():
if fallback_path.read_text("UTF-8") == content:
existing_content = fallback_path.read_text("UTF-8")
if existing_content == content:
print(f"✔️ {fallback_path} (already up to date)")
_new_files_written.append((fallback_path, original_path))
return False
if dry_run:
if dry:
print(f"✅ Would create {fallback_path} (original customized by user)")
_new_files_written.append((fallback_path, original_path))
return True
@@ -957,8 +1067,6 @@ def _write_fallback_file(
fallback_path.write_text(content, "UTF-8", newline="\n")
if executable and sys.platform != "win32":
fallback_path.chmod(fallback_path.stat().st_mode | 0o111)
if fallback_path.suffix == ".py":
_python_files_to_format.append(fallback_path)
print(f"✅ Created {fallback_path} (original customized by user)")
_new_files_written.append((fallback_path, original_path))
return True
@@ -1085,13 +1193,13 @@ def find_js_runtime() -> tuple[str, str] | None:
return None
def ensure_python_project(project_dir: Path, dry_run: bool = False) -> bool:
def ensure_python_project(project_dir: Path, dry: bool = False) -> bool:
"""Ensure pyproject.toml exists, run uv init if needed."""
pyproject = project_dir / "pyproject.toml"
if pyproject.exists():
return True
if dry_run:
if dry:
print(f"📦 Would run: uv init {project_dir}")
return True
@@ -1111,7 +1219,7 @@ def ensure_python_project(project_dir: Path, dry_run: bool = False) -> bool:
return True
def ensure_frontend(project_dir: Path, dry_run: bool = False) -> bool:
def ensure_frontend(project_dir: Path, dry: bool = False) -> bool:
"""Ensure frontend directory exists with a Vue project, run create-vue if needed."""
frontend_dir = project_dir / "frontend"
package_json = frontend_dir / "package.json"
@@ -1135,7 +1243,7 @@ def ensure_frontend(project_dir: Path, dry_run: bool = False) -> bool:
}
create_cmd = create_vue_commands[js_name]
if dry_run:
if dry:
print(f"🎨 Would run: {' '.join(create_cmd)}")
return True
@@ -1175,11 +1283,15 @@ def cmd_setup(args: argparse.Namespace) -> int:
project_dir = Path.cwd() / project_path
project_dir = project_dir.resolve()
dry_run = args.dry_run
dry = args.dry
print_boxed(f"fastapi-vue-setup {version}")
if dry:
print("🏃 DRY RUN MODE - no changes will be made\n")
# Create project directory if it doesn't exist
if not project_dir.exists():
if dry_run:
if dry:
print(f"✅ Would create directory: {project_dir}")
else:
project_dir.mkdir(parents=True)
@@ -1187,15 +1299,12 @@ def cmd_setup(args: argparse.Namespace) -> int:
print(f"🔧 Setting up project: {project_dir}")
if dry_run:
print("\n🏃 DRY RUN MODE - no changes will be made\n")
# Step 1: Ensure frontend exists (do this first so cancellation doesn't leave partial setup)
if not ensure_frontend(project_dir, dry_run):
if not ensure_frontend(project_dir, dry):
return 1
# Step 2: Ensure Python project exists
if not ensure_python_project(project_dir, dry_run):
if not ensure_python_project(project_dir, dry):
return 1
# Detect module name
@@ -1207,13 +1316,28 @@ def cmd_setup(args: argparse.Namespace) -> int:
else:
print(f"📦 Module: {module_name}")
module_dir = project_dir / module_name
scripts_dir = project_dir / "scripts"
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
# Check if project already has a CLI entrypoint in pyproject.toml
existing_cli_module = _find_existing_cli_module_path(project_dir, module_name)
# Determine main module path for DEVMODE import
main_module_path = existing_cli_module or f"{module_name}.__main__"
if existing_cli_module:
print(f"️ Using existing CLI: {existing_cli_module}")
# Resolve the CLI main module to a file path
main = project_dir / Path(*main_module_path.split(".")).with_suffix(".py")
# Determine port configuration
# Priority: --ports argument > existing project values > defaults
if args.ports:
default_port, vite_port, dev_port = parse_ports(args.ports)
ports_note = "(--ports)"
else:
existing_ports = extract_existing_ports(project_dir)
existing_ports = extract_existing_ports(project_dir, main)
if existing_ports:
default_port, vite_port, dev_port = existing_ports
ports_note = "(kept for upgrade)"
@@ -1225,9 +1349,35 @@ def cmd_setup(args: argparse.Namespace) -> int:
f"📡 Ports: default={default_port}, vite={vite_port}, dev={dev_port} {ports_note}"
)
# Determine health path configuration
# Priority: --health argument > existing project value > default
if args.health is not None:
health = args.health
health_note = "(--health)" if health else "(disabled via --health)"
else:
existing_health = extract_existing_health(project_dir)
if existing_health is not _HEALTH_NOT_FOUND:
# Explicitly configured (path string, possibly empty to disable)
health = existing_health
health_note = "(kept for upgrade)"
else:
# Not found - use default
health = DEFAULT_HEALTH
health_note = "(--health to override)"
if health:
print(f"🏥 Health check: {health} {health_note}")
else:
print(f"🏥 Health check: disabled {health_note}")
# Title for templates
project_title = module_name.replace("_", " ").title()
# Find existing FastAPI app
app_info = (
find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
)
# Template variables
tpl_vars = {
"MODULE_NAME": module_name,
@@ -1235,33 +1385,28 @@ def cmd_setup(args: argparse.Namespace) -> int:
"TEMPLATE_DEFAULT_PORT": str(default_port),
"TEMPLATE_VITE_PORT": str(vite_port),
"TEMPLATE_DEV_PORT": str(dev_port),
"TEMPLATE_HEALTH": f'"{health}"',
"ENVPREFIX": module_name.upper(),
"PROJECT_CLI": module_name,
"MAIN_MODULE": main_module_path,
}
module_dir = project_dir / module_name
scripts_dir = project_dir / "scripts"
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
# Find existing FastAPI app
app_info = (
find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
)
if app_info:
app_file, app_var = app_info
print(f"📍 Found FastAPI app: {app_var} in {app_file.name}")
tpl_vars["APP_VAR"] = app_var
tpl_vars["APP_MODULE"] = app_file.stem
# Dotted module path relative to project dir (e.g. "paskia.fastapi.mainapp")
app_module = ".".join(app_file.relative_to(project_dir).with_suffix("").parts)
tpl_vars["APP_MODULE"] = app_module
else:
print("📍 No existing FastAPI app found, will create new one")
app_file = None
app_var = "app"
tpl_vars["APP_VAR"] = app_var
tpl_vars["APP_MODULE"] = "app"
tpl_vars["APP_MODULE"] = f"{module_name}.app"
# Create directories
if not dry_run:
if not dry:
if not module_dir.exists():
module_dir.mkdir(parents=True)
fastapi_vue_scripts.mkdir(parents=True, exist_ok=True)
@@ -1273,7 +1418,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Remove obsolete util.py if present
obsolete_util = fastapi_vue_scripts / "util.py"
if obsolete_util.exists():
if dry_run:
if dry:
print(f"🗑️ Would remove obsolete {obsolete_util}")
else:
obsolete_util.unlink()
@@ -1290,7 +1435,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
dest_path,
content,
overwrite=True,
dry_run=dry_run,
dry=dry,
force=True, # Internal files, always overwrite
)
@@ -1303,7 +1448,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
devserver_path,
content,
overwrite=True,
dry_run=dry_run,
dry=dry,
executable=True,
fallback_path=devserver_fallback,
)
@@ -1311,7 +1456,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
# === Handle app module ===
if app_file:
# Existing app: patch with import, route, and try to patch lifespan
patch_app_file(app_file, module_name, app_var, dry_run=dry_run)
patch_app_file(app_file, main_module_path, app_var, dry=dry)
else:
# No app: create full app.py
# Create __init__.py if missing
@@ -1319,43 +1464,66 @@ def cmd_setup(args: argparse.Namespace) -> int:
if not init_file.exists():
template = load_template("backend/__init__.py")
content = render_template(template, **tpl_vars)
write_file(init_file, content, overwrite=False, dry_run=dry_run)
write_file(init_file, content, overwrite=False, dry=dry)
# Create app.py
app_file_path = module_dir / "app.py"
template = load_template("backend/app.py")
content = render_template(template, **tpl_vars)
write_file(app_file_path, content, overwrite=False, dry_run=dry_run)
write_file(app_file_path, content, overwrite=False, dry=dry)
# === Handle __main__.py ===
if existing_cli_module:
# Existing CLI entrypoint - write .new.py beside the existing main module
main_fallback = main.with_suffix(".new.py")
else:
main_fallback = module_dir / "__main__.new.py"
main_file = module_dir / "__main__.py"
main_fallback = module_dir / "__main__.new.py"
template = load_template("backend/__main__.py")
main_content = render_template(template, **tpl_vars)
# Check if project already has a CLI entrypoint in pyproject.toml
existing_cli = _find_existing_cli_entrypoint(project_dir, module_name)
if main_file.exists():
# File exists: update if it has the auto-upgrade marker, otherwise use fallback
write_file(
main_file,
main_content,
overwrite=True,
dry_run=dry_run,
dry=dry,
fallback_path=main_fallback,
)
elif not existing_cli:
elif not existing_cli_module:
# No file and no existing entrypoint: create new __main__.py
write_file(
main_file,
main_content,
overwrite=False,
dry_run=dry_run,
dry=dry,
)
else:
# No file but has existing entrypoint - don't create (user has custom CLI setup)
print(f"️ Skipping __main__.py (package already has CLI: {existing_cli})")
# Existing CLI entrypoint: write our template as .new.py beside the existing module
# and also patch the existing module with DEVMODE if needed
_write_fallback_file(
main,
main_fallback,
main_content,
dry=dry,
executable=False,
)
if main.exists():
content = main.read_text("UTF-8")
if "DEVMODE" not in content:
new_content = _add_devmode_to_main(content)
new_file = main.with_suffix(".new.py")
_write_fallback_file(
main,
new_file,
new_content,
dry=dry,
executable=False,
)
else:
print(f"⚠️ Existing CLI main module {main} not found")
# === Update vite.config.js/ts ===
frontend_dir = project_dir / "frontend"
@@ -1363,25 +1531,25 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Install the vite plugin file (always update)
plugin_file = frontend_dir / "vite-plugin-fastapi.js"
# Upgrade old plugin versions that lack the auto-upgrade marker
_upgrade_old_vite_plugin(plugin_file, module_name, dry_run)
_upgrade_old_vite_plugin(plugin_file, module_name, dry)
template = load_template("frontend/vite-plugin-fastapi.js")
content = render_template(template, **tpl_vars)
write_file(plugin_file, content, overwrite=True, dry_run=dry_run)
write_file(plugin_file, content, overwrite=True, dry=dry)
# Find existing vite config (prefer .ts, fall back to .js)
vite_config_ts = frontend_dir / "vite.config.ts"
vite_config_js = frontend_dir / "vite.config.js"
if vite_config_ts.exists():
patch_vite_config(vite_config_ts, module_name, dry_run)
patch_vite_config(vite_config_ts, module_name, dry)
elif vite_config_js.exists():
patch_vite_config(vite_config_js, module_name, dry_run)
patch_vite_config(vite_config_js, module_name, dry)
else:
print("⚠️ No vite.config.ts or vite.config.js found in frontend/")
print(" Run create-vue first to generate a Vite config to patch.")
# Patch Vue app with backend health check
patch_frontend_health_check(frontend_dir, dry_run)
patch_frontend_health_check(frontend_dir, dry)
# === Update pyproject.toml ===
pyproject_path = project_dir / "pyproject.toml"
@@ -1402,7 +1570,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
if new_content == old_content:
print(f"✔️ {pyproject_path} (already up to date)")
elif dry_run:
elif dry:
print(f"✅ Would update {pyproject_path}")
else:
pyproject_path.write_text(new_content, "UTF-8", newline="\n")
@@ -1415,7 +1583,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
gitignore_content = gitignore_path.read_bytes()
if b"frontend-build" in gitignore_content:
print("✔️ .gitignore (frontend-build already ignored)")
elif dry_run:
elif dry:
print(f"✅ Would add {gitignore_entry} to .gitignore")
else:
nl = b"\r\n" if b"\r\n" in gitignore_content else b"\n"
@@ -1424,15 +1592,14 @@ def cmd_setup(args: argparse.Namespace) -> int:
gitignore_content + suffix + gitignore_entry.encode() + nl
)
print(f"✅ Added {gitignore_entry} to .gitignore")
elif dry_run:
elif dry:
print(f"✅ Would create .gitignore with {gitignore_entry}")
else:
gitignore_path.write_text(f"{gitignore_entry}\n", "UTF-8", newline="\n")
print("✅ Created .gitignore")
# === Add dependencies using uv ===
ruff_sort_imports(_python_files_to_format, dry_run=dry_run)
if dry_run:
if dry:
print("📦 Would add: fastapi[standard], fastapi-vue, httpx (dev only)")
else:
print("📦 Dependencies")
@@ -1440,12 +1607,10 @@ def cmd_setup(args: argparse.Namespace) -> int:
uv_add_packages(["httpx"], cwd=project_dir, group="dev")
print()
print("=" * 60)
print("✅ Setup complete!")
print("=" * 60)
print_boxed("Setup complete!")
# Show cd command only if project is not in current directory
cd_cmd = "" if project_dir == Path.cwd() else f"cd {project_dir}\n "
cd_cmd = "" if project_dir == Path.cwd() else f"cd {project_dir}; "
script_name = module_name.replace("_", "-")
message = SETUP_COMPLETE_MESSAGE.replace("CD_CMD", cd_cmd).replace(
@@ -1456,12 +1621,16 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Show merge note if any .new.py files were written
if _new_files_written:
print()
print(
"⚠️ Note: Some files could not be auto-upgraded because you customized them."
)
print("⚠️ Some files could not be auto-upgraded because you customized them.")
print(" Please manually merge the following files:")
for new_file, original_file in _new_files_written:
print(f"{new_file.name}{original_file.name}")
try:
new_rel = new_file.relative_to(project_dir)
orig_rel = original_file.relative_to(project_dir)
except ValueError:
new_rel = new_file.name
orig_rel = original_file.name
print(f"{new_rel}{orig_rel}")
print()
# Clear the list for potential subsequent runs
_new_files_written.clear()
@@ -1469,11 +1638,6 @@ def cmd_setup(args: argparse.Namespace) -> int:
return 0
# =============================================================================
# Main entry point
# =============================================================================
def is_uninitialized_folder(path: Path) -> bool:
"""Check if a folder appears to be completely uninitialized."""
return (
@@ -1496,14 +1660,14 @@ def is_already_patched(path: Path) -> bool:
def main() -> int:
parser = argparse.ArgumentParser(
description="Set up FastAPI+Vue projects with integrated build/dev systems",
description=f"fastapi-vue-setup {version} - FastAPI + Vue project setup tool",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Examples:
fastapi-vue-setup my-new-project Create a new project from scratch
fastapi-vue-setup . Set up integration in current directory
fastapi-vue-setup . --dry-run Preview what would be done
fastapi-vue-setup . --ports 8000,5173,8080 Custom ports (default,vite,dev)
fastapi-vue-setup . --dry Preview what would be done
fastapi-vue-setup . --ports=8000,5173,8080 Change default ports (backend, vite dev, backend dev)
""",
)
parser.add_argument(
@@ -1512,14 +1676,20 @@ Examples:
default=None,
help="Project directory (use . for current directory)",
)
parser.add_argument("--version", action="version", version=version)
parser.add_argument("--module-name", help="Python module name (auto-detected)")
parser.add_argument(
"--ports",
metavar="DEFAULT,VITE,DEV",
metavar="BACKEND,VITE,DEV",
help="Port configuration as comma-separated values (default: 3100,3100,3200)",
)
parser.add_argument(
"--dry-run", action="store_true", help="Show what would be done"
"--health",
metavar="PATH",
help="Health check path for devserver (default: /api/health?from=devserver.py, '' to disable)",
)
parser.add_argument(
"--dry", "--dry-run", action="store_true", help="Show what would be done"
)
args = parser.parse_args()
+4 -4
View File
@@ -5,7 +5,7 @@ import os
from fastapi_vue import server
DEFAULT_PORT = TEMPLATE_DEFAULT_PORT
DEVMODE = bool(os.getenv("ENVPREFIX_FRONTEND_URL"))
DEVMODE = os.getenv("ENVPREFIX_DEV") == "1"
def main():
@@ -17,12 +17,12 @@ def main():
help=(f"Endpoint (default: localhost:{DEFAULT_PORT})."),
)
args = parser.parse_args()
dev = {"reload": True, "reload_dirs": ["MODULE_NAME"]}
dev = {"reload": True, "reload_dirs": ["paskia"]} if DEVMODE else {}
server.run(
"MODULE_NAME.APP_MODULE:APP_VAR",
"APP_MODULE:APP_VAR",
listen=args.listen,
default_port=DEFAULT_PORT,
**(dev if DEVMODE else {}),
**dev,
)
+1 -1
View File
@@ -3,7 +3,7 @@ from pathlib import Path
from fastapi import FastAPI
from fastapi_vue import Frontend
from MODULE_NAME.__main__ import DEVMODE
from MAIN_MODULE import DEVMODE
# Vue Frontend static files
frontend = Frontend(Path(__file__).with_name("frontend-build"))
+1 -1
View File
@@ -11,7 +11,7 @@
*/
export default function fastapiVue({ paths = ["/api"] } = {}) {
const backendUrl = process.env.ENVPREFIX_BACKEND_URL || "http://localhost:TEMPLATE_DEFAULT_PORT"
const backendUrl = process.env.ENVPREFIX_BACKEND_URL || "http://localhost:TEMPLATE_DEV_PORT"
// Build proxy configuration for each path
const proxy = {}
+16 -14
View File
@@ -1,6 +1,6 @@
#!/usr/bin/env -S uv run
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file
"""Run Vite development server for frontend and FastAPI backend with auto-reload."""
"""Run Vite development server for Vue app and FastAPI backend with auto-reload."""
import argparse
import asyncio
@@ -22,10 +22,11 @@ from devutil import ( # type: ignore
DEFAULT_VITE_PORT = TEMPLATE_VITE_PORT
DEFAULT_DEV_PORT = TEMPLATE_DEV_PORT
HEALTH = TEMPLATE_HEALTH
async def run_devserver(
frontend: str, backend: str, extra_args: list[str] | None = None
listen: str, backend: str, extra_args: list[str] | None = None
) -> None:
reporoot = Path(__file__).parent.parent
front = reporoot / "frontend"
@@ -33,18 +34,19 @@ async def run_devserver(
logger.warning("Frontend source not found at %s", front)
raise SystemExit(1)
viteurl, npm_install, vite = setup_vite(frontend, DEFAULT_VITE_PORT)
viteurl, npm_install, vite = setup_vite(listen, DEFAULT_VITE_PORT)
backurl, MODULE_NAME = setup_cli("PROJECT_CLI", backend, DEFAULT_DEV_PORT)
# Tell the everyone where the frontend and backend are (vite proxy, etc)
os.environ["ENVPREFIX_FRONTEND_URL"] = viteurl
# Tell the everyone by environment (vite proxy and backend devmode use these)
os.environ["ENVPREFIX_VITE_URL"] = viteurl
os.environ["ENVPREFIX_BACKEND_URL"] = backurl
os.environ["ENVPREFIX_DEV"] = "1"
async with ProcessGroup() as pg:
npm_i = await pg.spawn(*npm_install, cwd=front)
await check_ports_free(viteurl, backurl)
await pg.spawn(*MODULE_NAME, *(extra_args or []))
await pg.wait(npm_i, ready(backurl, path="/api/health?from=devserver.py"))
await pg.wait(npm_i, ready(backurl, path=HEALTH))
await pg.spawn(*vite, cwd=front)
@@ -55,23 +57,23 @@ def main():
epilog=HELP_EPILOG,
)
parser.add_argument(
"frontend",
nargs="?",
metavar="host:port",
help=f"Vite frontend endpoint (default: localhost:{DEFAULT_VITE_PORT})",
"-l",
"--listen",
metavar="addr",
help=f"Vite (default: localhost:{DEFAULT_VITE_PORT})",
)
parser.add_argument(
"--backend",
metavar="host:port",
help=f"FastAPI backend endpoint (default: localhost:{DEFAULT_DEV_PORT})",
metavar="addr",
help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})",
)
args, extra_args = parser.parse_known_args()
with suppress(KeyboardInterrupt):
asyncio.run(run_devserver(args.frontend, args.backend, extra_args))
asyncio.run(run_devserver(args.listen, args.backend, extra_args))
HELP_EPILOG = """
scripts/devserver.py [args to PROJECT_CLI]
Other options are forwarded to PROJECT_CLI [args]
JS_RUNTIME environment variable can be used to select the JS runtime:
npm, deno, bun, or full path to the runtime executable (node maps to npm).
+6 -10
View File
@@ -111,18 +111,19 @@ async def check_ports_free(*urls: str) -> None:
await asyncio.gather(*[check(client, url) for url in urls])
async def ready(url: str, path: str = "") -> None:
async def ready(url: str, path: str = "", max_attempts=50) -> None:
"""Wait for the server to be ready by polling an endpoint.
Use empty path to disable the check and make this return immediately.
Raises SystemExit(1) if server doesn't start in time.
"""
max_attempts = 50
full_url = f"{url}{path}"
if not path:
return
async with httpx.AsyncClient() as client:
for attempt in range(max_attempts):
try:
await client.get(full_url, timeout=1.0)
await client.get(f"{url}{path}", timeout=1.0)
logger.info("✓ Backend ready!")
return
except httpx.RequestError:
@@ -207,10 +208,5 @@ def setup_cli(
host = endpoints[0]["host"]
port = endpoints[0]["port"]
cmd = [
sys.executable,
"-m",
cli,
f"--listen={host}:{port}",
]
cmd = [cli, f"--listen={host}:{port}"]
return f"http://{host}:{port}", cmd