routelit-fastapi 0.1.0

A FastAPI adapter for the RouteLit framework, enabling seamless integration of RouteLit's reactive UI components with FastAPI web applications

RouteLit FastAPI Adapter

A FastAPI adapter for the RouteLit framework, enabling seamless integration of RouteLit's reactive UI components with FastAPI web applications.

Installation

pip install routelit routelit-fastapi

Usage

from fastapi import FastAPI, Request
from routelit import RouteLit, RouteLitBuilder
from routelit_fastapi import RouteLitFastAPIAdapter

app = FastAPI()
routelit = RouteLit()
routelit_adapter = RouteLitFastAPIAdapter(routelit).configure(app)


def build_index_view(rl: RouteLitBuilder):
    rl.text("Hello, World!")


# Option 1: Traditional approach with explicit route registration
@app.api_route("/", methods=["GET", "POST"])
async def index(request: Request):
    return await routelit_adapter.response(build_index_view, request)


# Option 2: Simplified decorator approach
@routelit_adapter.route("/")
def index_view(rl: RouteLitBuilder):
    rl.text("Hello, World!")

Quick Start

Here's a complete example:

from fastapi import FastAPI, Request
import uvicorn
from routelit import RouteLit, RouteLitBuilder
from routelit_fastapi import RouteLitFastAPIAdapter

# Create FastAPI app
app = FastAPI()

# Create RouteLit instance
routelit = RouteLit()

# Create and configure the adapter
adapter = RouteLitFastAPIAdapter(routelit).configure(app)

# Define your view function
def build_hello_view(rl: RouteLitBuilder):
    name = rl.text_input(label="What is your name", placeholder="John", default_value="")
    rl.write(f"Hello {name}")
    if rl.button("Submit"):
        rl.write("Thanks for your submission!")

# Option 1: Traditional approach
@app.api_route("/", methods=["GET", "POST"])
async def hello(request: Request):
    return await adapter.response(build_hello_view, request)


# Option 2: Simplified decorator approach (recommended)
@adapter.route("/")
def hello_view(rl: RouteLitBuilder):
    name = rl.text_input(label="What is your name", placeholder="John", default_value="")
    rl.write(f"Hello {name}")
    if rl.button("Submit"):
        rl.write("Thanks for your submission!")

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

Development Mode

For development with hot reloading of the frontend:

adapter = RouteLitFastAPIAdapter(
    routelit,
    run_mode="dev_client",
    local_frontend_server="http://localhost:5173"
).configure(app)

Streaming Support

For HTTP streaming responses (using JSONL streaming):

# Option 1: Traditional approach
@app.api_route("/stream", methods=["GET", "POST"])
async def stream_endpoint(request: Request):
    return await adapter.stream_response(build_view, request)


# Option 2: Simplified decorator approach (recommended)
@adapter.stream_route("/stream")
async def stream_view(rl: RouteLitBuilder):
    for i in range(10):
        rl.text(f"Count: {i}")

Configuration Options

• static_path: Custom path for static assets
• template_path: Custom path for templates
• run_mode: One of "prod", "dev_client", "dev_components"
• local_frontend_server: URL of local Vite dev server (for dev mode)
• local_components_server: URL of local components dev server (for dev mode)
• cookie_config: Custom cookie configuration

Maintained by @rolangom.

---

Repository initiated with fpgmaas/cookiecutter-uv.