Enable Burr UI to be added to existing FastAPI app

burr/tracking/server/run.py

@@ -140,7 +140,17 @@ async def lifespan(app: FastAPI):
     await backend.lifespan(app).__anext__()
 
 
-app = FastAPI(lifespan=lifespan)
+def create_burr_ui_app() -> FastAPI:
+    return FastAPI(lifespan=lifespan)
+
+app = create_burr_ui_app()
+
+def mount_burr_ui(parent_app: FastAPI, path: str = "/burr") -> None:
+    """
+    Mount the Burr UI inside another FastAPI app.
+    """
+    ui_app = create_burr_ui_app()
+    parent_app.mount(path, ui_app, name="burr-ui")
 
 
 @app.get("/ready")

docs/concepts/tracking.rst

@@ -131,3 +131,25 @@ This will print the URL to access the Burr UI web app.
     from google.colab import output
     output.serve_kernel_port_as_window(7241) # this will open a new window
     output.serve_kernel_port_as_iframe(7241) # this will inline in an iframe
+
+---------------------------------------------
+Mount Burr UI inside an existing FastAPI app
+---------------------------------------------
+
+You can embed the Burr UI inside an existing FastAPI application using the
+``mount_burr_ui`` helper.
+
+Example:
+
+.. code-block:: python
+
+    from fastapi import FastAPI
+    from burr.tracking.server.run import mount_burr_ui
+
+    app = FastAPI()
+
+    # Mount Burr UI under /burr
+    mount_burr_ui(app, path="/burr")
+
+This allows you to run the Burr tracking UI alongside your own FastAPI
+application in the same server process.

examples/fastapi_mount_example.py

@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0.
+
+from fastapi import FastAPI
+import uvicorn
+
+from burr.tracking.server.run import mount_burr_ui
+
+app = FastAPI()
+
+# Mount Burr UI
+mount_burr_ui(app, path="/burr")
+
+
+@app.get("/")
+def root():
+    return {"message": "Main FastAPI app with Burr UI mounted"}
+
+
+if __name__ == "__main__":
+    uvicorn.run(app, host="0.0.0.0", port=8000)