fastapi-voyager 0.16.1__tar.gz → 0.17.0__tar.gz

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.16.1
+Version: 0.17.0
 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

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/docs/changelog.md

@@ -183,14 +183,28 @@
     - [x] fix import error
 - 0.16.0alpha-3
     - [x] fix voyager cli, add web parameter
+- 0.16.1
+    - [x] improve litestar support
 
 ## 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
+    - [x] 1.different theme color for frameworks
+        - fastapi, keep current
+        - django-ninja, #4cae4f
+        - litestar, rgb(237, 182, 65)
+    - [x] 2.highight entity classes
+        - enable if er diagram is enabled
+        - entities in er diagram should be labeled as "Entity" after the title, and title should be bold
+    - [x] 3.click esc to cancel search
+- 0.17.1
+    - [ ] 1.show loader name
+    - [ ] 2.show relationship list when double click entity in er diagram
+    - [ ] 3.highlight entity in use case
+    - [ ] 4.change cli -m param, use `path.to.module:app` instead.
 
 ## 1.0, release 
     - [ ] add tests
 
+## 1.1 future
+
 

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/adapters/common.py

@@ -9,7 +9,9 @@ from typing import Any
 from pydantic_resolve import ErDiagram
 
 from fastapi_voyager.er_diagram import VoyagerErDiagram
+from fastapi_voyager.introspectors.detector import FrameworkType, detect_framework
 from fastapi_voyager.render import Renderer
+from fastapi_voyager.render_style import RenderConfig
 from fastapi_voyager.type import CoreData, SchemaNode, Tag
 from fastapi_voyager.type_helper import get_source, get_vscode_link
 from fastapi_voyager.version import __version__
@@ -23,6 +25,7 @@ STATIC_FILES_PATH = "/fastapi-voyager-static"
 GA_PLACEHOLDER = "<!-- GA_SNIPPET -->"
 VERSION_PLACEHOLDER = "<!-- VERSION_PLACEHOLDER -->"
 STATIC_PATH_PLACEHOLDER = "<!-- STATIC_PATH -->"
+THEME_COLOR_PLACEHOLDER = "<!-- THEME_COLOR -->"
 
 
 def build_ga_snippet(ga_id: str | None) -> str:
@@ -70,13 +73,45 @@ class VoyagerContext:
         self.ga_id = ga_id
         self.er_diagram = er_diagram
         self.enable_pydantic_resolve_meta = enable_pydantic_resolve_meta
-        self.framework_name = framework_name or "API"
+
+        # Detect and store framework type (single source of truth)
+        self._framework_type = detect_framework(target_app)
+        # Display name for frontend (backward compatible)
+        self.framework_name = framework_name or self._get_display_name()
+
+    def _get_display_name(self) -> str:
+        """Get display name for the detected framework type."""
+        display_names = {
+            FrameworkType.FASTAPI: "FastAPI",
+            FrameworkType.DJANGO_NINJA: "Django Ninja",
+            FrameworkType.LITESTAR: "Litestar",
+        }
+        return display_names.get(self._framework_type, "API")
+
+    def _get_theme_color(self) -> str:
+        """Get theme color for the current framework."""
+        config = RenderConfig()
+        return config.colors.get_framework_color(self._framework_type)
+
+    def _get_entity_class_names(self) -> set[str] | None:
+        """Extract entity class names from er_diagram."""
+        if not self.er_diagram:
+            return None
+
+        from fastapi_voyager.type_helper import full_class_name
+
+        return {
+            full_class_name(entity.kls)
+            for entity in self.er_diagram.configs
+        }
 
     def get_voyager(self, **kwargs) -> Voyager:
         """Create a Voyager instance with common configuration."""
         config = {
             "module_color": self.module_color,
             "show_pydantic_resolve_meta": self.enable_pydantic_resolve_meta,
+            "theme_color": self._get_theme_color(),
+            "entity_class_names": self._get_entity_class_names(),
         }
         config.update(kwargs)
         return Voyager(**config)
@@ -179,6 +214,7 @@ class VoyagerContext:
             show_fields=core_data.show_fields,
             module_color=core_data.module_color,
             schema=core_data.schema,
+            theme_color=self._get_theme_color(),
         )
         return renderer.render_dot(
             core_data.tags, core_data.routes, core_data.nodes, core_data.links
@@ -191,6 +227,7 @@ class VoyagerContext:
                 self.er_diagram,
                 show_fields=payload.get("show_fields", "object"),
                 show_module=payload.get("show_module", True),
+                theme_color=self._get_theme_color(),
             ).render_dot()
         return ""
 
@@ -203,6 +240,8 @@ class VoyagerContext:
             content = content.replace(VERSION_PLACEHOLDER, f"?v={__version__}")
             # Replace static files path placeholder with actual path (without leading slash)
             content = content.replace(STATIC_PATH_PLACEHOLDER, STATIC_FILES_PATH.lstrip("/"))
+            # Replace theme color placeholder with framework-specific color
+            content = content.replace(THEME_COLOR_PLACEHOLDER, self._get_theme_color())
             return content
         # fallback simple page if index.html missing
         return """

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/adapters/litestar_adapter.py

@@ -53,7 +53,7 @@ class LitestarAdapter(VoyagerAdapter):
         from litestar import Litestar, MediaType, Request, Response, get, post
         from litestar.static_files import create_static_files_router
 
-        @get("/er-diagram")
+        @post("/er-diagram")
         async def get_er_diagram(request: Request) -> str:
             payload = await request.json()
             return self.ctx.get_er_diagram_dot(payload)

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/er_diagram.py

@@ -38,13 +38,15 @@ class DiagramRenderer(Renderer):
         self,
         *,
         show_fields: FieldType = 'single',
-        show_module: bool = True
+        show_module: bool = True,
+        theme_color: str | None = None
     ) -> None:
         # Initialize parent Renderer with shared config
         super().__init__(
             show_fields=show_fields,
             show_module=show_module,
-            config=RenderConfig()  # Use unified style configuration
+            config=RenderConfig(),  # Use unified style configuration
+            theme_color=theme_color,
         )
         logger.info(f'show_module: {self.show_module}')
 
@@ -99,10 +101,11 @@ class DiagramRenderer(Renderer):
 
 
 class VoyagerErDiagram:
-    def __init__(self, 
-                 er_diagram: ErDiagram, 
+    def __init__(self,
+                 er_diagram: ErDiagram,
                  show_fields: FieldType = 'single',
-                 show_module: bool = False):
+                 show_module: bool = False,
+                 theme_color: str | None = None):
 
         self.er_diagram = er_diagram
         self.nodes: list[SchemaNode] = []
@@ -115,6 +118,7 @@ class VoyagerErDiagram:
 
         self.show_field = show_fields
         self.show_module = show_module
+        self.theme_color = theme_color
     
     def generate_node_head(self, link_name: str):
         return f'{link_name}::{PK}'
@@ -164,10 +168,11 @@ class VoyagerErDiagram:
         if full_name not in self.node_set:
             # skip meta info for normal queries
             self.node_set[full_name] = SchemaNode(
-                id=full_name, 
+                id=full_name,
                 module=schema.__module__,
                 name=schema.__name__,
-                fields=get_fields(schema, fk_set)
+                fields=get_fields(schema, fk_set),
+                is_entity=False  # Don't mark in ER diagram
             )
         return full_name
 
@@ -209,7 +214,11 @@ class VoyagerErDiagram:
 
         for entity in self.er_diagram.configs:
             self.analysis_entity(entity)
-        renderer = DiagramRenderer(show_fields=self.show_field, show_module=self.show_module)
+        renderer = DiagramRenderer(
+            show_fields=self.show_field,
+            show_module=self.show_module,
+            theme_color=self.theme_color
+        )
         return renderer.render_dot(list(self.node_set.values()), self.links)
 
 

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/render.py

@@ -63,6 +63,7 @@ class Renderer:
         show_module: bool = True,
         show_pydantic_resolve_meta: bool = False,
         config: RenderConfig | None = None,
+        theme_color: str | None = None,
     ) -> None:
         self.show_fields = show_fields if show_fields in ('single', 'object', 'all') else 'single'
         self.module_color = module_color or {}
@@ -75,6 +76,9 @@ class Renderer:
         self.colors = self.config.colors
         self.style = self.config.style
 
+        # Framework theme color (overrides default primary color)
+        self.theme_color = theme_color or self.colors.primary
+
         # Initialize template renderer
         self.template_renderer = TemplateRenderer()
 
@@ -228,7 +232,7 @@ class Renderer:
             rows.append(self._render_schema_field(field))
 
         # Determine header color
-        default_color = self.colors.primary if color is None else color
+        default_color = self.theme_color if color is None else color
         header_color = self.colors.highlight if node.id == self.schema else default_color
 
         # Render header
@@ -236,7 +240,8 @@ class Renderer:
             'html/schema_header.j2',
             text=node.name,
             bg_color=header_color,
-            port=PK
+            port=PK,
+            is_entity=node.is_entity
         )
 
         # Render complete table

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/render_style.py

@@ -3,11 +3,20 @@ Style constants and configuration for rendering DOT graphs and HTML tables.
 """
 from dataclasses import dataclass, field
 
+from fastapi_voyager.introspectors.detector import FrameworkType
+
 
 @dataclass
 class ColorScheme:
     """Color scheme for graph visualization."""
 
+    # Framework-specific theme colors (single source of truth)
+    FRAMEWORK_COLORS: dict[FrameworkType, str] = field(default_factory=lambda: {
+        FrameworkType.FASTAPI: '#009485',
+        FrameworkType.DJANGO_NINJA: '#4cae4f',
+        FrameworkType.LITESTAR: '#edb641',
+    })
+
     # Node colors
     primary: str = '#009485'
     highlight: str = 'tomato'
@@ -30,6 +39,10 @@ class ColorScheme:
     # Text colors
     text_gray: str = '#999'
 
+    def get_framework_color(self, framework_type: FrameworkType) -> str:
+        """Get theme color for a specific framework type."""
+        return self.FRAMEWORK_COLORS.get(framework_type, self.primary)
+
 
 @dataclass
 class GraphvizStyle:

fastapi_voyager-0.17.0/src/fastapi_voyager/templates/html/schema_header.j2

@@ -0,0 +1 @@
+<tr><td cellpadding="6" bgcolor="{{ bg_color }}" align="center" colspan="1" {% if port %}port="{{ port }}"{% endif %}><font color="white">{% if is_entity %}<b>{{ text }} (E)</b>{% else %}{{ text }}{% endif %}</font></td></tr>

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/type.py

@@ -48,6 +48,7 @@ class ModuleRoute:
 class SchemaNode(NodeBase):
     module: str
     fields: list[FieldInfo] = field(default_factory=list)
+    is_entity: bool = False  # Mark if this is an ER diagram entity
 
 @dataclass
 class ModuleNode:

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/type_helper.py

@@ -29,6 +29,26 @@ def full_class_name(cls):
     return f"{cls.__module__}.{cls.__qualname__}"
 
 
+def is_base_entity_subclass(schema, entity_class_names: set[str] | None = None) -> bool:
+    """
+    Check if a schema is a pydantic-resolve BaseEntity entity.
+
+    Checks if the class's full name is in the entity_class_names set.
+
+    Args:
+        schema: The schema class to check
+        entity_class_names: Optional set of full class names from er_diagram.configs
+
+    Returns:
+        True if the schema is an entity, False otherwise
+    """
+    if not entity_class_names:
+        return False
+
+    schema_full_name = full_class_name(schema)
+    return schema_full_name in entity_class_names
+
+
 def get_core_types(tp):
     """
     - get the core type

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.16.1"
+__version__ = "0.17.0"

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/voyager.py

@@ -16,6 +16,7 @@ from fastapi_voyager.type_helper import (
     get_core_types,
     get_pydantic_fields,
     get_type_name,
+    is_base_entity_subclass,
     is_inheritance_of_pydantic_base,
     is_non_pydantic_type,
     update_forward_refs,
@@ -24,8 +25,8 @@ from fastapi_voyager.type_helper import (
 
 class Voyager:
     def __init__(
-            self, 
-            schema: str | None = None, 
+            self,
+            schema: str | None = None,
             schema_field: str | None = None,
             show_fields: FieldType = 'single',
             include_tags: list[str] | None = None,
@@ -34,6 +35,8 @@ class Voyager:
             hide_primitive_route: bool = False,
             show_module: bool = True,
             show_pydantic_resolve_meta: bool = False,
+            theme_color: str | None = None,
+            entity_class_names: set[str] | None = None,
         ):
 
         self.routes: list[Route] = []
@@ -57,6 +60,8 @@ class Voyager:
         self.hide_primitive_route = hide_primitive_route
         self.show_module = show_module
         self.show_pydantic_resolve_meta = show_pydantic_resolve_meta
+        self.theme_color = theme_color
+        self.entity_class_names = entity_class_names
 
     def _get_introspector(self, app) -> AppIntrospector:
         """
@@ -189,7 +194,7 @@ class Voyager:
         """
         full_name = full_class_name(schema)
         bases_fields = get_bases_fields([s for s in schema.__bases__ if is_inheritance_of_pydantic_base(s)])
-        
+
         subset_reference = getattr(schema, const.ENSURE_SUBSET_REFERENCE, None)
         if subset_reference and is_inheritance_of_pydantic_base(subset_reference):
             bases_fields.update(get_bases_fields([subset_reference]))
@@ -197,10 +202,11 @@ class Voyager:
         if full_name not in self.node_set:
             # skip meta info for normal queries
             self.node_set[full_name] = SchemaNode(
-                id=full_name, 
+                id=full_name,
                 module=schema.__module__,
                 name=schema.__name__,
-                fields=get_pydantic_fields(schema, bases_fields)
+                fields=get_pydantic_fields(schema, bases_fields),
+                is_entity=is_base_entity_subclass(schema, self.entity_class_names)
             )
         return full_name
 
@@ -351,14 +357,15 @@ class Voyager:
 
         renderer = Renderer(
             show_fields=self.show_fields,
-            module_color=self.module_color, 
-            schema=self.schema, 
+            module_color=self.module_color,
+            schema=self.schema,
             show_module=self.show_module,
-            show_pydantic_resolve_meta=self.show_pydantic_resolve_meta)
+            show_pydantic_resolve_meta=self.show_pydantic_resolve_meta,
+            theme_color=self.theme_color)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links)
-    
+
 
     def render_tag_level_brief_dot(self, module_prefix: str | None = None):
         _tags, _routes, _nodes, _links = filter_graph(
@@ -379,7 +386,12 @@ class Voyager:
             links=_links,
         )
 
-        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema, show_module=self.show_module)
+        renderer = Renderer(
+            show_fields=self.show_fields,
+            module_color=self.module_color,
+            schema=self.schema,
+            show_module=self.show_module,
+            theme_color=self.theme_color)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links, True)
@@ -403,7 +415,12 @@ class Voyager:
             links=_links,
         )
 
-        renderer = Renderer(show_fields=self.show_fields, module_color=self.module_color, schema=self.schema, show_module=self.show_module)
+        renderer = Renderer(
+            show_fields=self.show_fields,
+            module_color=self.module_color,
+            schema=self.schema,
+            show_module=self.show_module,
+            theme_color=self.theme_color)
 
         _tags, _routes, _links = self.handle_hide(_tags, _routes, _links)
         return renderer.render_dot(_tags, _routes, _nodes, _links, True)

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/web/index.html

@@ -35,6 +35,9 @@
   </head>
 
   <style>
+    :root {
+      --q-primary: <!-- THEME_COLOR -->;
+    }
     html,
     body {
       height: 100%;
@@ -112,7 +115,7 @@
       width: 32px;
       height: 32px;
       border-radius: 50%;
-      background: #009485;
+      background: var(--q-primary);
       color: white;
       cursor: pointer;
       display: flex;
@@ -122,7 +125,7 @@
       transition: all 0.2s ease;
     }
     .tag-navigator-collapse-btn-right:hover {
-      background: #007a6d;
+      filter: brightness(0.9);
       box-shadow: 0 2px 12px rgba(0, 0, 0, 0.3);
     }
 
@@ -144,7 +147,7 @@
         Helvetica,
         Arial,
         sans-serif;
-      color: #009485;
+      color: var(--q-primary);
     }
     .loading-text {
       font-size: 14px;
@@ -153,7 +156,7 @@
       width: 20px;
       height: 20px;
       border: 2px solid rgba(0, 148, 133, 0.2);
-      border-top-color: #009485;
+      border-top-color: var(--q-primary);
       border-radius: 50%;
       animation: frv-spin 0.8s linear infinite;
     }
@@ -171,6 +174,10 @@
     }
   </style>
   <body class="app-loading">
+    <script>
+      // Framework theme color for JS components
+      window.FRAMEWORK_THEME_COLOR = "<!-- THEME_COLOR -->"
+    </script>
     <!-- App boot loading overlay: shown until JS initializes -->
     <div id="app-loading-overlay" aria-busy="true" aria-live="polite">
       <div class="spinner" aria-hidden="true"></div>
@@ -181,7 +188,7 @@
         <q-header bordered class="bg-primary text-white">
           <q-toolbar
             class="row text-grey-9 bg-white"
-            style="width: 100%; border-bottom: 2px solid #009485"
+            style="width: 100%; border-bottom: 2px solid var(--q-primary)"
           >
             <div
               class="col-auto text-primary"
@@ -313,7 +320,7 @@
                   height="52"
                   viewBox="0 0 250 250"
                   style="
-                    fill: #009485;
+                    fill: <!-- THEME_COLOR -->;
                     color: #fff;
                     position: absolute;
                     top: 0;

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/web/store.js

@@ -521,6 +521,11 @@ const actions = {
    */
   resetSearchState() {
     state.search.mode = false
+    // Clear search schema and field selection
+    state.search.schemaName = null
+    state.search.fieldName = null
+    state.search.fieldOptions = []
+
     const hadPreviousValue = state.previousTagRoute.hasValue
 
     if (hadPreviousValue) {

{fastapi_voyager-0.16.1 → fastapi_voyager-0.17.0}/src/fastapi_voyager/web/vue-main.js

@@ -5,7 +5,7 @@ import RenderGraph from "./component/render-graph.js"
 import { GraphUI } from "./graph-ui.js"
 import { store } from "./store.js"
 
-const { createApp, onMounted, ref, watch } = window.Vue
+const { createApp, onMounted, onUnmounted, ref, watch } = window.Vue
 
 // Load toggle states from localStorage
 function loadToggleState(key, defaultValue = false) {
@@ -296,6 +296,19 @@ const app = createApp({
         document.title = `${store.state.framework_name} Voyager`
       }
       // Reveal app content only after initial JS/data is ready
+
+      // Add keyboard event listener for ESC to cancel search
+      const handleKeyDown = (event) => {
+        if (event.key === "Escape" && store.state.search.mode) {
+          resetSearch()
+        }
+      }
+      document.addEventListener("keydown", handleKeyDown)
+
+      // Cleanup on unmount
+      onUnmounted(() => {
+        document.removeEventListener("keydown", handleKeyDown)
+      })
     })
 
     return {
@@ -324,9 +337,10 @@ const app = createApp({
 
 app.use(window.Quasar)
 
-// Set Quasar primary theme color to green
+// Set Quasar primary theme color from framework configuration
 if (window.Quasar && typeof window.Quasar.setCssVar === "function") {
-  window.Quasar.setCssVar("primary", "#009485")
+  const themeColor = window.FRAMEWORK_THEME_COLOR || "#009485"
+  window.Quasar.setCssVar("primary", themeColor)
 }
 
 app.component("schema-code-display", SchemaCodeDisplay) // double click to see node details

fastapi_voyager-0.16.1/src/fastapi_voyager/templates/html/schema_header.j2

@@ -1,2 +0,0 @@
-<tr><td cellpadding="6" bgcolor="{{ bg_color }}" align="center" colspan="1" {% if port %}port="{{ port }}"{% endif %}>
-    <font color="white">    {{ text }}    </font></td></tr>