fastapi-voyager 0.9.1__tar.gz → 0.9.3__tar.gz

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.9.1
+Version: 0.9.3
 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
@@ -27,18 +27,15 @@ Description-Content-Type: text/markdown
 
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
-
-<p align="center"><img src="./voyager.jpg" alt="" /></p>
-
-
-[![IMAGE ALT TEXT](http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg)](https://www.youtube.com/watch?v=PGlbQq1M-n8 "FastAPI Voyager")
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-> This repo is still in early stage, currently it supports pydantic v2 only, previous name: fastapi-router-viz
+> This repo is still in early stage, it supports pydantic v2 only
 
-Inspect your API interactively
+Inspect your API interactively!
 
-<img width="1480" height="648" alt="image" src="https://github.com/user-attachments/assets/a6ccc9f1-cf06-493a-b99b-eb07767564bd" />
+<p align="center"><img src="./voyager.jpg" alt="" /></p>
+<p align="center"><a target="_blank" rel="" href="https://www.youtube.com/watch?v=PGlbQq1M-n8"><img src="http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg" alt="" style="max-width: 100%;"></a></p>
 
 ## Installation
 
@@ -52,11 +49,6 @@ uv add fastapi-voyager
 voyager -m path.to.your.app.module --server
 ```
 
-## Dependencies
-
-- FastAPI
-- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
-
 
 ## Feature
 
@@ -79,9 +71,9 @@ voyager -m tests.demo
 ```
 
 ### generate the graph
-after initialization, pick tag, rotue (optional) and click `generate`.
+after initialization, pick tag, rotue to render graph
 
-<img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
+<img width="1628" height="765" alt="image" src="https://github.com/user-attachments/assets/b4712f82-e754-453b-aa69-24c932b8f48f" />
 
 ### highlight
 click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
@@ -89,9 +81,9 @@ click a node to highlight it's upperstream and downstream nodes. figure out the
 <img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
 
 ### filter related nodes
-`shift` click a node to check related node, pick a field to narrow the result.
+`shift` click a node to check related node, pick a field to narrow the result, picked node is marked as red.
 
-<img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
+<img width="1423" height="552" alt="image" src="https://github.com/user-attachments/assets/468a058d-afa1-4601-a7c5-c6aad6a8a557" />
 
 ### view source code
 `alt` click a node to show source code or open file in vscode.
@@ -168,7 +160,24 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 ## Plan before v1.0
 
-### features:
+
+### backlog
+- [ ] user can generate nodes/edges manually and connect to generated ones
+    - [ ] add owner
+    - [ ] add extra info for schema
+- [ ] display standard ER diagram `hard`
+    - [ ] display potential invalid links
+- [ ] support dataclass (pending)
+
+### in analysis
+- [ ] click field to highlight links
+- [ ] animation effect for edges
+- [ ] customrized right click panel
+    - [ ] show own dependencies
+- [ ] clean up fe code
+
+### plan:
+#### <0.9:
 - [x] group schemas by module hierarchy
 - [x] module-based coloring via Analytics(module_color={...})
 - [x] view in web browser
@@ -196,26 +205,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [x] fix duplicated link from class and parent class, it also break clicking highlight
 - [x] refactor: abstract render module
 
-### backlog
-- [ ] user can generate nodes/edges manually and connect to generated ones
-    - [ ] add owner
-    - [ ] add extra info for schema
-- [ ] fixed left/right bar show field information
-- [ ] display standard ER diagram `hard`
-    - [ ] display potential invalid links
-
-bugs & non feature:
-- [ ] add tests
-- [ ] support dataclass (pending)
-
-### in analysis
-- [ ] click field to highlight links
-- [ ] animation effect for edges
-- [ ] customrized right click panel
-    - [ ] show own dependencies
-
-### plan:
-
 #### 0.9
 - [x] refactor: server.py
     - [x] rename create_app_with_fastapi -> create_voyager
@@ -223,19 +212,36 @@ bugs & non feature:
 - [x] improve initialization time cost
     - [x] query route / schema info through realtime api
     - [x] adjust fe
+- [x] adjust layout (0.9.3)
+    - [x] show field detail in right panel
+    - [x] show route info in bottom
 
 #### 0.10
-- [ ] logging information
-- [ ] open route in swagger
+- [ ] support opening route in swagger
     - config docs path
 - [ ] add http method for route
 - [ ] enable/disable module cluster  (may save space)
+- [ ] logging information
+- [ ] add tests
+- [ ] hide brief mode if not configured
+- [ ] optimize static resource
+- [ ] show route count in tag expansion item
+- [ ] route list show have a max height to trigger scrollable
+- [ ] fix layout issue when rendering huge graph
 
 #### 0.11
+- [ ] improve user experience
+    - double click to show detail
+    - improve search dialog
+
+#### 0.12
 - [ ] integration with pydantic-resolve
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges
 
+#### 0.13
+- [ ] config release pipeline
+- [ ]
 
 ## Using with pydantic-resolve
 
@@ -247,13 +253,25 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 
 ## Credits
 
-- https://apis.guru/graphql-voyager/, for inspiration.
-- https://github.com/tintinweb/vscode-interactive-graphviz, for web visualization.
+- https://apis.guru/graphql-voyager/, thanks for inspiration.
+- https://github.com/tintinweb/vscode-interactive-graphviz, thanks for web visualization.
+
+
+## Dependencies
+
+- FastAPI
+- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
+- Quasar
 
 
 ## Changelog
 
 - 0.9:
+    - 0.9.3:
+        - enhancement: better UI 
+    - 0.9.2:
+        - fix: missing fields in schema detail panel
+        - optimization: clean up fe codes.
     - 0.9.1:
         - api change: from `create_app_with_fastapi` to `create_voyager`, and expose as `from fastapi_voyager import create_voyager`
         - optimization: lazy load vscode link and source code, speed up the initialization.

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/README.md

@@ -1,17 +1,14 @@
 [![pypi](https://img.shields.io/pypi/v/fastapi-voyager.svg)](https://pypi.python.org/pypi/fastapi-voyager)
 ![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-voyager)
-
-<p align="center"><img src="./voyager.jpg" alt="" /></p>
-
-
-[![IMAGE ALT TEXT](http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg)](https://www.youtube.com/watch?v=PGlbQq1M-n8 "FastAPI Voyager")
+[![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-> This repo is still in early stage, currently it supports pydantic v2 only, previous name: fastapi-router-viz
+> This repo is still in early stage, it supports pydantic v2 only
 
-Inspect your API interactively
+Inspect your API interactively!
 
-<img width="1480" height="648" alt="image" src="https://github.com/user-attachments/assets/a6ccc9f1-cf06-493a-b99b-eb07767564bd" />
+<p align="center"><img src="./voyager.jpg" alt="" /></p>
+<p align="center"><a target="_blank" rel="" href="https://www.youtube.com/watch?v=PGlbQq1M-n8"><img src="http://img.youtube.com/vi/PGlbQq1M-n8/0.jpg" alt="" style="max-width: 100%;"></a></p>
 
 ## Installation
 
@@ -25,11 +22,6 @@ uv add fastapi-voyager
 voyager -m path.to.your.app.module --server
 ```
 
-## Dependencies
-
-- FastAPI
-- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
-
 
 ## Feature
 
@@ -52,9 +44,9 @@ voyager -m tests.demo
 ```
 
 ### generate the graph
-after initialization, pick tag, rotue (optional) and click `generate`.
+after initialization, pick tag, rotue to render graph
 
-<img width="1919" height="898" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/05e321d0-49f3-4af6-a7c7-f4c9c6b1dbfd" />
+<img width="1628" height="765" alt="image" src="https://github.com/user-attachments/assets/b4712f82-e754-453b-aa69-24c932b8f48f" />
 
 ### highlight
 click a node to highlight it's upperstream and downstream nodes. figure out the related models of one page, or homw many pages are related with one model.
@@ -62,9 +54,9 @@ click a node to highlight it's upperstream and downstream nodes. figure out the
 <img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
 
 ### filter related nodes
-`shift` click a node to check related node, pick a field to narrow the result.
+`shift` click a node to check related node, pick a field to narrow the result, picked node is marked as red.
 
-<img width="1917" height="800" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/e770dc70-f293-49e1-bcd7-d8dffa15d9ea" />
+<img width="1423" height="552" alt="image" src="https://github.com/user-attachments/assets/468a058d-afa1-4601-a7c5-c6aad6a8a557" />
 
 ### view source code
 `alt` click a node to show source code or open file in vscode.
@@ -141,7 +133,24 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 
 ## Plan before v1.0
 
-### features:
+
+### backlog
+- [ ] user can generate nodes/edges manually and connect to generated ones
+    - [ ] add owner
+    - [ ] add extra info for schema
+- [ ] display standard ER diagram `hard`
+    - [ ] display potential invalid links
+- [ ] support dataclass (pending)
+
+### in analysis
+- [ ] click field to highlight links
+- [ ] animation effect for edges
+- [ ] customrized right click panel
+    - [ ] show own dependencies
+- [ ] clean up fe code
+
+### plan:
+#### <0.9:
 - [x] group schemas by module hierarchy
 - [x] module-based coloring via Analytics(module_color={...})
 - [x] view in web browser
@@ -169,26 +178,6 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [x] fix duplicated link from class and parent class, it also break clicking highlight
 - [x] refactor: abstract render module
 
-### backlog
-- [ ] user can generate nodes/edges manually and connect to generated ones
-    - [ ] add owner
-    - [ ] add extra info for schema
-- [ ] fixed left/right bar show field information
-- [ ] display standard ER diagram `hard`
-    - [ ] display potential invalid links
-
-bugs & non feature:
-- [ ] add tests
-- [ ] support dataclass (pending)
-
-### in analysis
-- [ ] click field to highlight links
-- [ ] animation effect for edges
-- [ ] customrized right click panel
-    - [ ] show own dependencies
-
-### plan:
-
 #### 0.9
 - [x] refactor: server.py
     - [x] rename create_app_with_fastapi -> create_voyager
@@ -196,19 +185,36 @@ bugs & non feature:
 - [x] improve initialization time cost
     - [x] query route / schema info through realtime api
     - [x] adjust fe
+- [x] adjust layout (0.9.3)
+    - [x] show field detail in right panel
+    - [x] show route info in bottom
 
 #### 0.10
-- [ ] logging information
-- [ ] open route in swagger
+- [ ] support opening route in swagger
     - config docs path
 - [ ] add http method for route
 - [ ] enable/disable module cluster  (may save space)
+- [ ] logging information
+- [ ] add tests
+- [ ] hide brief mode if not configured
+- [ ] optimize static resource
+- [ ] show route count in tag expansion item
+- [ ] route list show have a max height to trigger scrollable
+- [ ] fix layout issue when rendering huge graph
 
 #### 0.11
+- [ ] improve user experience
+    - double click to show detail
+    - improve search dialog
+
+#### 0.12
 - [ ] integration with pydantic-resolve
     - [ ] show hint for resolve, post fields
     - [ ] display loader as edges
 
+#### 0.13
+- [ ] config release pipeline
+- [ ]
 
 ## Using with pydantic-resolve
 
@@ -220,13 +226,25 @@ pydantic-resolve's @ensure_subset decorator is helpful to pick fields from `sour
 
 ## Credits
 
-- https://apis.guru/graphql-voyager/, for inspiration.
-- https://github.com/tintinweb/vscode-interactive-graphviz, for web visualization.
+- https://apis.guru/graphql-voyager/, thanks for inspiration.
+- https://github.com/tintinweb/vscode-interactive-graphviz, thanks for web visualization.
+
+
+## Dependencies
+
+- FastAPI
+- [pydantic-resolve](https://github.com/allmonday/pydantic-resolve)
+- Quasar
 
 
 ## Changelog
 
 - 0.9:
+    - 0.9.3:
+        - enhancement: better UI 
+    - 0.9.2:
+        - fix: missing fields in schema detail panel
+        - optimization: clean up fe codes.
     - 0.9.1:
         - api change: from `create_app_with_fastapi` to `create_voyager`, and expose as `from fastapi_voyager import create_voyager`
         - optimization: lazy load vscode link and source code, speed up the initialization.

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.9.1"
+__version__ = "0.9.3"

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/src/fastapi_voyager/web/component/route-code-display.js

@@ -3,14 +3,10 @@ const { defineComponent, ref, watch, onMounted } = window.Vue;
 // Component: RouteCodeDisplay
 // Props:
 //   routeId: route id key in routeItems
-//   modelValue: dialog visibility
-//   routes: object map { id: { id, name, source_code } }
 export default defineComponent({
   name: "RouteCodeDisplay",
   props: {
     routeId: { type: String, required: true },
-    modelValue: { type: Boolean, default: false },
-    routes: { type: Object, default: () => ({}) },
   },
   emits: ["close"],
   setup(props, { emit }) {
@@ -101,32 +97,26 @@ export default defineComponent({
       }
     }
 
-    watch(
-      () => props.modelValue,
-      (v) => {
-        if (v) load();
-      }
-    );
     watch(
       () => props.routeId,
       () => {
-        if (props.modelValue) load();
+        load();
       }
     );
 
     onMounted(() => {
-      if (props.modelValue) load();
+      load();
     });
 
     return { loading, code, error, close, link };
   },
   template: `
-  <div class="frv-route-code-display" style="border:1px solid #ccc; position:relative; width:50vw; max-width:50vw; height:100%; background:#fff;">
+  <div class="frv-route-code-display" style="border:1px solid #ccc; position:relative; background:#fff;">
     <q-btn dense flat round icon="close" @click="close" aria-label="Close" style="position:absolute; top:6px; right:6px; z-index:10; background:rgba(255,255,255,0.85)" />
     <div v-if="link" class="q-ml-md q-mt-md" style="padding-top:4px;">
       <a :href="link" target="_blank" rel="noopener" style="font-size:12px; color:#3b82f6;">Open in VSCode</a>
     </div>
-    <div style="padding:40px 16px 16px 16px; height:100%; box-sizing:border-box; overflow:auto;">
+    <div style="padding:40px 16px 16px 16px; box-sizing:border-box; overflow:auto;">
       <div v-if="loading" style="font-family:Menlo, monospace; font-size:12px;">Loading source...</div>
       <div v-else-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
       <pre v-else style="margin:0;"><code class="language-python">{{ code }}</code></pre>

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/src/fastapi_voyager/web/component/schema-code-display.js

@@ -13,23 +13,17 @@ export default defineComponent({
   name: "SchemaCodeDisplay",
   props: {
     schemaName: { type: String, required: true },
-    modelValue: { type: Boolean, default: false },
-    schemas: { type: Array, default: () => [] },
+    schemas: { type: Object, default: () => ({}) },
   },
-  emits: ["close"],
   setup(props, { emit }) {
-    const loading = ref(false);
     const code = ref("");
     const link = ref("");
     const error = ref("");
     const fields = ref([]); // schema fields list
     const tab = ref("source");
 
-    function close() {
-      emit("close");
-    }
 
-    function highlightLater() {
+    async function highlightLater() {
       // wait a tick for DOM update
       requestAnimationFrame(() => {
         try {
@@ -38,6 +32,10 @@ export default defineComponent({
               ".frv-code-display pre code.language-python"
             );
             if (block) {
+              // If already highlighted by highlight.js, remove the flag so it can be highlighted again
+              if (block.dataset && block.dataset.highlighted) {
+                block.removeAttribute("data-highlighted");
+              }
               window.hljs.highlightElement(block);
             }
           }
@@ -50,7 +48,6 @@ export default defineComponent({
     async function loadSource() {
       if (!props.schemaName) return;
 
-      loading.value = true;
       error.value = null;
       code.value = "";
       link.value = "";
@@ -77,7 +74,6 @@ export default defineComponent({
       } catch (e) {
         error.value = "Failed to load source";
       } finally {
-        loading.value = false;
       }
 
       try {
@@ -99,10 +95,12 @@ export default defineComponent({
       } catch (e) {
         error.value = "Failed to load source";
       } finally {
-        loading.value = false;
       }
 
-      if (!error.value && tab.value === "source") {
+      const schema = props.schemas && props.schemas[props.schemaName];
+      fields.value = Array.isArray(schema?.fields) ? schema.fields : [];
+
+      if (tab.value === "source") {
         highlightLater();
       }
     }
@@ -118,25 +116,21 @@ export default defineComponent({
     );
 
     watch(
-      () => props.modelValue,
-      (val) => {
-        if (val) {
-          loadSource();
-        }
-      }
+      () => props.schemaName,
+      () => {
+        loadSource();
+      },
     );
 
     onMounted(() => {
-      if (props.modelValue) loadSource();
+      loadSource();
     });
 
-    return { loading, link, code, error, close, fields, tab };
+    return { link, code, error, fields, tab };
   },
   template: `
-  <div class="frv-code-display" style="border: 1px solid #ccc; border-left: none; position:relative; width:40vw; max-width:40vw; height:100%; background:#fff;">
-			<q-btn dense flat round icon="close" @click="close" aria-label="Close"
-				style="position:absolute; top:6px; right:6px; z-index:10; background:rgba(255,255,255,0.85)" />
-      <div v-if="link" class="q-ml-md q-mt-md">
+  <div class="frv-code-display" style="border: 1px solid #ccc; border-left: none; position:relative; height:100%; background:#fff;">
+      <div class="q-ml-lg q-mt-md">
         <a :href="link" target="_blank" rel="noopener" style="font-size:12px; color:#3b82f6;">
           Open in VSCode
         </a>
@@ -150,8 +144,7 @@ export default defineComponent({
       </div>
       <q-separator />
       <div style="padding:8px 16px 16px 16px; height:75%; box-sizing:border-box; overflow:auto;">
-        <div v-if="loading" style="font-family:Menlo, monospace; font-size:12px;">Loading source...</div>
-        <div v-else-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
+        <div v-if="error" style="color:#c10015; font-family:Menlo, monospace; font-size:12px;">{{ error }}</div>
         <template v-else>
           <div v-show="tab === 'source'">
             <pre style="margin:0;"><code class="language-python">{{ code }}</code></pre>

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/src/fastapi_voyager/web/component/schema-field-filter.js

@@ -14,7 +14,8 @@ export default defineComponent({
   name: "SchemaFieldFilter",
   props: {
     schemaName: { type: String, default: null }, // external injection triggers auto-query
-    schemas: { type: Array, default: () => [] }, // externally provided schemas (state.rawSchemasFull or similar)
+    // externally provided schemas dict (state.rawSchemasFull): { [id]: schema }
+    schemas: { type: Object, default: () => ({}) },
   },
   emits: ["queried", "close"],
   setup(props, { emit }) {
@@ -39,9 +40,11 @@ export default defineComponent({
     let lastAppliedExternal = null;
 
     async function loadSchemas() {
-      // Refactored: use externally provided props.schemas directly; no network call.
+      // Use externally provided props.schemas dict directly; no network call.
       state.error = null;
-      state.schemas = Array.isArray(props.schemas) ? props.schemas : [];
+      const dict = props.schemas && typeof props.schemas === "object" ? props.schemas : {};
+      // Flatten to array for local operations
+      state.schemas = Object.values(dict);
       state.schemaOptions = state.schemas.map((s) => ({
         label: `${s.name} (${s.id})`,
         value: s.id,

{fastapi_voyager-0.9.1 → fastapi_voyager-0.9.3}/src/fastapi_voyager/web/graph-ui.js

@@ -69,23 +69,27 @@ export class GraphUI {
           const set = $();
           set.push(this);
           const obj = { set, direction: "bidirectional" };
-          // Shift+Click to trigger schema detail callback (if provided)
+
+          const schemaName = event.currentTarget.dataset.name;
           if (event.shiftKey && self.options.onSchemaClick) {
             // try data-name or title text
-            const schemaName = event.currentTarget.dataset.name;
             if (schemaName) {
               try {
-                self.options.onSchemaClick(schemaName);
+                self.options.onSchemaShiftClick(schemaName);
               } catch (e) {
-                console.warn("onSchemaClick callback failed", e);
+                console.warn("onSchemaShiftClick callback failed", e);
               }
             }
-          } else if (event.altKey && self.options.onSchemaAltClick) {
-            const schemaName = event.currentTarget.dataset.name;
-            self.options.onSchemaAltClick(schemaName);
           } else {
             self.currentSelection = [obj];
             self._highlight();
+            if (schemaName) {
+              try {
+                self.options.onSchemaClick(schemaName);
+              } catch (e) {
+                console.warn("onSchemaClick callback failed", e);
+              }
+            }
           }
         });