fastapi-voyager 0.11.3__tar.gz → 0.11.5__tar.gz

fastapi_voyager-0.11.5/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI via uv
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build the package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --token ${{ secrets.PYPI_PUBLISHER }}

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.3
+Version: 0.11.5
 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
@@ -45,8 +45,7 @@ interactively !!
 
 [visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
-<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>
+<img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
 
 ## Installation
 
@@ -97,32 +96,25 @@ voyager -m tests.demo
            --module_color=tests.demo:tomato
 ```
 
-### generate the graph
-after initialization, pick tag, rotue to render graph
-
-<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.
 
-<img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
+<img width="1100" height="700" alt="image" src="https://github.com/user-attachments/assets/3e0369ea-5fa4-469a-82c1-ed57d407e53d" />
 
-### filter related nodes
-`shift` click a node to check related node, pick a field to narrow the result, picked node is marked as red.
+### focus on nodes
+toggle focus to hide nodes not related with current picked one.
 
-<img width="1423" height="552" alt="image" src="https://github.com/user-attachments/assets/468a058d-afa1-4601-a7c5-c6aad6a8a557" />
+before: 
+<img width="1066" height="941" alt="image" src="https://github.com/user-attachments/assets/39f30817-899a-4289-93f4-a1646d3441c1" />
+after:
+<img width="1061" height="937" alt="image" src="https://github.com/user-attachments/assets/79709b02-7571-43fc-abc9-17a287a97515" />
 
 ### view source code
-`alt` click a node to show source code or open file in vscode.
-
-<img width="1049" height="694" alt="image" src="https://github.com/user-attachments/assets/7839ac83-8d60-44ad-b1c9-9652a76339b1" />
-
-<img width="1042" height="675" alt="image" src="https://github.com/user-attachments/assets/38ae705f-5982-4a02-9c3f-038b1d00bcf6" />
-
-`alt` click a route to show source code or open file in vscode
-
-<img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
+double click a node to show source code or open file in vscode.
+<img width="1297" height="940" alt="image" src="https://github.com/user-attachments/assets/c8bb2e7d-b727-42a6-8c9e-64dce297d2d8" />
 
+double click a route to show source code or open file in vscode
+<img width="1132" height="824" alt="image" src="https://github.com/user-attachments/assets/b706e879-e4fc-48dd-ace1-99bf97e3ed6a" />
 
 
 
@@ -272,7 +264,12 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 0.11.3
     - [x] support online repo url
 - 0.11.4
-    - [ ] add loading for field detail panel
+    - [x] add loading for field detail panel
+- 0.11.5
+    - [x] optimize open in swagger link
+    - [x] change jquery cdn
+- 0.11.6
+    - [ ] flag of loading full graph in first render or not
     - [ ] logging information
     - [ ] sort field name
     - [ ] set max limit for fields

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/README.md

@@ -16,8 +16,7 @@ interactively !!
 
 [visit online demo](https://www.newsyeah.fun/voyager/) of project: [composition oriented development pattern](https://github.com/allmonday/composition-oriented-development-pattern)
 
-<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>
+<img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
 
 ## Installation
 
@@ -68,32 +67,25 @@ voyager -m tests.demo
            --module_color=tests.demo:tomato
 ```
 
-### generate the graph
-after initialization, pick tag, rotue to render graph
-
-<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.
 
-<img width="1485" height="616" alt="image" style="border: 1px solid #aaa" src="https://github.com/user-attachments/assets/70c4095f-86c7-45da-a6f0-fd41ac645813" />
+<img width="1100" height="700" alt="image" src="https://github.com/user-attachments/assets/3e0369ea-5fa4-469a-82c1-ed57d407e53d" />
 
-### filter related nodes
-`shift` click a node to check related node, pick a field to narrow the result, picked node is marked as red.
+### focus on nodes
+toggle focus to hide nodes not related with current picked one.
 
-<img width="1423" height="552" alt="image" src="https://github.com/user-attachments/assets/468a058d-afa1-4601-a7c5-c6aad6a8a557" />
+before: 
+<img width="1066" height="941" alt="image" src="https://github.com/user-attachments/assets/39f30817-899a-4289-93f4-a1646d3441c1" />
+after:
+<img width="1061" height="937" alt="image" src="https://github.com/user-attachments/assets/79709b02-7571-43fc-abc9-17a287a97515" />
 
 ### view source code
-`alt` click a node to show source code or open file in vscode.
-
-<img width="1049" height="694" alt="image" src="https://github.com/user-attachments/assets/7839ac83-8d60-44ad-b1c9-9652a76339b1" />
-
-<img width="1042" height="675" alt="image" src="https://github.com/user-attachments/assets/38ae705f-5982-4a02-9c3f-038b1d00bcf6" />
-
-`alt` click a route to show source code or open file in vscode
-
-<img width="882" height="445" alt="image" src="https://github.com/user-attachments/assets/158560ef-63ca-4991-9b7d-587be4fa04e4" />
+double click a node to show source code or open file in vscode.
+<img width="1297" height="940" alt="image" src="https://github.com/user-attachments/assets/c8bb2e7d-b727-42a6-8c9e-64dce297d2d8" />
 
+double click a route to show source code or open file in vscode
+<img width="1132" height="824" alt="image" src="https://github.com/user-attachments/assets/b706e879-e4fc-48dd-ace1-99bf97e3ed6a" />
 
 
 
@@ -243,7 +235,12 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 0.11.3
     - [x] support online repo url
 - 0.11.4
-    - [ ] add loading for field detail panel
+    - [x] add loading for field detail panel
+- 0.11.5
+    - [x] optimize open in swagger link
+    - [x] change jquery cdn
+- 0.11.6
+    - [ ] flag of loading full graph in first render or not
     - [ ] logging information
     - [ ] sort field name
     - [ ] set max limit for fields

fastapi_voyager-0.11.5/release.md

@@ -0,0 +1,8 @@
+release by pushing the tag
+
+```shell
+git tag v1.0.0
+git push origin v1.0.0
+```
+
+ 

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.11.3"
+__version__ = "0.11.5"

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/src/fastapi_voyager/web/component/schema-code-display.js

@@ -14,6 +14,8 @@ export default defineComponent({
   props: {
     schemaName: { type: String, required: true },
     schemas: { type: Object, default: () => ({}) },
+    // visibility from parent (e.g., dialog v-model)
+    modelValue: { type: Boolean, default: true },
   },
   setup(props, { emit }) {
     const code = ref("");
@@ -21,6 +23,7 @@ export default defineComponent({
     const error = ref("");
     const fields = ref([]); // schema fields list
     const tab = ref("fields");
+    const loading = ref(false);
 
 
     async function highlightLater() {
@@ -45,12 +48,22 @@ export default defineComponent({
       });
     }
 
+    function resetState() {
+      code.value = "";
+      link.value = "";
+      error.value = null;
+      fields.value = [];
+      // tab.value = "fields";
+      loading.value = true;
+    }
+
     async function loadSource() {
       if (!props.schemaName) return;
 
       error.value = null;
       code.value = "";
       link.value = "";
+      loading.value = true;
 
       // try to fetch from server: /source/{schema_name}
       const payload = { schema_name: props.schemaName };
@@ -71,13 +84,8 @@ export default defineComponent({
         } else {
           error.value = (data && data.error) || "Failed to load source";
         }
-      } catch (e) {
-        error.value = "Failed to load source";
-      } finally {
-      }
 
-      try {
-        const resp = await fetch(`vscode-link`, {
+        const resp2 = await fetch(`vscode-link`, {
           method: "POST",
           headers: {
             Accept: "application/json",
@@ -85,16 +93,16 @@ export default defineComponent({
           },
           body: JSON.stringify(payload),
         });
-        // surface server-side validation message for bad request
-        const data = await resp.json().catch(() => ({}));
-        if (resp.ok) {
-          link.value = data.link || "// no vscode link available";
+        const data2 = await resp2.json().catch(() => ({}));
+        if (resp2.ok) {
+          link.value = data2.link || "// no vscode link available";
         } else {
-          error.value += (data && data.error) || "Failed to load source";
+          error.value = (error.value || "") + ((data2 && data2.error) || "Failed to load source");
         }
       } catch (e) {
         error.value = "Failed to load source";
       } finally {
+        loading.value = false;
       }
 
       const schema = props.schemas && props.schemas[props.schemaName];
@@ -118,18 +126,36 @@ export default defineComponent({
     watch(
       () => props.schemaName,
       () => {
+        resetState();
         loadSource();
       },
     );
 
+    // respond to visibility changes: when shown, clear old data and reload
+    watch(
+      () => props.modelValue,
+      (val) => {
+        if (val) {
+          resetState();
+          loadSource();
+        }
+      }
+    );
+
     onMounted(() => {
-      loadSource();
+      if (props.modelValue) {
+        resetState();
+        loadSource();
+      }
     });
 
-    return { link, code, error, fields, tab };
+    return { link, code, error, fields, tab, loading };
   },
   template: `
   <div class="frv-code-display" style="border: 1px solid #ccc; border-left: none; position:relative; height:100%; background:#fff;">
+      <div v-show="loading" style="position:absolute; top:0; left:0; right:0; z-index:10;">
+        <q-linear-progress indeterminate color="primary" size="2px"/>
+      </div>
       <div class="q-ml-lg q-mt-md">
         <a :href="link" target="_blank" rel="noopener" style="font-size:12px; color:#3b82f6;">
           Open in VSCode

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/src/fastapi_voyager/web/index.html

@@ -218,9 +218,9 @@
                               class="q-mr-sm"
                               :name="state.tag == tag.name ? 'folder' : 'folder_open'"
                             ></q-icon>
-                            <span>{{ tag.name }} <q-chip style="position:relative; top: -1px;" class="q-ml-sm" dense>{{ tag.routes.length }}</q-chip></span>
-                            <a target="_blank" class="q-ml-sm" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name">
-                              <q-icon size="small" name="link"></q-icon>
+                            <span>{{ tag.name }} <q-chip style="position:relative; top: -1px;" class="q-ml-md" dense>{{ tag.routes.length }}</q-chip></span>
+                            <a v-if="state._tag == tag.name" target="_blank" class="q-ml-sm" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name">
+                              <q-icon color="primary" size="" name="link" title="open in swagger"></q-icon>
                             </a>
                         </div>
                       </template>
@@ -241,8 +241,8 @@
                                   name="data_object"
                                 ></q-icon>
                                 {{ route.name }}
-                                <a target="_blank" class="q-ml-sm" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name + '/' + route.unique_id">
-                                  <q-icon size="small" name="link"></q-icon>
+                                <a v-if="state.routeId == route.id" target="_blank" class="q-ml-md" v-if="state.swaggerUrl" :href="state.swaggerUrl + '#/' + tag.name + '/' + route.unique_id">
+                                  <q-icon color="primary" size="" name="link" title="open in swagger"></q-icon>
                                 </a>
                               </span>
                             </q-item-section>
@@ -411,10 +411,7 @@
       </q-dialog>
     </div>
 
-    <script
-      type="text/javascript"
-      src="https://code.jquery.com/jquery-2.1.3.min.js"
-    ></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.3/jquery.min.js" integrity="sha512-egJ/Y+22P9NQ9aIyVCh0VCOsfydyn8eNmqBy+y2CnJG+fpRIxXMS6jbWP8tVKp0jp+NO5n8WtMUAnNnGoJKi4w==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
     <script
       src="https://cdnjs.cloudflare.com/ajax/libs/d3/7.9.0/d3.min.js"
       integrity="sha512-vc58qvvBdrDR4etbxMdlTt4GBQk1qjvyORR2nrsPsFPyrs+/u5c3+1Ct6upOgdZoIl7eq6k3a1UPDSNAQi/32A=="
@@ -422,7 +419,7 @@
       referrerpolicy="no-referrer"
     ></script>
     <script src="https://unpkg.com/@hpcc-js/wasm@2.20.0/dist/graphviz.umd.js"></script>
-    <script src="https://unpkg.com/d3-graphviz@5.6.0/build/d3-graphviz.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/d3-graphviz/5.6.0/d3-graphviz.min.js" integrity="sha512-Le8HpIpS2Tc7SDHLM6AOgAKq6ZR4uDwLhjPSR20DtXE5dFb9xECHRwgpc1nxxnU0Dv+j6FNMoSddky5gyvI3lQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-mousewheel/3.1.13/jquery.mousewheel.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-color/2.1.2/jquery.color.min.js"></script>
 

{fastapi_voyager-0.11.3 → fastapi_voyager-0.11.5}/tests/programatic.py

@@ -7,4 +7,5 @@ app.mount(
         app, 
         module_color={"tests.service": "red"}, 
         module_prefix="tests.service", 
+        swagger_url="/docs",
         online_repo_url="https://github.com/allmonday/fastapi-voyager/blob/main"))