fastapi-voyager 0.16.0a3__py3-none-any.whl → 0.16.1__py3-none-any.whl

fastapi_voyager/version.py

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

{fastapi_voyager-0.16.0a3.dist-info → fastapi_voyager-0.16.1.dist-info}/METADATA

@@ -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.dist-info → fastapi_voyager-0.16.1.dist-info}/RECORD

@@ -9,7 +9,7 @@ fastapi_voyager/render_style.py,sha256=1y3aRhBSJSWU-JuSgjn9il_xFEqjv6mJCoUzImLQT
 fastapi_voyager/server.py,sha256=qHCN5EqoFwqvIGsMX-ALiogUc4x0xWLpVFpgO06KZvA,7035
 fastapi_voyager/type.py,sha256=zluWvh5vpnjXJ9aAmyNJTSmXZPjAHCvgRT5oQRAjHrg,2104
 fastapi_voyager/type_helper.py,sha256=5HYUHdghTISZ44NvVsrMWlRGD5C9-xrGeNKuLYDMA6s,10209
-fastapi_voyager/version.py,sha256=zh4QycBWD2nGHz_cZwy5vHQ1KDWxkhAdF_-JPiTVFzU,56
+fastapi_voyager/version.py,sha256=KQqsioyKo8ILOoP_53tP9pUeioVRilkmAOxElLW67O4,49
 fastapi_voyager/voyager.py,sha256=S0cCMLFv_wPfEMVdp4cYqbc-Y207SjCTSmsYdqzIDHg,15307
 fastapi_voyager/adapters/__init__.py,sha256=a95rBvV4QVcX_yAzjuJQKOW-EbJ79R--YjUJ3BGkC3k,517
 fastapi_voyager/adapters/base.py,sha256=mTYCnYYR4VtA7a-cTJmhsT_Up0hgxLC0hBzUbYxQCJQ,1039
@@ -55,8 +55,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=GRozZ5suTykYcPMap1QhjrAB8PLW0mbT_phhzw_utvQ,316
-fastapi_voyager-0.16.0a3.dist-info/METADATA,sha256=v39CCqmxr4ls6J4m9--3R1vPTTBFnAkEBX0BHY9Tgyo,13811
-fastapi_voyager-0.16.0a3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-fastapi_voyager-0.16.0a3.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.16.0a3.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.16.0a3.dist-info/RECORD,,
+fastapi_voyager-0.16.1.dist-info/METADATA,sha256=g9vjbDlp4LoZjeWk_Od6CliTYNJV1XCzHaAElEEit4s,14364
+fastapi_voyager-0.16.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+fastapi_voyager-0.16.1.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.16.1.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.16.1.dist-info/RECORD,,