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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.2
+Version: 0.11.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
@@ -270,6 +270,8 @@ 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
+    - [x] support online repo url
+- 0.11.4
     - [ ] add loading for field detail panel
     - [ ] logging information
     - [ ] sort field name

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

@@ -241,6 +241,8 @@ 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
+    - [x] support online repo url
+- 0.11.4
     - [ ] add loading for field detail panel
     - [ ] logging information
     - [ ] sort field name

{fastapi_voyager-0.11.2 → fastapi_voyager-0.11.3}/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.3}/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.3}/src/fastapi_voyager/version.py

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

fastapi_voyager-0.11.3/tests/programatic.py

@@ -0,0 +1,10 @@
+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", 
+        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"}))