fastapi-voyager 0.15.5__py3-none-any.whl → 0.16.0a1__py3-none-any.whl

fastapi_voyager/web/vue-main.js

@@ -291,6 +291,10 @@ const app = createApp({
     onMounted(async () => {
       document.body.classList.remove("app-loading")
       await loadInitial()
+      // Update document title after framework_name is loaded
+      if (store.state.framework_name) {
+        document.title = `${store.state.framework_name} Voyager`
+      }
       // Reveal app content only after initial JS/data is ready
     })
 

{fastapi_voyager-0.15.5.dist-info → fastapi_voyager-0.16.0a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.15.5
+Version: 0.16.0a1
 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
@@ -18,11 +18,15 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
-Requires-Dist: fastapi>=0.110
 Requires-Dist: jinja2>=3.0.0
 Requires-Dist: pydantic-resolve>=2.4.3
 Provides-Extra: dev
+Requires-Dist: django-ninja; extra == 'dev'
+Requires-Dist: fastapi>=0.110; extra == 'dev'
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: litestar; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Requires-Dist: uvicorn; extra == 'dev'
 Description-Content-Type: text/markdown
@@ -34,10 +38,12 @@ Description-Content-Type: text/markdown
 
 # FastAPI Voyager
 
-Visualize your FastAPI endpoints and explore them interactively.
+Visualize your API endpoints and explore them interactively.
 
 Its vision is to make code easier to read and understand, serving as an ideal documentation tool.
 
+**Now supports multiple frameworks:** FastAPI, Django Ninja, and Litestar.
+
 > This repo is still in early stage, it supports Pydantic v2 only.
 
 - **Live Demo**: https://www.newsyeah.fun/voyager/
@@ -49,6 +55,7 @@ Its vision is to make code easier to read and understand, serving as an ideal do
 
 - [Quick Start](#quick-start)
 - [Installation](#installation)
+- [Supported Frameworks](#supported-frameworks)
 - [Features](#features)
 - [Command Line Usage](#command-line-usage)
 - [About pydantic-resolve](#about-pydantic-resolve)
@@ -58,7 +65,7 @@ Its vision is to make code easier to read and understand, serving as an ideal do
 
 ## Quick Start
 
-With simple configuration, fastapi-voyager can be embedded into FastAPI:
+With simple configuration, fastapi-voyager can be embedded into your web application:
 
 ```python
 from fastapi import FastAPI
@@ -66,6 +73,8 @@ from fastapi_voyager import create_voyager
 
 app = FastAPI()
 
+# ... define your routes ...
+
 app.mount('/voyager',
           create_voyager(
             app,
@@ -74,12 +83,14 @@ app.mount('/voyager',
             swagger_url="/docs",
             ga_id="G-XXXXXXXXVL",
             initial_page_policy='first',
-            online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master',
+            online_repo_url='https://github.com/your-org/your-repo/blob/master',
             enable_pydantic_resolve_meta=True))
 ```
 
 Visit `http://localhost:8000/voyager` to explore your API visually.
 
+For framework-specific examples (Django Ninja, Litestar), see [Supported Frameworks](#supported-frameworks).
+
 [View full example](https://github.com/allmonday/composition-oriented-development-pattern/blob/master/src/main.py#L48)
 
 ## Installation
@@ -110,9 +121,106 @@ voyager -m path.to.your.app.module --server --app api
 
 > **Note**: [Sub-Application mounts](https://fastapi.tiangolo.com/advanced/sub-applications/) are not supported yet, but you can specify the name of the FastAPI application with `--app`. Only a single application (default: `app`) can be selected.
 
+## Supported Frameworks
+
+fastapi-voyager automatically detects your framework and provides the appropriate integration. Currently supported frameworks:
+
+### FastAPI
+
+```python
+from fastapi import FastAPI
+from fastapi_voyager import create_voyager
+
+app = FastAPI()
+
+@app.get("/hello")
+def hello():
+    return {"message": "Hello World"}
+
+# Mount voyager
+app.mount("/voyager", create_voyager(app))
+```
+
+Start with:
+```bash
+uvicorn your_app:app --reload
+# Visit http://localhost:8000/voyager
+```
+
+### Django Ninja
+
+```python
+import os
+import django
+from django.core.asgi import get_asgi_application
+from ninja import NinjaAPI
+from fastapi_voyager import create_voyager
+
+# Configure Django
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myapp.settings")
+django.setup()
+
+# Create Django Ninja API
+api = NinjaAPI()
+
+@api.get("/hello")
+def hello(request):
+    return {"message": "Hello World"}
+
+# Create voyager ASGI app
+voyager_app = create_voyager(api)
+
+# Create ASGI application that routes between Django and voyager
+async def application(scope, receive, send):
+    if scope["type"] == "http" and scope["path"].startswith("/voyager"):
+        await voyager_app(scope, receive, send)
+    else:
+        django_app = get_asgi_application()
+        await django_app(scope, receive, send)
+```
+
+Start with:
+```bash
+uvicorn your_app:application --reload
+# Visit http://localhost:8000/voyager
+```
+
+### Litestar
+
+```python
+from litestar import Litestar, get
+from fastapi_voyager import create_voyager
+
+# Create Litestar app
+app = Litestar()
+
+@get("/hello")
+def hello() -> dict:
+    return {"message": "Hello World"}
+
+# Create voyager app (returns a Litestar app)
+voyager_app = create_voyager(app)
+
+# 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)
+```
+
+Start with:
+```bash
+uvicorn your_app:asgi_app --reload
+# Visit http://localhost:8000/voyager
+```
+
 ## Features
 
-fastapi-voyager is designed for scenarios using FastAPI as internal API integration endpoints. It helps visualize dependencies and serves as an architecture tool to identify implementation issues such as wrong relationships, overfetching, and more.
+fastapi-voyager is designed for scenarios using web frameworks with Pydantic models (FastAPI, Django Ninja, Litestar). It helps visualize dependencies and serves as an architecture tool to identify implementation issues such as wrong relationships, overfetching, and more.
 
 **Best Practice**: When building view models following the ER model pattern, fastapi-voyager can fully realize its potential - quickly identifying which APIs use specific entities and vice versa.
 
@@ -258,6 +366,21 @@ uv pip install ".[dev]"
 uvicorn tests.programatic:app --reload
 ```
 
+### Test Different Frameworks
+
+You can test the framework-specific examples:
+
+```bash
+# FastAPI example
+uvicorn tests.fastapi.embedding:app --reload
+
+# Django Ninja example
+uvicorn tests.django_ninja.embedding:app --reload
+
+# Litestar example
+uvicorn tests.litestar.embedding:asgi_app --reload
+```
+
 Visit `http://localhost:8000/voyager` to see changes.
 
 ### Setup Git Hooks (Optional)
@@ -289,9 +412,12 @@ This will run Prettier automatically before each commit. See [`.githooks/README.
 
 ## Dependencies
 
-- [FastAPI](https://fastapi.tiangolo.com/)
 - [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
 - [Quasar Framework](https://quasar.dev/)
+### Dev dependencies
+- [FastAPI](https://fastapi.tiangolo.com/)
+- [Django Ninja](https://django-ninja.rest-framework.com/)
+- [Litestar](https://litestar.dev/)
 
 ## Credits
 

{fastapi_voyager-0.15.5.dist-info → fastapi_voyager-0.16.0a1.dist-info}/RECORD

@@ -1,16 +1,28 @@
-fastapi_voyager/__init__.py,sha256=kqwzThE1YhmQ_7jPKGlnWvqRGC-hFrRqq_lKhKaleYU,229
+fastapi_voyager/__init__.py,sha256=1IdDy6JUMgQqQo33qUe2znX9YeI7S35pjVrbt0QLOzY,228
 fastapi_voyager/cli.py,sha256=td3yIIigEomhSdDO-Xkh-CgpEwCafwlwnpvxnT9QsBo,10488
-fastapi_voyager/er_diagram.py,sha256=AbaKbcNd3cgCaQBsE0aHzvljTiZza3bmRiGJI3BGhGo,7873
+fastapi_voyager/er_diagram.py,sha256=4Ba5u-T7XmVmk9MltVMe-m-18mUAHMTybTdE-zNZLrU,7860
 fastapi_voyager/filter.py,sha256=AN_HIu8-DtKisIq5mFt7CnqRHtxKewedNGyyaI82hSY,11529
 fastapi_voyager/module.py,sha256=h9YR3BpS-CAcJW9WCdVkF4opqwY32w9T67g9GfdLytk,3425
-fastapi_voyager/pydantic_resolve_util.py,sha256=r4Rq7BtBcFOMV7O2Ab9TwLyRNL1yNDiQlGUVybf-sXs,3524
-fastapi_voyager/render.py,sha256=5tTuvvCCUwFCq3WJGT1rfTSW41mSDoVyJwMyQGrmhiQ,17271
-fastapi_voyager/render_style.py,sha256=mPOuChEl71-3agCbPwkMt2sFmax2AEKDI6dK90eFPRc,2552
-fastapi_voyager/server.py,sha256=E0gGU7D1pBvnV7gFLBUvnkwtiBFbU1PbxEXHHSIA1oA,9115
+fastapi_voyager/pydantic_resolve_util.py,sha256=0UfAp6Yi6FNpsI1bUu89hRVWFy6keBu1KtcZl-6NYso,3526
+fastapi_voyager/render.py,sha256=A1jFDraQFOfnFHguYlsvBbGIDJ527VQH0jZ-xgTjqIk,17270
+fastapi_voyager/render_style.py,sha256=1y3aRhBSJSWU-JuSgjn9il_xFEqjv6mJCoUzImLQT6M,2525
+fastapi_voyager/server.py,sha256=sgUUscbt736VNB6CN2J_6rJ6fpWO4vJFW7oP7FmAjvA,6739
 fastapi_voyager/type.py,sha256=zluWvh5vpnjXJ9aAmyNJTSmXZPjAHCvgRT5oQRAjHrg,2104
-fastapi_voyager/type_helper.py,sha256=FmfrZAI3Z4uDdh3sH_kH7UGoY6yNVPapneSN86qY_wo,10209
-fastapi_voyager/version.py,sha256=7F_t4pHiI_38oJ-3IRvYl5xfn2qV8LfVfFPlM9BacI0,49
-fastapi_voyager/voyager.py,sha256=4vonmL-xt54C5San-DRBq4mjoV8Q96eoWRy68MJ1IJw,14169
+fastapi_voyager/type_helper.py,sha256=5HYUHdghTISZ44NvVsrMWlRGD5C9-xrGeNKuLYDMA6s,10209
+fastapi_voyager/version.py,sha256=0KZ1gUzWpAnbQTYDMdcLc-qEsyVlYlG265SEa7S4Ij4,56
+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=m-E74LlNgYCpj-gqfYsKl2mzWW5iFiaDTjiBri_5cfo,1283
+fastapi_voyager/adapters/common.py,sha256=DXVLsjLn65U3RR7YyKL_ELV74mnINWmZ4hQ6zISdV0E,9684
+fastapi_voyager/adapters/django_ninja_adapter.py,sha256=tl1rMcotAhOwBxT8poG8rTXm1v3wn_cpaoda79NEFxE,11424
+fastapi_voyager/adapters/fastapi_adapter.py,sha256=-VvCXdMRsV_zZzEkplOGK8HjQ9ICoTyapG3ZluQ1Nvk,5870
+fastapi_voyager/adapters/litestar_adapter.py,sha256=-ILD8jIb82_JKV87p4IfV9IXvhUJ6RSic6i_iHapo5w,6812
+fastapi_voyager/introspectors/__init__.py,sha256=HbmoUyM-BSwd4Rg2ptd9u-qvZSD3UykKyHYVoRg03OM,917
+fastapi_voyager/introspectors/base.py,sha256=hMfka9gVXr-E8MA1rKSSmYk0OppqgiFPWavfgAkPmQI,2131
+fastapi_voyager/introspectors/detector.py,sha256=rmlpQARJMrFXPty6OUdjmFRTtBYErGDH4l7Tivnu_FQ,3910
+fastapi_voyager/introspectors/django_ninja.py,sha256=Ytneh_kpsakTo_Njv1e4nvqfErjT1PrYelLZ-8xX5Gg,4052
+fastapi_voyager/introspectors/fastapi.py,sha256=SyWGKAH8cM3CENY-Uu3YY6e8kFM5BE-jEBBZLoIF--A,2696
+fastapi_voyager/introspectors/litestar.py,sha256=QXnaT0-hCa_0sByKJoUWuu0vIzRpCCKLokCBDTtv_s4,6100
 fastapi_voyager/templates/dot/cluster.j2,sha256=I2z9KkfCzmAtqXe0gXBnxnOfBXUSpdlATs3uf-O8_B8,307
 fastapi_voyager/templates/dot/cluster_container.j2,sha256=2tH1mOJvPoVKE_aHVMR3t06TfH_dYa9OeH6DBqSHt_A,204
 fastapi_voyager/templates/dot/digraph.j2,sha256=wZuiO-vvZ-AJ1FcMQG4BLevUyxk6yA-yEpUa3Us05mE,435
@@ -24,14 +36,14 @@ fastapi_voyager/templates/html/pydantic_meta.j2,sha256=_tsSqjucs_QrAlPIVRy9u6I2-
 fastapi_voyager/templates/html/schema_field_row.j2,sha256=KfKexHO_QJV-OIJS0eiY_7fqA8031fWpD2g2wTv4BuE,111
 fastapi_voyager/templates/html/schema_header.j2,sha256=9WpuHLy3Zbv5GHG08qqaj5Xf-gaR-79ErBYuANZp7iA,179
 fastapi_voyager/templates/html/schema_table.j2,sha256=rzphiGk1il7uv4Gr2p_HLPHqyLZk63vLrGAmIduTdSE,117
-fastapi_voyager/web/graph-ui.js,sha256=4gEkXTgbA6CouD4IDMW5yKYfJTxHN2vL9G0CAr6w4qA,7662
+fastapi_voyager/web/graph-ui.js,sha256=9b2auyGWEpUcF65YV231GNojQ9Uk6FsT1SlRR3lSYnc,7664
 fastapi_voyager/web/graphviz.svg.css,sha256=K218ov_mdSe3ga4KwhiBB92ynVvm5zaAk9_D9a3d8hE,1546
-fastapi_voyager/web/graphviz.svg.js,sha256=deI815RgxpZ3_MpELeV-TBYy2MVuUvZtQOHfS3aeXHY,18203
-fastapi_voyager/web/index.html,sha256=wM9vJ_UfHR8p98F6SEMCKKjJcBEl0EyosWuPqVZYXvA,23496
+fastapi_voyager/web/graphviz.svg.js,sha256=VokgCghvP4zm3SFiFVPIikdW6XzjkZJXQkBbCrEitug,19885
+fastapi_voyager/web/index.html,sha256=4HGVavdd15u_BA7BwC-RJEeKal6hcYbiQaLcoOANQHI,23485
 fastapi_voyager/web/quasar.min.css,sha256=F5jQe7X2XT54VlvAaa2V3GsBFdVD-vxDZeaPLf6U9CU,203145
 fastapi_voyager/web/quasar.min.js,sha256=h0ftyPMW_CRiyzeVfQqiup0vrVt4_QWojpqmpnpn07E,502974
-fastapi_voyager/web/store.js,sha256=vwiqeLw7DfTOUDu9oN7b6nSBw8KG6W-5Dc-voQ1leL8,15113
-fastapi_voyager/web/vue-main.js,sha256=4lJi6ADrcaOzjXcQePkp7CyiCkAnvhnO-nkF3E6G3s4,10650
+fastapi_voyager/web/store.js,sha256=CKQz5tZtv6W70TDVqeQiOt2gUXzD0WIc0ufCa0dB8sU,15193
+fastapi_voyager/web/vue-main.js,sha256=MedNrfgy2KJCFiyv8sczC8d8M2yytZDX58PQGvjUYdM,10825
 fastapi_voyager/web/component/demo.js,sha256=sAklFGhKGmMy9-ofgOw2oPIidAoIOgHu6yvV51L_MAA,350
 fastapi_voyager/web/component/render-graph.js,sha256=9wnO70n3eyPKTpa744idgs5PSwgvzbfv4InZ68eEOKs,2454
 fastapi_voyager/web/component/route-code-display.js,sha256=a823nBz3EEjutW2pfi73rcF3hodCBmgYNmuZi94sXE4,3615
@@ -43,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.15.5.dist-info/METADATA,sha256=nvrvye9JChzW2WQLNq2S3wzPrDU67ZEFoOMYkNcXtuA,9870
-fastapi_voyager-0.15.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-fastapi_voyager-0.15.5.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.15.5.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.15.5.dist-info/RECORD,,
+fastapi_voyager-0.16.0a1.dist-info/METADATA,sha256=pGOq7n96lV1BKAXvCKPXUU8BvXN89HzgAMI90dmnH_Y,12943
+fastapi_voyager-0.16.0a1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+fastapi_voyager-0.16.0a1.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.16.0a1.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.16.0a1.dist-info/RECORD,,