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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.16.0a1
+Version: 0.16.0a2
 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)

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

@@ -179,6 +179,8 @@
 ## 0.16
 - 0.16.0alpha-1
     - [x] support django ninja and litestar
+- 0.16.0alpha-2
+    - [x] fix import error
 
 ## 0.17, enhance er diagram
 - 0.17.0

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a2}/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.0a2/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.0a2/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.0a2/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.0a2}/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
@@ -98,8 +94,14 @@ class FastAPIAdapter(VoyagerAdapter):
         )
         self.gzip_minimum_size = gzip_minimum_size
 
-    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)

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a2}/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
@@ -47,8 +44,11 @@ class LitestarAdapter(VoyagerAdapter):
         )
         self.gzip_minimum_size = gzip_minimum_size
 
-    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:

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a2}/src/fastapi_voyager/cli.py

@@ -5,17 +5,19 @@ import importlib.util
 import logging
 import os
 import sys
-
-from fastapi import FastAPI
+from typing import TYPE_CHECKING
 
 from fastapi_voyager import server as viz_server
 from fastapi_voyager.version import __version__
 from fastapi_voyager.voyager import Voyager
 
+if TYPE_CHECKING:
+    from fastapi import FastAPI
+
 logger = logging.getLogger(__name__)
 
 
-def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> FastAPI | None:
+def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> "FastAPI | None":
     """Load FastAPI app from a Python module file."""
     try:
         # Convert relative path to absolute path
@@ -35,6 +37,8 @@ def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> FastA
         # Get the FastAPI app instance
         if hasattr(module, app_name):
             app = getattr(module, app_name)
+            # Lazy import to avoid import errors when FastAPI is not installed
+            from fastapi import FastAPI
             if isinstance(app, FastAPI):
                 return app
             logger.error(f"'{app_name}' is not a FastAPI instance")
@@ -47,7 +51,7 @@ def load_fastapi_app_from_file(module_path: str, app_name: str = "app") -> FastA
         return None
 
 
-def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> FastAPI | None:
+def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> "FastAPI | None":
     """Load FastAPI app from a Python module name."""
     try:
         # Temporarily add the current working directory to sys.path
@@ -65,6 +69,8 @@ def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> Fas
             # Get the FastAPI app instance
             if hasattr(module, app_name):
                 app = getattr(module, app_name)
+                # Lazy import to avoid import errors when FastAPI is not installed
+                from fastapi import FastAPI
                 if isinstance(app, FastAPI):
                     return app
                 logger.error(f"'{app_name}' is not a FastAPI instance")
@@ -85,7 +91,7 @@ def load_fastapi_app_from_module(module_name: str, app_name: str = "app") -> Fas
 
 
 def generate_visualization(
-    app: FastAPI,
+    app: "FastAPI",
     output_file: str = "router_viz.dot", tags: list[str] | None = None,
     schema: str | None = None,
     show_fields: bool = False,

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a2}/src/fastapi_voyager/introspectors/fastapi.py

@@ -4,11 +4,13 @@ FastAPI implementation of the AppIntrospector interface.
 This module provides the adapter that allows fastapi-voyager to work with FastAPI applications.
 """
 from collections.abc import Iterator
-
-from fastapi import FastAPI, routing
+from typing import TYPE_CHECKING, Any
 
 from fastapi_voyager.introspectors.base import AppIntrospector, RouteInfo
 
+if TYPE_CHECKING:
+    from fastapi import FastAPI
+
 
 class FastAPIIntrospector(AppIntrospector):
     """
@@ -18,7 +20,7 @@ class FastAPIIntrospector(AppIntrospector):
     and converts it to the framework-agnostic RouteInfo format.
     """
 
-    def __init__(self, app: FastAPI, swagger_url: str | None = None):
+    def __init__(self, app: "FastAPI", swagger_url: str | None = None):
         """
         Initialize the FastAPI introspector.
 
@@ -26,6 +28,12 @@ class FastAPIIntrospector(AppIntrospector):
             app: The FastAPI application instance
             swagger_url: Optional custom URL to Swagger documentation
         """
+        # Lazy import to avoid import errors when FastAPI is not installed
+        from fastapi import FastAPI
+
+        if not isinstance(app, FastAPI):
+            raise TypeError(f"Expected FastAPI instance, got {type(app)}")
+
         self.app = app
         self.swagger_url = swagger_url or "/docs"
 
@@ -36,6 +44,9 @@ class FastAPIIntrospector(AppIntrospector):
         Yields:
             RouteInfo: Standardized route information for each API route
         """
+        # Lazy import routing to avoid import errors when FastAPI is not installed
+        from fastapi import routing
+
         for route in self.app.routes:
             # Only process APIRoute instances (not static files, etc.)
             if isinstance(route, routing.APIRoute):
@@ -66,7 +77,7 @@ class FastAPIIntrospector(AppIntrospector):
         """
         return self.swagger_url
 
-    def _get_route_id(self, route: routing.APIRoute) -> str:
+    def _get_route_id(self, route: Any) -> str:
         """
         Generate a unique identifier for the route.
 

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

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

{fastapi_voyager-0.16.0a1 → fastapi_voyager-0.16.0a2}/uv.lock

@@ -188,48 +188,130 @@ dependencies = [
 ]
 
 [package.optional-dependencies]
-dev = [
+all = [
+    { name = "django", version = "5.2.10", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "django", version = "6.0.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
     { name = "django-ninja" },
     { name = "fastapi" },
     { name = "httpx" },
     { name = "litestar" },
+    { name = "pydantic" },
+    { name = "pytest" },
+    { name = "pytest-asyncio" },
+    { name = "ruff" },
+    { name = "uvicorn" },
+]
+dev = [
+    { name = "httpx" },
     { name = "pytest" },
     { name = "pytest-asyncio" },
     { name = "ruff" },
+]
+django-ninja = [
+    { name = "django", version = "5.2.10", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "django", version = "6.0.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
+    { name = "django-ninja" },
+    { name = "uvicorn" },
+]
+fastapi = [
+    { name = "fastapi" },
+    { name = "uvicorn" },
+]
+litestar = [
+    { name = "litestar" },
+    { name = "pydantic" },
     { name = "uvicorn" },
 ]
 
 [package.dev-dependencies]
-dev = [
+all = [
+    { name = "django", version = "5.2.10", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "django", version = "6.0.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
     { name = "django-ninja" },
     { name = "fastapi" },
-    { name = "httpx" },
     { name = "litestar" },
+    { name = "pydantic" },
+    { name = "uvicorn" },
+]
+dev = [
+    { name = "httpx" },
+    { name = "pytest" },
     { name = "pytest-asyncio" },
+    { name = "ruff" },
+]
+django-ninja = [
+    { name = "django", version = "5.2.10", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
+    { name = "django", version = "6.0.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
+    { name = "django-ninja" },
+    { name = "uvicorn" },
+]
+fastapi = [
+    { name = "fastapi" },
+    { name = "uvicorn" },
+]
+litestar = [
+    { name = "litestar" },
+    { name = "pydantic" },
+    { name = "uvicorn" },
 ]
 
 [package.metadata]
 requires-dist = [
-    { name = "django-ninja", marker = "extra == 'dev'" },
-    { name = "fastapi", marker = "extra == 'dev'", specifier = ">=0.110" },
+    { name = "django", marker = "extra == 'all'", specifier = ">=4.2" },
+    { name = "django", marker = "extra == 'django-ninja'", specifier = ">=4.2" },
+    { name = "django-ninja", marker = "extra == 'all'", specifier = ">=1.5.3" },
+    { name = "django-ninja", marker = "extra == 'django-ninja'", specifier = ">=1.5.3" },
+    { name = "fastapi", marker = "extra == 'all'", specifier = ">=0.110" },
+    { name = "fastapi", marker = "extra == 'fastapi'", specifier = ">=0.110" },
+    { name = "httpx", marker = "extra == 'all'" },
     { name = "httpx", marker = "extra == 'dev'" },
     { name = "jinja2", specifier = ">=3.0.0" },
-    { name = "litestar", marker = "extra == 'dev'" },
+    { name = "litestar", marker = "extra == 'all'", specifier = ">=2.19.0" },
+    { name = "litestar", marker = "extra == 'litestar'", specifier = ">=2.19.0" },
+    { name = "pydantic", marker = "extra == 'all'", specifier = ">=2.0" },
+    { name = "pydantic", marker = "extra == 'litestar'", specifier = ">=2.0" },
     { name = "pydantic-resolve", specifier = ">=2.4.3" },
+    { name = "pytest", marker = "extra == 'all'" },
     { name = "pytest", marker = "extra == 'dev'" },
+    { name = "pytest-asyncio", marker = "extra == 'all'" },
     { name = "pytest-asyncio", marker = "extra == 'dev'" },
+    { name = "ruff", marker = "extra == 'all'" },
     { name = "ruff", marker = "extra == 'dev'" },
-    { name = "uvicorn", marker = "extra == 'dev'" },
+    { name = "uvicorn", marker = "extra == 'all'" },
+    { name = "uvicorn", marker = "extra == 'django-ninja'" },
+    { name = "uvicorn", marker = "extra == 'fastapi'" },
+    { name = "uvicorn", marker = "extra == 'litestar'" },
 ]
-provides-extras = ["dev"]
+provides-extras = ["all", "dev", "django-ninja", "fastapi", "litestar"]
 
 [package.metadata.requires-dev]
-dev = [
+all = [
+    { name = "django", specifier = ">=4.2" },
     { name = "django-ninja", specifier = ">=1.5.3" },
     { name = "fastapi", specifier = ">=0.116.1" },
-    { name = "httpx", specifier = ">=0.28.1" },
     { name = "litestar", specifier = ">=2.19.0" },
+    { name = "pydantic", specifier = ">=2.0" },
+    { name = "uvicorn", specifier = ">=0.34.0" },
+]
+dev = [
+    { name = "httpx", specifier = ">=0.28.1" },
+    { name = "pytest", specifier = ">=8.0.0" },
     { name = "pytest-asyncio", specifier = ">=1.3.0" },
+    { name = "ruff", specifier = ">=0.9.0" },
+]
+django-ninja = [
+    { name = "django", specifier = ">=4.2" },
+    { name = "django-ninja", specifier = ">=1.5.3" },
+    { name = "uvicorn", specifier = ">=0.34.0" },
+]
+fastapi = [
+    { name = "fastapi", specifier = ">=0.116.1" },
+    { name = "uvicorn", specifier = ">=0.34.0" },
+]
+litestar = [
+    { name = "litestar", specifier = ">=2.19.0" },
+    { name = "pydantic", specifier = ">=2.0" },
+    { name = "uvicorn", specifier = ">=0.34.0" },
 ]
 
 [[package]]

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

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