fastapi-voyager 0.7.4__tar.gz → 0.7.6__tar.gz

{fastapi_voyager-0.7.4 → fastapi_voyager-0.7.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.7.4
+Version: 0.7.6
 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
@@ -44,6 +44,9 @@ pip install fastapi-voyager
 uv add fastapi-voyager
 ```
 
+```shell
+voyager -m path.to.your.app.module --server
+```
 
 ## Dependencies
 
@@ -98,6 +101,18 @@ click a node to highlight it's upperstream and downstream nodes. figure out the
 <img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
 
 
+## Mount to target project
+
+```python
+from fastapi import FastAPI
+from fastapi_voyager.server import create_app_with_fastapi
+from tests.demo import app
+
+app.mount('/voyager', create_app_with_fastapi(app))
+```
+
+more about [sub application](https://fastapi.tiangolo.com/advanced/sub-applications/?h=sub)
+
 
 ## Command Line Usage
 
@@ -170,9 +185,11 @@ features:
 - [ ] click field to highlight links
 - [ ] user can generate nodes/edges manually and connect to generated ones
     - [ ] add owner
+    - [ ] add extra info for schema
 - [ ] ui optimization
     - [ ] fixed left/right bar show field information
-- [ ] display standard ER diagram `difficult`
+    - [x] fixed left bar show tag/ route
+- [ ] display standard ER diagram `difference`
     - [ ] display potential invalid links
 - [ ] integration with pydantic-resolve
     - [ ] show difference between resolve, post fields
@@ -185,8 +202,8 @@ features:
 bugs & non feature:
 - [x] fix duplicated link from class and parent class, it also break clicking highlight
 - [ ] add tests
-- [ ] refactor
-    - [ ] abstract render module
+- [x] refactor
+    - [x] abstract render module
 
 ## Using with pydantic-resolve
 
@@ -204,6 +221,8 @@ TODO: ...
 ## Changelog
 
 - 0.7:
+    - 0.7.5
+        - fix show all display issue
     - 0.7.4
         - optimize tag/route, move to left. 
         - fresh on change, no need to click generate any more.

{fastapi_voyager-0.7.4 → fastapi_voyager-0.7.6}/README.md

@@ -17,6 +17,9 @@ pip install fastapi-voyager
 uv add fastapi-voyager
 ```
 
+```shell
+voyager -m path.to.your.app.module --server
+```
 
 ## Dependencies
 
@@ -71,6 +74,18 @@ click a node to highlight it's upperstream and downstream nodes. figure out the
 <img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
 
 
+## Mount to target project
+
+```python
+from fastapi import FastAPI
+from fastapi_voyager.server import create_app_with_fastapi
+from tests.demo import app
+
+app.mount('/voyager', create_app_with_fastapi(app))
+```
+
+more about [sub application](https://fastapi.tiangolo.com/advanced/sub-applications/?h=sub)
+
 
 ## Command Line Usage
 
@@ -143,9 +158,11 @@ features:
 - [ ] click field to highlight links
 - [ ] user can generate nodes/edges manually and connect to generated ones
     - [ ] add owner
+    - [ ] add extra info for schema
 - [ ] ui optimization
     - [ ] fixed left/right bar show field information
-- [ ] display standard ER diagram `difficult`
+    - [x] fixed left bar show tag/ route
+- [ ] display standard ER diagram `difference`
     - [ ] display potential invalid links
 - [ ] integration with pydantic-resolve
     - [ ] show difference between resolve, post fields
@@ -158,8 +175,8 @@ features:
 bugs & non feature:
 - [x] fix duplicated link from class and parent class, it also break clicking highlight
 - [ ] add tests
-- [ ] refactor
-    - [ ] abstract render module
+- [x] refactor
+    - [x] abstract render module
 
 ## Using with pydantic-resolve
 
@@ -177,6 +194,8 @@ TODO: ...
 ## Changelog
 
 - 0.7:
+    - 0.7.5
+        - fix show all display issue
     - 0.7.4
         - optimize tag/route, move to left. 
         - fresh on change, no need to click generate any more.

{fastapi_voyager-0.7.4 → fastapi_voyager-0.7.6}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.7.4"
+__version__ = "0.7.6"

{fastapi_voyager-0.7.4 → fastapi_voyager-0.7.6}/src/fastapi_voyager/web/index.html

@@ -88,6 +88,9 @@
         "
       >
         <div class="row items-center q-col-gutter-md">
+          <div class="col-auto">
+            <div style="width: 282px; margin-left: 8px;" class="text-h6">FastAPI Voyager</div>
+          </div>
           <div class="col-auto">
             <div class="column">
               <q-option-group
@@ -102,7 +105,7 @@
           </div>
 
           <div class="col-auto">
-            <q-toggle v-model="state.brief" label="Brief" dense />
+            <q-toggle class="q-ml-md" v-model="state.brief" label="Brief Mode" title="config module_prefix to enable it" dense />
           </div>
 
           <!-- <div class="col-auto">
@@ -167,7 +170,7 @@
           </div>
         </div>
       </div>
-      <div class="row no-wrap" style="flex: 1 1 auto; min-height: 0">
+      <div class="row no-wrap" style="flex: 1 1 auto; min-height: 0; height: 100px;">
         <div
           class="column no-wrap"
           :style="{
@@ -184,15 +187,14 @@
                 v-for="tag in state.rawTags"
                 :key="tag.name"
                 expand-separator
-                switch-toggle-side
                 :model-value="state.tag === tag.name"
                 @update:model-value="(val) => toggleTag(tag.name, val)"
-                :header-class="state.tag === tag.name ? 'bg-primary text-white text-weight-medium' : 'text-weight-medium'"
+                :header-class="state.tag === tag.name ? 'text-primary text-bold' : ''"
                 content-class="q-pa-none"
               >
                 <template #header>
-                  <div class="row items-center no-wrap" style="width: 100%">
-                    <div class="col text-body2">{{ tag.name }}</div>
+                  <div class="row items-center" style="width: 100%">
+                    <div class="">{{ tag.name }}</div>
                   </div>
                 </template>
 
@@ -206,7 +208,9 @@
                     active-class=""
                     @click="selectRoute(route.id)"
                   >
-                    <q-item-section>{{ route.name }}</q-item-section>
+                    <q-item-section>
+                      <span class="q-ml-sm"> {{ route.name }} </span>
+                      </q-item-section>
                   </q-item>
                   <q-item v-if="!tag.routes || tag.routes.length === 0" dense>
                     <q-item-section class="text-grey-6">No routes</q-item-section>

{fastapi_voyager-0.7.4 → fastapi_voyager-0.7.6}/src/fastapi_voyager/web/vue-main.js

@@ -51,20 +51,6 @@ const app = createApp({
       showDetail.value = false;
     }
 
-    const skipNextRouteGenerate = ref(false);
-
-    function applyRoutesForTag(tagName) {
-      const tag = state.rawTags.find((t) => t.name === tagName);
-      state.routeOptions = [];
-      if (tag && Array.isArray(tag.routes)) {
-        state.routeOptions.push(
-          ...tag.routes.map((r) => ({ label: r.name, value: r.id }))
-        );
-      }
-      skipNextRouteGenerate.value = true;
-      state.routeId = "";
-    }
-
     function onFilterTags(val, update) {
       const normalized = (val || "").toLowerCase();
       update(() => {
@@ -257,28 +243,16 @@ const app = createApp({
     }
 
     function selectRoute(routeId) {
-      state.routeId = state.routeId === routeId ? "" : routeId;
+      state.routeId = routeId
+      onGenerate()
     }
 
     // react to tag changes to rebuild routes
     watch(
       () => state.tag,
       (val) => {
-        applyRoutesForTag(val);
-        if (!state.initializing) {
-          onGenerate();
-        }
-      }
-    );
-
-    watch(
-      () => state.routeId,
-      () => {
-        if (skipNextRouteGenerate.value) {
-          skipNextRouteGenerate.value = false;
-          return;
-        }
         if (!state.initializing) {
+          state.routeId = ''
           onGenerate();
         }
       }