PyPI - fastapi-voyager - Versions diffs - 0.12.1__tar.gz → 0.12.2__tar.gz - Mend

fastapi-voyager 0.12.1tar.gz → 0.12.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.12.1
+Version: 0.12.2
 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
@@ -40,6 +40,10 @@ Visualize your FastAPI endpoints, and explore them interactively.
 <img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
+## Plan & Raodmap
+- [ideas](./docs/idea.md)
+- [changelog & roadmap](./docs/changelog.md)
 ## Installation
 ```bash
@@ -176,8 +180,3 @@ backend:
 - `voyager.py`: main entry
 - `render.py`: generate dot file
 - `server.py`: serve mode
-## Plan & Raodmap
-- [ideas](./docs/idea.md)
-- [changelog & roadmap](./docs/changelog.md)

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/README.md RENAMED Viewed

@@ -11,6 +11,10 @@ Visualize your FastAPI endpoints, and explore them interactively.
 <img width="1600" height="986" alt="image" src="https://github.com/user-attachments/assets/8829cda0-f42d-4c84-be2f-b019bb5fe7e1" />
+## Plan & Raodmap
+- [ideas](./docs/idea.md)
+- [changelog & roadmap](./docs/changelog.md)
 ## Installation
 ```bash
@@ -147,8 +151,3 @@ backend:
 - `voyager.py`: main entry
 - `render.py`: generate dot file
 - `server.py`: serve mode
-## Plan & Raodmap
-- [ideas](./docs/idea.md)
-- [changelog & roadmap](./docs/changelog.md)

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/docs/changelog.md RENAMED Viewed

@@ -106,6 +106,8 @@
     - [x] optimize dbclick style
     - [x] persist the tag/ route in url
 - 0.12.2
+    - [x] add google analytics
+- 0.12.3
     - [ ] search tag/ route
     - [ ] refactor render.py
     - [ ] reorg: move variable into reactive in vue-main.js

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/src/fastapi_voyager/server.py RENAMED Viewed

@@ -6,7 +6,7 @@ from pydantic import BaseModel
 from fastapi.responses import HTMLResponse, PlainTextResponse, JSONResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi_voyager.voyager import Voyager
-from fastapi_voyager.type import Tag, FieldInfo, CoreData, SchemaNode
+from fastapi_voyager.type import Tag, CoreData, SchemaNode
 from fastapi_voyager.render import Renderer
 from fastapi_voyager.type_helper import get_source, get_vscode_link
 from fastapi_voyager.version import __version__
@@ -15,6 +15,22 @@ from fastapi_voyager.version import __version__
 WEB_DIR = Path(__file__).parent / "web"
 WEB_DIR.mkdir(exist_ok=True)
+GA_PLACEHOLDER = "<!-- GA_SNIPPET -->"
+def _build_ga_snippet(ga_id: Optional[str]) -> str:
+	if not ga_id:
+		return ""
+	return f"""    <script async src="https://www.googletagmanager.com/gtag/js?id={ga_id}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){{dataLayer.push(arguments);}}
+      gtag('js', new Date());
+      gtag('config', '{ga_id}');
+    </script>
+"""
 INITIAL_PAGE_POLICY = Literal['first', 'full', 'empty']
 class OptionParam(BaseModel):
@@ -46,6 +62,7 @@ def create_voyager(
 	swagger_url: Optional[str] = None,
 	online_repo_url: Optional[str] = None,
 	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
+	ga_id: Optional[str] = None,
 ) -> FastAPI:
 	router = APIRouter(tags=['fastapi-voyager'])
@@ -116,7 +133,8 @@ def create_voyager(
 	def index():
 		index_file = WEB_DIR / "index.html"
 		if index_file.exists():
-			return index_file.read_text(encoding="utf-8")
+			content = index_file.read_text(encoding="utf-8")
+			return content.replace(GA_PLACEHOLDER, _build_ga_snippet(ga_id))
 		# fallback simple page if index.html missing
 		return """
 		<!doctype html>

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/src/fastapi_voyager/version.py RENAMED Viewed

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.12.1"
+__version__ = "0.12.2"

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/src/fastapi_voyager/web/index.html RENAMED Viewed

@@ -477,5 +477,7 @@
       });
     </script>
     <script type="module" src="fastapi-voyager-static/vue-main.js"></script>
+    <!-- GA_SNIPPET -->
   </body>
 </html>

{fastapi_voyager-0.12.1 → fastapi_voyager-0.12.2}/tests/programatic.py RENAMED Viewed

@@ -9,4 +9,5 @@ app.mount(
         module_prefix="tests.service",
         swagger_url="/docs",
         initial_page_policy='first',
+        ga_id='G-R64S7Q49VL',
         online_repo_url="https://github.com/allmonday/fastapi-voyager/blob/main"))