Compare commits

..
18 Commits
Author SHA1 Message Date
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
LeoVasanko b8bf46132a Reload arguments passed differently to avoid uvicorn warning in prod mode. 2026-02-06 22:43:00 +00:00
LeoVasanko ca85c2fcfb Ruff 2026-02-06 22:37:03 +00:00
8 changed files with 246 additions and 232 deletions
+53 -94
View File
@@ -1,137 +1,96 @@
# fastapi-vue-setup # 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 ## Quick start
- **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
## 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 - project directory: `my-app/`
uv tool install fastapi-vue-setup - Python module: `my_app`
fastapi-vue-setup --help - env prefix: `MY_APP`
``` - CLI command: `my-app`
Or run directly: Create a new project in `./my-app`:
```sh ```sh
uvx fastapi-vue-setup my-app 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 ```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` ### Production
2. Run `create-vue frontend` (interactive - choose your Vue options)
3. Patch the project with FastAPI integration
4. Install dependencies via `uv add`
### Patch an existing project Build the Python package (this compiles the Vue frontend) and run the production server:
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.
```sh ```sh
fastapi-vue-setup . uv build && uv run my-app [args]
``` ```
### CLI Options Once happy with it, publish the package
``` ```sh
fastapi-vue-setup [project-dir] [options] uv build && uv publish
Options:
--module-name NAME Python module name (auto-detected from pyproject.toml)
--dry-run Preview changes without modifying files
``` ```
## 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. ```sh
uvx my-app [args]
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"] }),
],
});
``` ```
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/ my-app/
├── frontend/ # Vue application ├── frontend/ # Vue app (Vite)
│ ├── src/ │ ├── src/
│ ├── vite-plugin-fastapi.js │ ├── vite-plugin-fastapi.js
│ ├── vite.config.js
│ └── package.json │ └── package.json
├── my_app/ # Python module (files included in sdist) ├── my_app/ # Python package
│ ├── __init__.py
│ ├── __main__.py # CLI entrypoint │ ├── __main__.py # CLI entrypoint
│ ├── app.py # FastAPI application │ ├── app.py # FastAPI app
│ └── frontend-build/ # Built frontend (gitignored) │ └── frontend-build/ # built assets (included in distributions)
├── scripts/ ├── pyproject.toml
│ ├── devserver.py # CLI dev server (only in source tree) └── scripts/
── fastapi-vue/ ── devserver.py # Run Vite and FastAPI together in dev mode
│ ├── build-frontend.py └── fastapi-vue/ # Dev utilities (only on the source tree)
── util.py ── build-frontend.py
└── pyproject.toml ├── 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 ️ 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.
# 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.
+39 -18
View File
@@ -1,29 +1,25 @@
# fastapi-vue # 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 - `fastapi_vue.Frontend`: serves built SPA assets (with SPA support, caching, and optional zstd)
uvx fastapi-vue-setup --help - `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 ```python
from pathlib import Path
from contextlib import asynccontextmanager from contextlib import asynccontextmanager
from fastapi import FastAPI from fastapi import FastAPI
from fastapi_vue import Frontend from fastapi_vue import Frontend
frontend = Frontend( frontend = Frontend(Path(__file__).with_name("frontend-build"), spa=True)
Path(__file__).with_name("frontend-build"),
spa=True,
cached=["/assets/"],
)
@asynccontextmanager @asynccontextmanager
async def lifespan(app: FastAPI): async def lifespan(app: FastAPI):
@@ -38,10 +34,35 @@ app = FastAPI(lifespan=lifespan)
frontend.route(app, "/") frontend.route(app, "/")
``` ```
## Configuration ## Frontend
- `directory`: Path to static files directory `Frontend` serves a directory with:
- `spa`: Enable SPA mode (serve index.html for unknown routes)
- `cached`: Path prefixes for immutable cache headers (browser won't check for changes) - RAM caching, with zstd compression when smaller than original
- `favicon`: Path to serve at `/favicon.ico` (e.g., `"/logo.png"` will be served as `image/png`) - 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) - `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`).
+1 -1
View File
@@ -276,6 +276,6 @@ def _devmode_respond(request: Request, name=""):
return JSONResponse( return JSONResponse(
status_code=409, status_code=409,
content={ 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?"
}, },
) )
+134 -97
View File
@@ -8,11 +8,12 @@ Usage:
Options: Options:
--module-name NAME Python module name (auto-detected from pyproject.toml) --module-name NAME Python module name (auto-detected from pyproject.toml)
--ports DEFAULT,VITE,DEV Port configuration (default: 3100,3100,3200) --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 argparse
import ast import ast
import importlib.metadata
import os import os
import re import re
import shutil import shutil
@@ -23,28 +24,63 @@ from textwrap import indent
import tomlkit import tomlkit
# Track Python files written/patched for ruff formatting version = importlib.metadata.version("fastapi-vue-setup")
_python_files_to_format: list[Path] = []
# Template directory # Template directory
TEMPLATE_DIR = Path(__file__).parent / "template" TEMPLATE_DIR = Path(__file__).parent / "template"
def ruff_sort_imports(files: list[Path], dry_run: bool = False) -> None: def print_boxed(text: str) -> None:
"""Run ruff to sort imports in the given Python files.""" """Print text in a Unicode rounded box."""
if not files: width = len(text) + 2
return print(f"{'' * width}")
py_files = [str(f) for f in files if f.suffix == ".py" and f.exists()] print(f"{text}")
if not py_files: print(f"{'' * width}")
return
if dry_run:
print(f"🔧 Would run ruff import sorting on {len(py_files)} files") def ruff_format_content(content: str, target_path: Path) -> str:
return """Format Python content using ruff with project settings.
print("🔧 Ruff isort on modified files")
Writes to a temp file (.new.py) next to target, runs ruff check (import sorting)
and ruff format on it, reads back the result, and cleans up.
Returns the formatted content, or original if ruff fails.
"""
temp_file = target_path.with_suffix(".new.py")
try:
temp_file.write_text(content, "UTF-8", newline="\n")
# Sort imports first
subprocess.run( subprocess.run(
["ruff", "check", "--select", "I", "--fix", *py_files], [
stdout=subprocess.DEVNULL, "uv",
"run",
"--with",
"ruff",
"ruff",
"check",
"--select",
"I",
"--fix",
str(temp_file),
],
cwd=target_path.parent,
capture_output=True,
) )
# 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( def uv_add_packages(
@@ -115,7 +151,7 @@ const backendStatus = ref<'checking' | 'connected' | 'error'>('checking')
onMounted(async () => { onMounted(async () => {
try { try {
const res = await fetch('/api/health') const res = await fetch('/api/health?from=frontend')
backendStatus.value = res.ok ? 'connected' : 'error' backendStatus.value = res.ok ? 'connected' : 'error'
} catch { } catch {
backendStatus.value = 'error' backendStatus.value = 'error'
@@ -131,7 +167,7 @@ const backendStatus = ref('checking')
onMounted(async () => { onMounted(async () => {
try { try {
const res = await fetch('/api/health') const res = await fetch('/api/health?from=frontend')
backendStatus.value = res.ok ? 'connected' : 'error' backendStatus.value = res.ok ? 'connected' : 'error'
} catch { } catch {
backendStatus.value = 'error' backendStatus.value = 'error'
@@ -150,17 +186,16 @@ STATUS_SPAN_TEMPLATE = """\
""" """
# Setup complete message template # Setup complete message template
SETUP_COMPLETE_MESSAGE = """ SETUP_COMPLETE_MESSAGE = """\
Next steps: ## Development server: (live reloads, debug)
CD_CMDuv run scripts/devserver.py
1. Build for production: ## Production build:
CD_CMDuv build CD_CMDuv build && uv run SCRIPT_NAME
2. Start development server: ## Release Python package, run anywhere:
CD_CMDuv run scripts/devserver.py CD_CMDuv build && uv publish
uvx SCRIPT_NAME # No Node required
3. Run production server:
CD_CMDuv run SCRIPT_NAME
""" """
@@ -482,7 +517,7 @@ def render_template(template: str, **kwargs) -> str:
def patch_app_file( def patch_app_file(
path: Path, module_name: str, app_var: str, dry_run: bool = False path: Path, module_name: str, app_var: str, dry: bool = False
) -> bool: ) -> bool:
"""Patch an existing app.py with frontend integration. """Patch an existing app.py with frontend integration.
@@ -640,12 +675,11 @@ def patch_app_file(
print(f"⚠️ Skipping {path} (no changes needed)") print(f"⚠️ Skipping {path} (no changes needed)")
return False return False
if dry_run: if dry:
print(f"✅ Would patch {path}") print(f"✅ Would patch {path}")
return True return True
path.write_text(content, "UTF-8", newline="\n") path.write_text(content, "UTF-8", newline="\n")
_python_files_to_format.append(path)
print(f"✅ Patched {path}") print(f"✅ Patched {path}")
if not lifespan_patched: if not lifespan_patched:
@@ -669,7 +703,7 @@ def patch_app_file(
def patch_vite_config( def patch_vite_config(
path: Path, path: Path,
module_name: str, module_name: str,
dry_run: bool = False, dry: bool = False,
) -> bool: ) -> bool:
"""Patch an existing vite.config.js/ts by adding fastapi-vue plugin. """Patch an existing vite.config.js/ts by adding fastapi-vue plugin.
@@ -731,7 +765,7 @@ def patch_vite_config(
print(f"️ Skipping {path} (no changes needed)") print(f"️ Skipping {path} (no changes needed)")
return False return False
if dry_run: if dry:
print(f"✅ Would patch {path}") print(f"✅ Would patch {path}")
return True return True
@@ -740,7 +774,7 @@ def patch_vite_config(
return True 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. """Patch Vue app to include FastAPI backend health check.
Tries HelloWorld.vue first (full demo), then falls back to App.vue (minimal). Tries HelloWorld.vue first (full demo), then falls back to App.vue (minimal).
@@ -831,7 +865,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
print(f"️ Skipping {target_file} (no changes needed)") print(f"️ Skipping {target_file} (no changes needed)")
return False return False
if dry_run: if dry:
print(f"✅ Would patch {target_file}") print(f"✅ Would patch {target_file}")
return True return True
@@ -842,12 +876,12 @@ def patch_frontend_health_check(frontend_dir: Path, dry_run: bool = False) -> bo
# SHA-256 of old vite-plugin-fastapi.js (before auto-upgrade marker was added) # SHA-256 of old vite-plugin-fastapi.js (before auto-upgrade marker was added)
# with module name replaced by MODULE_NAME in the outDir path # with module name replaced by MODULE_NAME in the outDir path
_OLD_VITE_PLUGIN_SHA256 = "93713e879c15a25c750a70ce1de684adeaf11b0c723c38da56e5e7ba207f6632" _OLD_VITE_PLUGIN_SHA256 = (
"93713e879c15a25c750a70ce1de684adeaf11b0c723c38da56e5e7ba207f6632"
)
def _upgrade_old_vite_plugin( def _upgrade_old_vite_plugin(path: Path, module_name: str, dry: bool = False) -> None:
path: Path, module_name: str, dry_run: bool = False
) -> None:
"""Remove old vite-plugin-fastapi.js that lacks auto-upgrade marker. """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 Old versions didn't have the upgrade marker, so write_file skips them as
@@ -861,11 +895,13 @@ def _upgrade_old_vite_plugin(
return # Already new format, write_file handles it return # Already new format, write_file handles it
import hashlib import hashlib
normalized = content.replace(f"../{module_name}/frontend-build", "../MODULE_NAME/frontend-build") normalized = content.replace(
f"../{module_name}/frontend-build", "../MODULE_NAME/frontend-build"
)
digest = hashlib.sha256(normalized.encode()).hexdigest() digest = hashlib.sha256(normalized.encode()).hexdigest()
if digest != _OLD_VITE_PLUGIN_SHA256: if digest != _OLD_VITE_PLUGIN_SHA256:
return # Modified by user, don't touch return # Modified by user, don't touch
if dry_run: if dry:
print(f"🔄 Would upgrade old {path}") print(f"🔄 Would upgrade old {path}")
return return
path.unlink() path.unlink()
@@ -880,7 +916,7 @@ def write_file(
path: Path, path: Path,
content: str, content: str,
overwrite: bool = True, overwrite: bool = True,
dry_run: bool = False, dry: bool = False,
executable: bool = False, executable: bool = False,
fallback_path: Path | None = None, fallback_path: Path | None = None,
force: bool = False, force: bool = False,
@@ -891,13 +927,20 @@ def write_file(
the content will be written to fallback_path instead of being skipped. the content will be written to fallback_path instead of being skipped.
If force=True, always overwrite without checking for upgrade marker. 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() exists = path.exists()
if exists and not overwrite: if exists and not overwrite:
print(f"⚠️ Skipping {path} (exists)") print(f"⚠️ Skipping {path} (exists)")
return False return False
# Check if content is the same # Check if content is the same (new content already formatted)
if exists: if exists:
existing_content = path.read_text("UTF-8") existing_content = path.read_text("UTF-8")
if existing_content == content: if existing_content == content:
@@ -909,12 +952,12 @@ def write_file(
if fallback_path is not None: if fallback_path is not None:
# Write to fallback path instead # Write to fallback path instead
return _write_fallback_file( return _write_fallback_file(
path, fallback_path, content, dry_run, executable path, fallback_path, content, dry, executable
) )
print(f"️ Skipping {path} (customized by user)") print(f"️ Skipping {path} (customized by user)")
return False return False
if dry_run: if dry:
action = "overwrite" if exists else "create" action = "overwrite" if exists else "create"
print(f"✅ Would {action} {path}") print(f"✅ Would {action} {path}")
return True return True
@@ -923,8 +966,6 @@ def write_file(
path.write_text(content, "UTF-8", newline="\n") path.write_text(content, "UTF-8", newline="\n")
if executable and sys.platform != "win32": if executable and sys.platform != "win32":
path.chmod(path.stat().st_mode | 0o111) path.chmod(path.stat().st_mode | 0o111)
if path.suffix == ".py":
_python_files_to_format.append(path)
action = "Updated" if exists else "Created" action = "Updated" if exists else "Created"
print(f"{action} {path}") print(f"{action} {path}")
return True return True
@@ -934,17 +975,21 @@ def _write_fallback_file(
original_path: Path, original_path: Path,
fallback_path: Path, fallback_path: Path,
content: str, content: str,
dry_run: bool, dry: bool,
executable: bool, executable: bool,
) -> bool: ) -> bool:
"""Write content to a fallback .new.py file when original can't be overwritten.""" """Write content to a fallback .new.py file when original can't be overwritten.
# Check if fallback already has same content
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.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)") print(f"✔️ {fallback_path} (already up to date)")
return False return False
if dry_run: if dry:
print(f"✅ Would create {fallback_path} (original customized by user)") print(f"✅ Would create {fallback_path} (original customized by user)")
_new_files_written.append((fallback_path, original_path)) _new_files_written.append((fallback_path, original_path))
return True return True
@@ -953,8 +998,6 @@ def _write_fallback_file(
fallback_path.write_text(content, "UTF-8", newline="\n") fallback_path.write_text(content, "UTF-8", newline="\n")
if executable and sys.platform != "win32": if executable and sys.platform != "win32":
fallback_path.chmod(fallback_path.stat().st_mode | 0o111) 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)") print(f"✅ Created {fallback_path} (original customized by user)")
_new_files_written.append((fallback_path, original_path)) _new_files_written.append((fallback_path, original_path))
return True return True
@@ -1081,13 +1124,13 @@ def find_js_runtime() -> tuple[str, str] | None:
return 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.""" """Ensure pyproject.toml exists, run uv init if needed."""
pyproject = project_dir / "pyproject.toml" pyproject = project_dir / "pyproject.toml"
if pyproject.exists(): if pyproject.exists():
return True return True
if dry_run: if dry:
print(f"📦 Would run: uv init {project_dir}") print(f"📦 Would run: uv init {project_dir}")
return True return True
@@ -1107,7 +1150,7 @@ def ensure_python_project(project_dir: Path, dry_run: bool = False) -> bool:
return True 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.""" """Ensure frontend directory exists with a Vue project, run create-vue if needed."""
frontend_dir = project_dir / "frontend" frontend_dir = project_dir / "frontend"
package_json = frontend_dir / "package.json" package_json = frontend_dir / "package.json"
@@ -1131,7 +1174,7 @@ def ensure_frontend(project_dir: Path, dry_run: bool = False) -> bool:
} }
create_cmd = create_vue_commands[js_name] create_cmd = create_vue_commands[js_name]
if dry_run: if dry:
print(f"🎨 Would run: {' '.join(create_cmd)}") print(f"🎨 Would run: {' '.join(create_cmd)}")
return True return True
@@ -1171,11 +1214,15 @@ def cmd_setup(args: argparse.Namespace) -> int:
project_dir = Path.cwd() / project_path project_dir = Path.cwd() / project_path
project_dir = project_dir.resolve() 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 # Create project directory if it doesn't exist
if not project_dir.exists(): if not project_dir.exists():
if dry_run: if dry:
print(f"✅ Would create directory: {project_dir}") print(f"✅ Would create directory: {project_dir}")
else: else:
project_dir.mkdir(parents=True) project_dir.mkdir(parents=True)
@@ -1183,15 +1230,12 @@ def cmd_setup(args: argparse.Namespace) -> int:
print(f"🔧 Setting up project: {project_dir}") 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) # 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 return 1
# Step 2: Ensure Python project exists # 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 return 1
# Detect module name # Detect module name
@@ -1257,7 +1301,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
tpl_vars["APP_MODULE"] = "app" tpl_vars["APP_MODULE"] = "app"
# Create directories # Create directories
if not dry_run: if not dry:
if not module_dir.exists(): if not module_dir.exists():
module_dir.mkdir(parents=True) module_dir.mkdir(parents=True)
fastapi_vue_scripts.mkdir(parents=True, exist_ok=True) fastapi_vue_scripts.mkdir(parents=True, exist_ok=True)
@@ -1269,7 +1313,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Remove obsolete util.py if present # Remove obsolete util.py if present
obsolete_util = fastapi_vue_scripts / "util.py" obsolete_util = fastapi_vue_scripts / "util.py"
if obsolete_util.exists(): if obsolete_util.exists():
if dry_run: if dry:
print(f"🗑️ Would remove obsolete {obsolete_util}") print(f"🗑️ Would remove obsolete {obsolete_util}")
else: else:
obsolete_util.unlink() obsolete_util.unlink()
@@ -1286,7 +1330,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
dest_path, dest_path,
content, content,
overwrite=True, overwrite=True,
dry_run=dry_run, dry=dry,
force=True, # Internal files, always overwrite force=True, # Internal files, always overwrite
) )
@@ -1299,7 +1343,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
devserver_path, devserver_path,
content, content,
overwrite=True, overwrite=True,
dry_run=dry_run, dry=dry,
executable=True, executable=True,
fallback_path=devserver_fallback, fallback_path=devserver_fallback,
) )
@@ -1307,7 +1351,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
# === Handle app module === # === Handle app module ===
if app_file: if app_file:
# Existing app: patch with import, route, and try to patch lifespan # 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, module_name, app_var, dry=dry)
else: else:
# No app: create full app.py # No app: create full app.py
# Create __init__.py if missing # Create __init__.py if missing
@@ -1315,13 +1359,13 @@ def cmd_setup(args: argparse.Namespace) -> int:
if not init_file.exists(): if not init_file.exists():
template = load_template("backend/__init__.py") template = load_template("backend/__init__.py")
content = render_template(template, **tpl_vars) 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 # Create app.py
app_file_path = module_dir / "app.py" app_file_path = module_dir / "app.py"
template = load_template("backend/app.py") template = load_template("backend/app.py")
content = render_template(template, **tpl_vars) 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 === # === Handle __main__.py ===
main_file = module_dir / "__main__.py" main_file = module_dir / "__main__.py"
@@ -1338,7 +1382,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
main_file, main_file,
main_content, main_content,
overwrite=True, overwrite=True,
dry_run=dry_run, dry=dry,
fallback_path=main_fallback, fallback_path=main_fallback,
) )
elif not existing_cli: elif not existing_cli:
@@ -1347,7 +1391,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
main_file, main_file,
main_content, main_content,
overwrite=False, overwrite=False,
dry_run=dry_run, dry=dry,
) )
else: else:
# No file but has existing entrypoint - don't create (user has custom CLI setup) # No file but has existing entrypoint - don't create (user has custom CLI setup)
@@ -1359,25 +1403,25 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Install the vite plugin file (always update) # Install the vite plugin file (always update)
plugin_file = frontend_dir / "vite-plugin-fastapi.js" plugin_file = frontend_dir / "vite-plugin-fastapi.js"
# Upgrade old plugin versions that lack the auto-upgrade marker # 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") template = load_template("frontend/vite-plugin-fastapi.js")
content = render_template(template, **tpl_vars) 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) # Find existing vite config (prefer .ts, fall back to .js)
vite_config_ts = frontend_dir / "vite.config.ts" vite_config_ts = frontend_dir / "vite.config.ts"
vite_config_js = frontend_dir / "vite.config.js" vite_config_js = frontend_dir / "vite.config.js"
if vite_config_ts.exists(): 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(): 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: else:
print("⚠️ No vite.config.ts or vite.config.js found in frontend/") print("⚠️ No vite.config.ts or vite.config.js found in frontend/")
print(" Run create-vue first to generate a Vite config to patch.") print(" Run create-vue first to generate a Vite config to patch.")
# Patch Vue app with backend health check # 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 === # === Update pyproject.toml ===
pyproject_path = project_dir / "pyproject.toml" pyproject_path = project_dir / "pyproject.toml"
@@ -1398,7 +1442,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
if new_content == old_content: if new_content == old_content:
print(f"✔️ {pyproject_path} (already up to date)") print(f"✔️ {pyproject_path} (already up to date)")
elif dry_run: elif dry:
print(f"✅ Would update {pyproject_path}") print(f"✅ Would update {pyproject_path}")
else: else:
pyproject_path.write_text(new_content, "UTF-8", newline="\n") pyproject_path.write_text(new_content, "UTF-8", newline="\n")
@@ -1411,7 +1455,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
gitignore_content = gitignore_path.read_bytes() gitignore_content = gitignore_path.read_bytes()
if b"frontend-build" in gitignore_content: if b"frontend-build" in gitignore_content:
print("✔️ .gitignore (frontend-build already ignored)") print("✔️ .gitignore (frontend-build already ignored)")
elif dry_run: elif dry:
print(f"✅ Would add {gitignore_entry} to .gitignore") print(f"✅ Would add {gitignore_entry} to .gitignore")
else: else:
nl = b"\r\n" if b"\r\n" in gitignore_content else b"\n" nl = b"\r\n" if b"\r\n" in gitignore_content else b"\n"
@@ -1420,15 +1464,14 @@ def cmd_setup(args: argparse.Namespace) -> int:
gitignore_content + suffix + gitignore_entry.encode() + nl gitignore_content + suffix + gitignore_entry.encode() + nl
) )
print(f"✅ Added {gitignore_entry} to .gitignore") print(f"✅ Added {gitignore_entry} to .gitignore")
elif dry_run: elif dry:
print(f"✅ Would create .gitignore with {gitignore_entry}") print(f"✅ Would create .gitignore with {gitignore_entry}")
else: else:
gitignore_path.write_text(f"{gitignore_entry}\n", "UTF-8", newline="\n") gitignore_path.write_text(f"{gitignore_entry}\n", "UTF-8", newline="\n")
print("✅ Created .gitignore") print("✅ Created .gitignore")
# === Add dependencies using uv === # === Add dependencies using uv ===
ruff_sort_imports(_python_files_to_format, dry_run=dry_run) if dry:
if dry_run:
print("📦 Would add: fastapi[standard], fastapi-vue, httpx (dev only)") print("📦 Would add: fastapi[standard], fastapi-vue, httpx (dev only)")
else: else:
print("📦 Dependencies") print("📦 Dependencies")
@@ -1436,12 +1479,10 @@ def cmd_setup(args: argparse.Namespace) -> int:
uv_add_packages(["httpx"], cwd=project_dir, group="dev") uv_add_packages(["httpx"], cwd=project_dir, group="dev")
print() print()
print("=" * 60) print_boxed("Setup complete!")
print("✅ Setup complete!")
print("=" * 60)
# Show cd command only if project is not in current directory # 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("_", "-") script_name = module_name.replace("_", "-")
message = SETUP_COMPLETE_MESSAGE.replace("CD_CMD", cd_cmd).replace( message = SETUP_COMPLETE_MESSAGE.replace("CD_CMD", cd_cmd).replace(
@@ -1465,11 +1506,6 @@ def cmd_setup(args: argparse.Namespace) -> int:
return 0 return 0
# =============================================================================
# Main entry point
# =============================================================================
def is_uninitialized_folder(path: Path) -> bool: def is_uninitialized_folder(path: Path) -> bool:
"""Check if a folder appears to be completely uninitialized.""" """Check if a folder appears to be completely uninitialized."""
return ( return (
@@ -1492,14 +1528,14 @@ def is_already_patched(path: Path) -> bool:
def main() -> int: def main() -> int:
parser = argparse.ArgumentParser( 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, formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=""" epilog="""
Examples: Examples:
fastapi-vue-setup my-new-project Create a new project from scratch fastapi-vue-setup my-new-project Create a new project from scratch
fastapi-vue-setup . Set up integration in current directory fastapi-vue-setup . Set up integration in current directory
fastapi-vue-setup . --dry-run Preview what would be done fastapi-vue-setup . --dry Preview what would be done
fastapi-vue-setup . --ports 8000,5173,8080 Custom ports (default,vite,dev) fastapi-vue-setup . --ports=8000,5173,8080 Change default ports (backend, vite dev, backend dev)
""", """,
) )
parser.add_argument( parser.add_argument(
@@ -1508,14 +1544,15 @@ Examples:
default=None, default=None,
help="Project directory (use . for current directory)", 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("--module-name", help="Python module name (auto-detected)")
parser.add_argument( parser.add_argument(
"--ports", "--ports",
metavar="DEFAULT,VITE,DEV", metavar="BACKEND,VITE,DEV",
help="Port configuration as comma-separated values (default: 3100,3100,3200)", help="Port configuration as comma-separated values (default: 3100,3100,3200)",
) )
parser.add_argument( parser.add_argument(
"--dry-run", action="store_true", help="Show what would be done" "--dry", "--dry-run", action="store_true", help="Show what would be done"
) )
args = parser.parse_args() args = parser.parse_args()
+3 -2
View File
@@ -5,7 +5,7 @@ import os
from fastapi_vue import server from fastapi_vue import server
DEFAULT_PORT = TEMPLATE_DEFAULT_PORT DEFAULT_PORT = TEMPLATE_DEFAULT_PORT
DEVMODE = bool(os.getenv("ENVPREFIX_FRONTEND_URL")) DEVMODE = os.getenv("ENVPREFIX_DEV") == "1"
def main(): def main():
@@ -17,11 +17,12 @@ def main():
help=(f"Endpoint (default: localhost:{DEFAULT_PORT})."), help=(f"Endpoint (default: localhost:{DEFAULT_PORT})."),
) )
args = parser.parse_args() args = parser.parse_args()
dev = {"reload": True, "reload_dirs": ["MODULE_NAME"]}
server.run( server.run(
"MODULE_NAME.APP_MODULE:APP_VAR", "MODULE_NAME.APP_MODULE:APP_VAR",
listen=args.listen, listen=args.listen,
default_port=DEFAULT_PORT, default_port=DEFAULT_PORT,
reload=DEVMODE, **(dev if DEVMODE else {}),
) )
+1 -1
View File
@@ -11,7 +11,7 @@
*/ */
export default function fastapiVue({ paths = ["/api"] } = {}) { 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 // Build proxy configuration for each path
const proxy = {} const proxy = {}
+11 -10
View File
@@ -1,6 +1,6 @@
#!/usr/bin/env -S uv run #!/usr/bin/env -S uv run
# auto-upgrade@fastapi-vue-setup - remove this if you modify this file # 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 argparse
import asyncio import asyncio
@@ -25,7 +25,7 @@ DEFAULT_DEV_PORT = TEMPLATE_DEV_PORT
async def run_devserver( 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: ) -> None:
reporoot = Path(__file__).parent.parent reporoot = Path(__file__).parent.parent
front = reporoot / "frontend" front = reporoot / "frontend"
@@ -33,12 +33,13 @@ async def run_devserver(
logger.warning("Frontend source not found at %s", front) logger.warning("Frontend source not found at %s", front)
raise SystemExit(1) 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) backurl, MODULE_NAME = setup_cli("PROJECT_CLI", backend, DEFAULT_DEV_PORT)
# Tell the everyone where the frontend and backend are (vite proxy, etc) # Tell the everyone by environment (vite proxy and backend devmode use these)
os.environ["ENVPREFIX_FRONTEND_URL"] = viteurl os.environ["ENVPREFIX_VITE_URL"] = viteurl
os.environ["ENVPREFIX_BACKEND_URL"] = backurl os.environ["ENVPREFIX_BACKEND_URL"] = backurl
os.environ["ENVPREFIX_DEV"] = "1"
async with ProcessGroup() as pg: async with ProcessGroup() as pg:
npm_i = await pg.spawn(*npm_install, cwd=front) npm_i = await pg.spawn(*npm_install, cwd=front)
@@ -55,19 +56,19 @@ def main():
epilog=HELP_EPILOG, epilog=HELP_EPILOG,
) )
parser.add_argument( parser.add_argument(
"frontend", "-l",
nargs="?", "--listen",
metavar="host:port", metavar="host:port",
help=f"Vite frontend endpoint (default: localhost:{DEFAULT_VITE_PORT})", help=f"Vite (default: localhost:{DEFAULT_VITE_PORT})",
) )
parser.add_argument( parser.add_argument(
"--backend", "--backend",
metavar="host:port", metavar="host:port",
help=f"FastAPI backend endpoint (default: localhost:{DEFAULT_DEV_PORT})", help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})",
) )
args, extra_args = parser.parse_known_args() args, extra_args = parser.parse_known_args()
with suppress(KeyboardInterrupt): 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 = """ HELP_EPILOG = """
+1 -6
View File
@@ -207,10 +207,5 @@ def setup_cli(
host = endpoints[0]["host"] host = endpoints[0]["host"]
port = endpoints[0]["port"] port = endpoints[0]["port"]
cmd = [ cmd = [cli, f"--listen={host}:{port}"]
sys.executable,
"-m",
cli,
f"--listen={host}:{port}",
]
return f"http://{host}:{port}", cmd return f"http://{host}:{port}", cmd