fastapi-voyager 0.16.0a3__tar.gz → 0.16.1__tar.gz

{fastapi_voyager-0.16.0a3 → fastapi_voyager-0.16.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.16.0a3
+Version: 0.16.1
 Summary: Visualize FastAPI application's routing tree and dependencies
 Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
 Project-URL: Source, https://github.com/allmonday/fastapi-voyager
@@ -205,34 +205,44 @@ uvicorn your_app:application --reload
 
 ### Litestar
 
+Litestar doesn't support mounting to an existing app like FastAPI. The recommended pattern is to export `ROUTE_HANDLERS` from your main app:
+
 ```python
-from litestar import Litestar, get
-from fastapi_voyager import create_voyager
+# In your main app file (e.g., app.py)
+from litestar import Litestar, Controller
 
-# Create Litestar app
-app = Litestar()
+class MyController(Controller):
+    # ... your routes ...
 
-@get("/hello")
-def hello() -> dict:
-    return {"message": "Hello World"}
+ROUTE_HANDLERS = [MyController]  # Export for extension
+app = Litestar(route_handlers=ROUTE_HANDLERS)
+```
 
-# Create voyager app (returns a Litestar app)
-voyager_app = create_voyager(app)
+Then create voyager by reusing `ROUTE_HANDLERS`:
 
-# Create ASGI application that routes between main app and voyager
-async def asgi_app(scope, receive, send):
-    if scope["type"] == "http" and scope["path"].startswith("/voyager"):
-        # Remove /voyager prefix for voyager app
-        new_scope = dict(scope)
-        new_scope["path"] = scope["path"][8:] or "/"
-        await voyager_app(new_scope, receive, send)
-    else:
-        await app(scope, receive, send)
+```python
+# In your voyager embedding file
+from typing import Any, Awaitable, Callable
+from litestar import Litestar, asgi
+from fastapi_voyager import create_voyager
+from your_app import ROUTE_HANDLERS, app as your_app
+
+voyager_app = create_voyager(your_app)
+
+@asgi("/voyager", is_mount=True, copy_scope=True)
+async def voyager_mount(
+    scope: dict[str, Any],
+    receive: Callable[[], Awaitable[dict[str, Any]]],
+    send: Callable[[dict[str, Any]], Awaitable[None]]
+) -> None:
+    await voyager_app(scope, receive, send)
+
+app = Litestar(route_handlers=ROUTE_HANDLERS + [voyager_mount])
 ```
 
 Start with:
 ```bash
-uvicorn your_app:asgi_app --reload
+uvicorn your_app:app --reload
 # Visit http://localhost:8000/voyager
 ```
 
@@ -335,6 +345,8 @@ voyager -m tests.demo --server --port=8002
 voyager -m tests.demo --server --app my_app
 ```
 
+> **Note**: Server mode does not support ER diagram or pydantic-resolve metadata configuration. Use `create_voyager()` in your code with `er_diagram` and `enable_pydantic_resolve_meta` parameters to enable these features.
+
 ### Generate DOT File
 
 ```bash

{fastapi_voyager-0.16.0a3 → fastapi_voyager-0.16.1}/README.md

@@ -154,34 +154,44 @@ uvicorn your_app:application --reload
 
 ### Litestar
 
+Litestar doesn't support mounting to an existing app like FastAPI. The recommended pattern is to export `ROUTE_HANDLERS` from your main app:
+
 ```python
-from litestar import Litestar, get
-from fastapi_voyager import create_voyager
+# In your main app file (e.g., app.py)
+from litestar import Litestar, Controller
 
-# Create Litestar app
-app = Litestar()
+class MyController(Controller):
+    # ... your routes ...
 
-@get("/hello")
-def hello() -> dict:
-    return {"message": "Hello World"}
+ROUTE_HANDLERS = [MyController]  # Export for extension
+app = Litestar(route_handlers=ROUTE_HANDLERS)
+```
 
-# Create voyager app (returns a Litestar app)
-voyager_app = create_voyager(app)
+Then create voyager by reusing `ROUTE_HANDLERS`:
 
-# Create ASGI application that routes between main app and voyager
-async def asgi_app(scope, receive, send):
-    if scope["type"] == "http" and scope["path"].startswith("/voyager"):
-        # Remove /voyager prefix for voyager app
-        new_scope = dict(scope)
-        new_scope["path"] = scope["path"][8:] or "/"
-        await voyager_app(new_scope, receive, send)
-    else:
-        await app(scope, receive, send)
+```python
+# In your voyager embedding file
+from typing import Any, Awaitable, Callable
+from litestar import Litestar, asgi
+from fastapi_voyager import create_voyager
+from your_app import ROUTE_HANDLERS, app as your_app
+
+voyager_app = create_voyager(your_app)
+
+@asgi("/voyager", is_mount=True, copy_scope=True)
+async def voyager_mount(
+    scope: dict[str, Any],
+    receive: Callable[[], Awaitable[dict[str, Any]]],
+    send: Callable[[dict[str, Any]], Awaitable[None]]
+) -> None:
+    await voyager_app(scope, receive, send)
+
+app = Litestar(route_handlers=ROUTE_HANDLERS + [voyager_mount])
 ```
 
 Start with:
 ```bash
-uvicorn your_app:asgi_app --reload
+uvicorn your_app:app --reload
 # Visit http://localhost:8000/voyager
 ```
 
@@ -284,6 +294,8 @@ voyager -m tests.demo --server --port=8002
 voyager -m tests.demo --server --app my_app
 ```
 
+> **Note**: Server mode does not support ER diagram or pydantic-resolve metadata configuration. Use `create_voyager()` in your code with `er_diagram` and `enable_pydantic_resolve_meta` parameters to enable these features.
+
 ### Generate DOT File
 
 ```bash

{fastapi_voyager-0.16.0a3 → fastapi_voyager-0.16.1}/setup-litestar.sh

@@ -39,10 +39,10 @@ echo ""
 
 # Start Litestar server
 echo "🌟 Starting Litestar Voyager server..."
-echo "   App: tests.litestar.embedding:asgi_app"
+echo "   App: tests.litestar.embedding:app"
 echo "   URL: http://127.0.0.1:8000"
 echo ""
 echo "Press Ctrl+C to stop the server"
 echo ""
 
-uv run uvicorn tests.litestar.embedding:asgi_app --reload --host 127.0.0.1 --port 8000
+uv run uvicorn tests.litestar.embedding:app --reload --host 127.0.0.1 --port 8000

fastapi_voyager-0.16.1/src/fastapi_voyager/version.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "0.16.1"

{fastapi_voyager-0.16.0a3 → fastapi_voyager-0.16.1}/tests/litestar/demo.py

@@ -132,7 +132,10 @@ class DemoController(Controller):
         return True
 
 
+# Export route handlers for extension (e.g., adding voyager)
+ROUTE_HANDLERS = [DemoController]
+
 # Create a Litestar app instance - this is the main app that can be run directly
 app = Litestar(
-    route_handlers=[DemoController]
+    route_handlers=ROUTE_HANDLERS
 )

fastapi_voyager-0.16.1/tests/litestar/embedding.py

@@ -0,0 +1,44 @@
+"""
+Litestar embedding example for fastapi-voyager.
+
+This module demonstrates how to integrate voyager with a Litestar application.
+
+Unlike FastAPI, Litestar doesn't support mounting to an existing app after creation.
+The recommended pattern is to reuse the ROUTE_HANDLERS from demo.py.
+"""
+from typing import Any, Awaitable, Callable
+
+from litestar import Litestar, asgi
+
+from fastapi_voyager import create_voyager
+from tests.litestar.demo import ROUTE_HANDLERS, app as demo_app, diagram
+
+# Create voyager app (returns a Litestar app)
+voyager_app = create_voyager(
+    demo_app,
+    er_diagram=diagram,
+    module_color={"tests.service": "purple"},
+    module_prefix="tests.service",
+    swagger_url="/schema/swagger",
+    initial_page_policy='first',
+    ga_id='G-R64S7Q49VL',
+    online_repo_url="https://github.com/allmonday/fastapi-voyager/blob/main",
+    enable_pydantic_resolve_meta=True
+)
+
+# Mount voyager using Litestar's @asgi() decorator
+@asgi("/voyager", is_mount=True, copy_scope=True)
+async def voyager_mount(
+    scope: dict[str, Any],
+    receive: Callable[[], Awaitable[dict[str, Any]]],
+    send: Callable[[dict[str, Any]], Awaitable[None]]
+) -> None:
+    await voyager_app(scope, receive, send)
+
+# Create combined app by reusing ROUTE_HANDLERS from demo.py
+# This is the recommended pattern for Litestar
+app = Litestar(route_handlers=ROUTE_HANDLERS + [voyager_mount])
+
+# Exports
+# - Use `uvicorn tests.litestar.embedding:app --reload` for combined app
+# - Use `uvicorn tests.litestar.embedding:demo_app --reload` for demo only

{fastapi_voyager-0.16.0a3 → fastapi_voyager-0.16.1}/tests/test_embedding_litestar.py

@@ -24,11 +24,11 @@ def event_loop() -> Generator[asyncio.AbstractEventLoop, None, None]:
 @pytest_asyncio.fixture
 async def async_client() -> AsyncGenerator[httpx.AsyncClient, None]:
     """Create an async HTTP client for testing Litestar embedding."""
-    # Import the ASGI application from tests.litestar.embedding
-    from tests.litestar.embedding import asgi_app
+    # Import the combined app from tests.litestar.embedding
+    from tests.litestar.embedding import app
 
     # Use ASGITransport for testing ASGI apps with httpx
-    transport = httpx.ASGITransport(app=asgi_app)
+    transport = httpx.ASGITransport(app=app)
     async with httpx.AsyncClient(transport=transport, base_url="http://test") as client:
         yield client
 

fastapi_voyager-0.16.0a3/src/fastapi_voyager/version.py

@@ -1,2 +0,0 @@
-__all__ = ["__version__"]
-__version__ = "0.16.0alpha-3"

fastapi_voyager-0.16.0a3/tests/litestar/embedding.py

@@ -1,53 +0,0 @@
-"""
-Litestar embedding example for fastapi-voyager.
-
-This module demonstrates how to integrate voyager with a Litestar application.
-"""
-from fastapi_voyager import create_voyager
-from tests.litestar.demo import app, diagram
-
-# Create voyager app for visualization
-# Note: create_voyager automatically detects Litestar and returns a Litestar app
-voyager_app = create_voyager(
-    app,
-    er_diagram=diagram,
-    module_color={"tests.service": "purple"},
-    module_prefix="tests.service",
-    swagger_url="/schema/swagger",
-    initial_page_policy='first',
-    ga_id='G-R64S7Q49VL',
-    online_repo_url="https://github.com/allmonday/fastapi-voyager/blob/main",
-    enable_pydantic_resolve_meta=True
-)
-
-# ASGI app that routes between main app and voyager
-# This allows voyager to be accessed at /voyager while the main app handles other routes
-async def asgi_app(scope, receive, send):
-    """
-    ASGI app that routes between main app and voyager.
-
-    Usage:
-        uvicorn tests.litestar.embedding:asgi_app --reload
-
-    Then access:
-        - http://localhost:8000/demo/* for the main app
-        - http://localhost:8000/voyager for voyager UI
-    """
-    if scope["type"] == "http" and scope["path"].startswith("/voyager"):
-        # Forward to voyager app
-        # Remove /voyager prefix for the voyager app (it expects root path)
-        new_scope = dict(scope)
-        new_scope["path"] = scope["path"][8:]  # Remove '/voyager'
-        if new_scope["path"] == "":
-            new_scope["path"] = "/"
-        if "raw_path" in new_scope:
-            new_scope["raw_path"] = scope["raw_path"][8:]
-        await voyager_app(new_scope, receive, send)
-    else:
-        # Forward to main app
-        await app(scope, receive, send)
-
-# Exports
-# - Use `uvicorn tests.litestar.embedding:asgi_app --reload` for combined app (main + voyager at /voyager)
-# - Use `uvicorn tests.litestar.embedding:app --reload` for main app only
-# - Use `uvicorn tests.litestar.embedding:voyager_app --reload` for voyager only