fastapi-voyager 0.11.2__tar.gz → 0.11.4__tar.gz

fastapi_voyager-0.11.4/.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.2 → fastapi_voyager-0.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.2
+Version: 0.11.4
 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
@@ -270,7 +270,10 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 0.11.2
     - [x] enable/disable module cluster  (to save space)
 - 0.11.3
-    - [ ] add loading for field detail panel
+    - [x] support online repo url
+- 0.11.4
+    - [x] add loading for field detail panel
+- 0.11.5
     - [ ] logging information
     - [ ] sort field name
     - [ ] set max limit for fields

{fastapi_voyager-0.11.2 → fastapi_voyager-0.11.4}/README.md

@@ -241,7 +241,10 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - 0.11.2
     - [x] enable/disable module cluster  (to save space)
 - 0.11.3
-    - [ ] add loading for field detail panel
+    - [x] support online repo url
+- 0.11.4
+    - [x] add loading for field detail panel
+- 0.11.5
     - [ ] logging information
     - [ ] sort field name
     - [ ] set max limit for fields

fastapi_voyager-0.11.4/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.2 → fastapi_voyager-0.11.4}/src/fastapi_voyager/server.py

@@ -41,6 +41,7 @@ def create_route(
 	module_color: dict[str, str] | None = None,
 	swagger_url: Optional[str] = None,
 	module_prefix: Optional[str] = None,
+	online_repo_url: Optional[str] = None,
 ):
 	"""
 	module_color: dict mapping module name to color string, e.g. {'models': 'lightblue'}
@@ -183,7 +184,7 @@ def create_route(
 			
 			mod = __import__(module_name, fromlist=[class_name])
 			obj = getattr(mod, class_name)
-			link = get_vscode_link(obj)
+			link = get_vscode_link(obj, online_repo_url=online_repo_url)
 			
 			return JSONResponse(content={"link": link})
 		except ImportError as e:
@@ -211,8 +212,14 @@ def create_voyager(
 	gzip_minimum_size: int | None = 500,
 	module_prefix: Optional[str] = None,
 	swagger_url: Optional[str] = None,
+	online_repo_url: Optional[str] = None,
 ) -> FastAPI:
-	router = create_route(target_app, module_color=module_color, module_prefix=module_prefix, swagger_url=swagger_url)
+	router = create_route(
+		target_app, 
+		module_color=module_color, 
+		module_prefix=module_prefix, 
+		swagger_url=swagger_url,
+		online_repo_url=online_repo_url)
 
 	app = FastAPI(title="fastapi-voyager demo server")
 	if gzip_minimum_size is not None and gzip_minimum_size >= 0:

{fastapi_voyager-0.11.2 → fastapi_voyager-0.11.4}/src/fastapi_voyager/type_helper.py

@@ -1,7 +1,7 @@
 import inspect
 import os
 from pydantic import BaseModel
-from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic
+from typing import get_origin, get_args, Union, Annotated, Any, Type, Generic, Optional
 from fastapi_voyager.type import FieldInfo
 from types import UnionType
 import pydantic_resolve.constant as const
@@ -182,7 +182,7 @@ def get_pydantic_fields(schema: type[BaseModel], bases_fields: set[str]) -> list
     return fields
 
 
-def get_vscode_link(kls):
+def get_vscode_link(kls, online_repo_url: Optional[str] = None) -> str:
     """Build a VSCode deep link to the class definition.
 
     Priority:
@@ -197,6 +197,10 @@ def get_vscode_link(kls):
         _lines, start_line = inspect.getsourcelines(kls)
 
         distro = os.environ.get("WSL_DISTRO_NAME")
+        if online_repo_url:
+            cwd = os.getcwd()
+            relative_path = os.path.relpath(source_file, cwd)
+            return f"{online_repo_url}/{relative_path}#L{start_line}"
         if distro:
             # Ensure absolute path (it should already be under /) and build remote link
             return f"vscode://vscode-remote/wsl+{distro}{source_file}:{start_line}"

{fastapi_voyager-0.11.2 → fastapi_voyager-0.11.4}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.11.2"
+__version__ = "0.11.4"

{fastapi_voyager-0.11.2 → fastapi_voyager-0.11.4}/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.4/tests/programatic.py

@@ -0,0 +1,11 @@
+from fastapi_voyager import create_voyager
+from tests.demo import app
+
+app.mount(
+    '/voyager', 
+    create_voyager(
+        app, 
+        module_color={"tests.service": "red"}, 
+        module_prefix="tests.service", 
+        swagger_url="/docs",
+        online_repo_url="https://github.com/allmonday/fastapi-voyager/blob/main"))

fastapi_voyager-0.11.2/tests/programatic.py

@@ -1,5 +0,0 @@
-from fastapi_voyager import create_voyager
-from tests.demo import app
-
-app.mount('/voyager', create_voyager(app, module_color={"tests.service": "red"}, module_prefix="tests.service", swagger_url='/docs'))
-# app.mount('/voyager', create_voyager(app, module_color={"tests.service": "red"}))