fastapi-voyager 0.16.0a1__tar.gz → 0.16.0a3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.16.0a1
+Version: 0.16.0a3
 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
@@ -20,15 +20,33 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
 Requires-Dist: jinja2>=3.0.0
 Requires-Dist: pydantic-resolve>=2.4.3
+Provides-Extra: all
+Requires-Dist: django-ninja>=1.5.3; extra == 'all'
+Requires-Dist: django>=4.2; extra == 'all'
+Requires-Dist: fastapi>=0.110; extra == 'all'
+Requires-Dist: httpx; extra == 'all'
+Requires-Dist: litestar>=2.19.0; extra == 'all'
+Requires-Dist: pydantic>=2.0; extra == 'all'
+Requires-Dist: pytest; extra == 'all'
+Requires-Dist: pytest-asyncio; extra == 'all'
+Requires-Dist: ruff; extra == 'all'
+Requires-Dist: uvicorn; extra == 'all'
 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'
+Provides-Extra: django-ninja
+Requires-Dist: django-ninja>=1.5.3; extra == 'django-ninja'
+Requires-Dist: django>=4.2; extra == 'django-ninja'
+Requires-Dist: uvicorn; extra == 'django-ninja'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.110; extra == 'fastapi'
+Requires-Dist: uvicorn; extra == 'fastapi'
+Provides-Extra: litestar
+Requires-Dist: litestar>=2.19.0; extra == 'litestar'
+Requires-Dist: pydantic>=2.0; extra == 'litestar'
+Requires-Dist: uvicorn; extra == 'litestar'
 Description-Content-Type: text/markdown
 
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
@@ -301,8 +319,14 @@ Set `enable_pydantic_resolve_meta=True` in `create_voyager`, then toggle the "py
 ### Start Server
 
 ```bash
-# Open in browser (default port 8000)
-voyager -m tests.demo --server
+# FastAPI
+voyager -m tests.demo --server --web fastapi
+
+# Django Ninja
+voyager -m tests.demo --server --web django-ninja
+
+# Litestar
+voyager -m tests.demo --server --web litestar
 
 # Custom port
 voyager -m tests.demo --server --port=8002

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

@@ -268,8 +268,14 @@ Set `enable_pydantic_resolve_meta=True` in `create_voyager`, then toggle the "py
 ### Start Server
 
 ```bash
-# Open in browser (default port 8000)
-voyager -m tests.demo --server
+# FastAPI
+voyager -m tests.demo --server --web fastapi
+
+# Django Ninja
+voyager -m tests.demo --server --web django-ninja
+
+# Litestar
+voyager -m tests.demo --server --web litestar
 
 # Custom port
 voyager -m tests.demo --server --port=8002

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a3}/docs/changelog.md

@@ -179,6 +179,10 @@
 ## 0.16
 - 0.16.0alpha-1
     - [x] support django ninja and litestar
+- 0.16.0alpha-2
+    - [x] fix import error
+- 0.16.0alpha-3
+    - [x] fix voyager cli, add web parameter
 
 ## 0.17, enhance er diagram
 - 0.17.0

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

@@ -31,7 +31,11 @@ Homepage = "https://github.com/allmonday/fastapi-voyager"
 Source = "https://github.com/allmonday/fastapi-voyager"
 
 [project.optional-dependencies]
-dev = ["uvicorn", "ruff", "pytest", "pytest-asyncio", "httpx", "fastapi>=0.110", "django-ninja", "litestar"]
+dev = ["ruff", "pytest", "pytest-asyncio", "httpx"]
+fastapi = ["fastapi>=0.110", "uvicorn"]
+django-ninja = ["django>=4.2", "django-ninja>=1.5.3", "uvicorn"]
+litestar = ["litestar>=2.19.0", "pydantic>=2.0", "uvicorn"]
+all = ["fastapi-voyager[dev,fastapi,django-ninja,litestar]"]
 
 [build-system]
 requires = ["hatchling"]
@@ -54,9 +58,30 @@ select = ["E", "F", "I", "UP", "B"]
 
 [dependency-groups]
 dev = [
+    "httpx>=0.28.1",
+    "pytest-asyncio>=1.3.0",
+    "pytest>=8.0.0",
+    "ruff>=0.9.0",
+]
+fastapi = [
+    "fastapi>=0.116.1",
+    "uvicorn>=0.34.0",
+]
+django-ninja = [
+    "django>=4.2",
+    "django-ninja>=1.5.3",
+    "uvicorn>=0.34.0",
+]
+litestar = [
+    "litestar>=2.19.0",
+    "pydantic>=2.0",
+    "uvicorn>=0.34.0",
+]
+all = [
+    "django>=4.2",
     "django-ninja>=1.5.3",
     "fastapi>=0.116.1",
-    "httpx>=0.28.1",
     "litestar>=2.19.0",
-    "pytest-asyncio>=1.3.0",
+    "pydantic>=2.0",
+    "uvicorn>=0.34.0",
 ]

fastapi_voyager-0.16.0a3/setup-django-ninja.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+# Django Ninja Development Setup Script
+# Usage: ./setup-django-ninja.sh [--no-sync]
+
+set -e
+
+echo "🚀 Setting up Django Ninja development environment..."
+echo ""
+
+# Parse arguments
+SYNC=true
+for arg in "$@"; do
+    case $arg in
+        --no-sync)
+            SYNC=false
+            shift
+            ;;
+    esac
+done
+
+# Sync dependencies
+if [ "$SYNC" = true ]; then
+    echo "📦 Syncing dependencies..."
+    uv sync --group dev --group django-ninja
+    echo "✅ Dependencies synced"
+    echo ""
+fi
+
+# Check if uvicorn is installed
+echo "🔍 Checking uvicorn installation..."
+if uv run which uvicorn > /dev/null 2>&1; then
+    UVICORN_PATH=$(uv run which uvicorn)
+    echo "✅ Uvicorn found at: $UVICORN_PATH"
+else
+    echo "❌ Uvicorn not found in project environment"
+    exit 1
+fi
+echo ""
+
+# Start Django Ninja server
+echo "🌟 Starting Django Ninja Voyager server..."
+echo "   App: tests.django_ninja.embedding:application"
+echo "   URL: http://127.0.0.1:8000"
+echo ""
+echo "Press Ctrl+C to stop the server"
+echo ""
+
+uv run uvicorn tests.django_ninja.embedding:application --reload --host 127.0.0.1 --port 8000

fastapi_voyager-0.16.0a3/setup-fastapi.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+# FastAPI Development Setup Script
+# Usage: ./setup-fastapi.sh [--no-sync]
+
+set -e
+
+echo "🚀 Setting up FastAPI development environment..."
+echo ""
+
+# Parse arguments
+SYNC=true
+for arg in "$@"; do
+    case $arg in
+        --no-sync)
+            SYNC=false
+            shift
+            ;;
+    esac
+done
+
+# Sync dependencies
+if [ "$SYNC" = true ]; then
+    echo "📦 Syncing dependencies..."
+    uv sync --group dev --group fastapi
+    echo "✅ Dependencies synced"
+    echo ""
+fi
+
+# Check if uvicorn is installed
+echo "🔍 Checking uvicorn installation..."
+if uv run which uvicorn > /dev/null 2>&1; then
+    UVICORN_PATH=$(uv run which uvicorn)
+    echo "✅ Uvicorn found at: $UVICORN_PATH"
+else
+    echo "❌ Uvicorn not found in project environment"
+    exit 1
+fi
+echo ""
+
+# Start FastAPI server
+echo "🌟 Starting FastAPI Voyager server..."
+echo "   App: tests.fastapi.embedding:app"
+echo "   URL: http://127.0.0.1:8000"
+echo ""
+echo "Press Ctrl+C to stop the server"
+echo ""
+
+uv run uvicorn tests.fastapi.embedding:app --reload --host 127.0.0.1 --port 8000

fastapi_voyager-0.16.0a3/setup-litestar.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+# Litestar Development Setup Script
+# Usage: ./setup-litestar.sh [--no-sync]
+
+set -e
+
+echo "🚀 Setting up Litestar development environment..."
+echo ""
+
+# Parse arguments
+SYNC=true
+for arg in "$@"; do
+    case $arg in
+        --no-sync)
+            SYNC=false
+            shift
+            ;;
+    esac
+done
+
+# Sync dependencies
+if [ "$SYNC" = true ]; then
+    echo "📦 Syncing dependencies..."
+    uv sync --group dev --group litestar
+    echo "✅ Dependencies synced"
+    echo ""
+fi
+
+# Check if uvicorn is installed
+echo "🔍 Checking uvicorn installation..."
+if uv run which uvicorn > /dev/null 2>&1; then
+    UVICORN_PATH=$(uv run which uvicorn)
+    echo "✅ Uvicorn found at: $UVICORN_PATH"
+else
+    echo "❌ Uvicorn not found in project environment"
+    exit 1
+fi
+echo ""
+
+# Start Litestar server
+echo "🌟 Starting Litestar Voyager server..."
+echo "   App: tests.litestar.embedding:asgi_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

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a3}/src/fastapi_voyager/adapters/base.py

@@ -32,13 +32,3 @@ class VoyagerAdapter(ABC):
             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

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a3}/src/fastapi_voyager/adapters/django_ninja_adapter.py

@@ -32,6 +32,7 @@ class DjangoNinjaAdapter(VoyagerAdapter):
         ga_id: str | None = None,
         er_diagram: Any = None,
         enable_pydantic_resolve_meta: bool = False,
+        server_mode: bool = False,
     ):
         self.ctx = VoyagerContext(
             target_app=target_app,
@@ -45,6 +46,7 @@ class DjangoNinjaAdapter(VoyagerAdapter):
             enable_pydantic_resolve_meta=enable_pydantic_resolve_meta,
             framework_name="Django Ninja",
         )
+        self.server_mode = server_mode
         # Note: gzip should be handled by Django's middleware, not here
 
     async def _handle_request(self, scope, receive, send):
@@ -55,8 +57,8 @@ class DjangoNinjaAdapter(VoyagerAdapter):
         # Parse the request
         method = scope["method"]
         path = scope["path"]
-        # Remove /voyager prefix for internal routing
-        if path.startswith("/voyager"):
+        # Remove /voyager prefix for internal routing (unless in server_mode)
+        if not self.server_mode and path.startswith("/voyager"):
             path = path[8:]  # Remove '/voyager'
             if path == "":
                 path = "/"
@@ -284,16 +286,15 @@ class DjangoNinjaAdapter(VoyagerAdapter):
         """Create and return an ASGI application."""
 
         async def asgi_app(scope, receive, send):
-            # Route /voyager/* to voyager handler
-            if scope["type"] == "http" and scope["path"].startswith("/voyager"):
-                await self._handle_request(scope, receive, send)
+            # In server_mode, handle all paths; otherwise only handle /voyager/*
+            if scope["type"] == "http":
+                if self.server_mode or scope["path"].startswith("/voyager"):
+                    await self._handle_request(scope, receive, send)
+                else:
+                    # Return 404 for non-voyager paths
+                    # (Django should handle these before they reach here)
+                    await self._send_404(send)
             else:
-                # Return 404 for non-voyager paths
-                # (Django should handle these before they reach here)
                 await self._send_404(send)
 
         return asgi_app
-
-    def get_mount_path(self) -> str:
-        """Get the recommended mount path for voyager."""
-        return "/voyager"

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a3}/src/fastapi_voyager/adapters/fastapi_adapter.py

@@ -5,11 +5,7 @@ This module provides the FastAPI-specific implementation of the voyager server.
 """
 from typing import Any, Literal
 
-from fastapi import APIRouter, FastAPI
-from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
-from fastapi.staticfiles import StaticFiles
 from pydantic import BaseModel
-from starlette.middleware.gzip import GZipMiddleware
 
 from fastapi_voyager.adapters.base import VoyagerAdapter
 from fastapi_voyager.adapters.common import STATIC_FILES_PATH, VoyagerContext
@@ -83,6 +79,7 @@ class FastAPIAdapter(VoyagerAdapter):
         ga_id: str | None = None,
         er_diagram: Any = None,
         enable_pydantic_resolve_meta: bool = False,
+        server_mode: bool = False,
     ):
         self.ctx = VoyagerContext(
             target_app=target_app,
@@ -97,9 +94,17 @@ class FastAPIAdapter(VoyagerAdapter):
             framework_name="FastAPI",
         )
         self.gzip_minimum_size = gzip_minimum_size
+        # Note: server_mode is accepted for API consistency but not used
+        # since FastAPI apps are always standalone with routes at /
 
-    def create_app(self) -> FastAPI:
+    def create_app(self) -> Any:
         """Create and return a FastAPI application with voyager endpoints."""
+        # Lazy import FastAPI to avoid import errors when framework is not installed
+        from fastapi import APIRouter, FastAPI
+        from fastapi.responses import HTMLResponse, JSONResponse, PlainTextResponse
+        from fastapi.staticfiles import StaticFiles
+        from starlette.middleware.gzip import GZipMiddleware
+
         router = APIRouter(tags=["fastapi-voyager"])
 
         @router.post("/er-diagram", response_class=PlainTextResponse)
@@ -159,7 +164,3 @@ class FastAPIAdapter(VoyagerAdapter):
         app.include_router(router)
 
         return app
-
-    def get_mount_path(self) -> str:
-        """Get the recommended mount path for voyager."""
-        return "/voyager"

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a3}/src/fastapi_voyager/adapters/litestar_adapter.py

@@ -5,9 +5,6 @@ This module provides the Litestar-specific implementation of the voyager server.
 """
 from typing import Any
 
-from litestar import Litestar, MediaType, Request, Response, get, post
-from litestar.static_files import create_static_files_router
-
 from fastapi_voyager.adapters.base import VoyagerAdapter
 from fastapi_voyager.adapters.common import STATIC_FILES_PATH, WEB_DIR, VoyagerContext
 from fastapi_voyager.type import CoreData, SchemaNode, Tag
@@ -32,6 +29,7 @@ class LitestarAdapter(VoyagerAdapter):
         ga_id: str | None = None,
         er_diagram: Any = None,
         enable_pydantic_resolve_meta: bool = False,
+        server_mode: bool = False,
     ):
         self.ctx = VoyagerContext(
             target_app=target_app,
@@ -46,9 +44,14 @@ class LitestarAdapter(VoyagerAdapter):
             framework_name="Litestar",
         )
         self.gzip_minimum_size = gzip_minimum_size
+        # Note: server_mode is accepted for API consistency but not used
+        # since Litestar apps are always standalone with routes at /
 
-    def create_app(self) -> Litestar:
+    def create_app(self) -> Any:
         """Create and return a Litestar application with voyager endpoints."""
+        # Lazy import Litestar to avoid import errors when framework is not installed
+        from litestar import Litestar, MediaType, Request, Response, get, post
+        from litestar.static_files import create_static_files_router
 
         @get("/er-diagram")
         async def get_er_diagram(request: Request) -> str:
@@ -182,7 +185,3 @@ class LitestarAdapter(VoyagerAdapter):
                 for f in schema.fields
             ],
         }
-
-    def get_mount_path(self) -> str:
-        """Get the recommended mount path for voyager."""
-        return "/voyager"