fastapi-voyager 0.15.6__tar.gz → 0.16.0a1__tar.gz

{fastapi_voyager-0.15.6 → fastapi_voyager-0.16.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.15.6
+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.6 → fastapi_voyager-0.16.0a1}/README.md

@@ -5,10 +5,12 @@
 
 # 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/
@@ -20,6 +22,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)
@@ -29,7 +32,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
@@ -37,6 +40,8 @@ from fastapi_voyager import create_voyager
 
 app = FastAPI()
 
+# ... define your routes ...
+
 app.mount('/voyager',
           create_voyager(
             app,
@@ -45,12 +50,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
@@ -81,9 +88,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.
 
@@ -229,6 +333,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)
@@ -260,9 +379,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.6 → fastapi_voyager-0.16.0a1}/docs/changelog.md

@@ -176,8 +176,12 @@
     - [x] internal refactor: graph-ui.js
     - [x] enhance the selected and unselected node & edges
 
-## 0.16, enhance er diagram
-- 0.16.0
+## 0.16
+- 0.16.0alpha-1
+    - [x] support django ninja and litestar
+
+## 0.17, enhance er diagram
+- 0.17.0
     - [ ] show loader name
     - [ ] show relationship list when double click entity in er diagram
     - [ ] highlight entity in use case

{fastapi_voyager-0.15.6 → fastapi_voyager-0.16.0a1}/pyproject.toml

@@ -8,7 +8,6 @@ readme = "README.md"
 requires-python = ">=3.10"
 keywords = ["fastapi", "visualization", "routing", "openapi"]
 dependencies = [
-  "fastapi>=0.110",
   "pydantic-resolve>=2.4.3",
   "jinja2>=3.0.0"
 ]
@@ -32,7 +31,7 @@ Homepage = "https://github.com/allmonday/fastapi-voyager"
 Source = "https://github.com/allmonday/fastapi-voyager"
 
 [project.optional-dependencies]
-dev = ["uvicorn", "ruff", "pytest"]
+dev = ["uvicorn", "ruff", "pytest", "pytest-asyncio", "httpx", "fastapi>=0.110", "django-ninja", "litestar"]
 
 [build-system]
 requires = ["hatchling"]
@@ -41,6 +40,9 @@ build-backend = "hatchling.build"
 [tool.hatch.version]
 path = "src/fastapi_voyager/version.py"
 
+[tool.hatch.build.targets.wheel]
+packages = ["src/fastapi_voyager"]
+
 [tool.uv]
 # You can pin resolution or indexes here later.
 
@@ -49,3 +51,12 @@ line-length = 100
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "UP", "B"]
+
+[dependency-groups]
+dev = [
+    "django-ninja>=1.5.3",
+    "fastapi>=0.116.1",
+    "httpx>=0.28.1",
+    "litestar>=2.19.0",
+    "pytest-asyncio>=1.3.0",
+]

fastapi_voyager-0.16.0a1/src/fastapi_voyager/__init__.py

@@ -0,0 +1,8 @@
+"""fastapi_voyager
+
+Utilities to introspect web applications and visualize their routing tree.
+"""
+from .server import create_voyager
+from .version import __version__  # noqa: F401
+
+__all__ = [ "__version__", "create_voyager" ]

fastapi_voyager-0.16.0a1/src/fastapi_voyager/adapters/__init__.py

@@ -0,0 +1,16 @@
+"""
+Framework adapters for fastapi-voyager.
+
+This module provides adapters that allow voyager to work with different web frameworks.
+"""
+from fastapi_voyager.adapters.base import VoyagerAdapter
+from fastapi_voyager.adapters.django_ninja_adapter import DjangoNinjaAdapter
+from fastapi_voyager.adapters.fastapi_adapter import FastAPIAdapter
+from fastapi_voyager.adapters.litestar_adapter import LitestarAdapter
+
+__all__ = [
+    "VoyagerAdapter",
+    "FastAPIAdapter",
+    "DjangoNinjaAdapter",
+    "LitestarAdapter",
+]

fastapi_voyager-0.16.0a1/src/fastapi_voyager/adapters/base.py

@@ -0,0 +1,44 @@
+"""
+Base adapter interface for framework-agnostic voyager server.
+
+This module defines the abstract interface that all framework adapters must implement.
+"""
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class VoyagerAdapter(ABC):
+    """
+    Abstract base class for framework-specific voyager adapters.
+
+    Each adapter is responsible for:
+    1. Creating routes/endpoints for the voyager UI
+    2. Handling HTTP requests and responses in a framework-specific way
+    3. Returning an object that can be mounted/integrated with the target app
+    """
+
+    @abstractmethod
+    def create_app(self) -> Any:
+        """
+        Create and return a framework-specific application object.
+
+        The returned object should be mountable/integrable with the target framework.
+        For example:
+        - FastAPI: returns a FastAPI app
+        - Django Ninja: returns an ASGI application
+        - Litestar: returns a Litestar app
+
+        Returns:
+            A framework-specific application object
+        """
+        pass
+
+    @abstractmethod
+    def get_mount_path(self) -> str:
+        """
+        Get the recommended mount path for the voyager UI.
+
+        Returns:
+            The path where voyager should be mounted (e.g., "/voyager")
+        """
+        pass