lightning-pose-app 2.0.4__tar.gz → 2.0.4.1__tar.gz

{lightning_pose_app-2.0.4 → lightning_pose_app-2.0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lightning-pose-app
-Version: 2.0.4
+Version: 2.0.4.1
 Summary: 
 Requires-Python: >=3.10
 Classifier: Programming Language :: Python :: 3

{lightning_pose_app-2.0.4 → lightning_pose_app-2.0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "lightning-pose-app"
-version = "2.0.4"
+version = "2.0.4.1"
 requires-python = ">=3.10"
 dependencies = [
     "aiofiles~=24.1.0",

{lightning_pose_app-2.0.4 → lightning_pose_app-2.0.4.1}/src/litpose_app/main.py

@@ -9,16 +9,18 @@ from textwrap import dedent
 
 import anyio
 import uvicorn
-from fastapi import FastAPI, HTTPException, APIRouter, Request
-from fastapi.responses import FileResponse
+from fastapi import FastAPI, HTTPException, APIRouter, Request, Depends
+from fastapi.responses import FileResponse, HTMLResponse
 from starlette import status
 from starlette.responses import Response
 from starlette.staticfiles import StaticFiles
 
 from . import deps
+from .rootconfig import RootConfig
 from .routes.labeler.multiview_autolabel import warm_up_anipose
 from .routes.videos import cleanup_old_uploads
 from .train_scheduler import _train_scheduler_process_target
+from .utils.check_for_upgrade import check_for_upgrade
 from .utils.file_response import file_response
 
 ## Setup logging
@@ -191,11 +193,42 @@ async def favicon():
 
 # Catch-all route. serve index.html.
 @app.get("/{full_path:path}")
-async def index():
-    return FileResponse(
-        Path(__file__).parent / "ngdist" / "ng_app" / "browser" / "index.html"
-    )
+def index(rc: RootConfig = Depends(deps.root_config)):
+    index_path = Path(__file__).parent / "ngdist" / "ng_app" / "browser" / "index.html"
+    content = index_path.read_text(encoding="utf-8")
+    analytics_tag_placeholder = "<!-- ANALYTICS_TAG_PLACEHOLDER -->"
+    assert analytics_tag_placeholder in content
+
+    # Skip analytics tag insertion if DO_NOT_TRACK is set
+    import os
+
+    if os.environ.get("DO_NOT_TRACK") != "1":
+        content = content.replace(analytics_tag_placeholder, rc.UMAMI_ANALYTICS_TAG)
+
+    return HTMLResponse(content=content)
 
 
 def run_app(host: str, port: int):
+    import os
+
+    if os.environ.get("DO_NOT_TRACK") != "1":
+        usage_message = dedent(
+            """
+            ================================================================================
+            📊  Lightning Pose App Usage Tracking
+            
+            To help us improve this tool and secure future grant funding, launching the app
+            in your browser will initiate privacy-focused web event tracking. We use Umami,
+            which ensures no personal data is ever collected or stored.
+            
+            To opt out, please restart the app with the environment variable DO_NOT_TRACK=1
+            For example: DO_NOT_TRACK=1 litpose run_app
+            ================================================================================
+            """
+        )
+        print(usage_message, file=sys.stderr)
+    else:
+        logger.info("App tracking is opted out, skipping analytics tag insertion")
+
+    check_for_upgrade()
     uvicorn.run(app, host=host, port=port, timeout_graceful_shutdown=1)

{lightning_pose_app-2.0.4 → lightning_pose_app-2.0.4.1}/src/litpose_app/ngdist/ng_app/browser/index.html

@@ -301,6 +301,7 @@
   -webkit-font-smoothing: antialiased;
 }
 </style>
+    <!-- ANALYTICS_TAG_PLACEHOLDER -->
   <style>
 @layer properties;
 @layer theme, base, components, utilities;

{lightning_pose_app-2.0.4 → lightning_pose_app-2.0.4.1}/src/litpose_app/rootconfig.py

@@ -16,6 +16,11 @@ class RootConfig(BaseSettings):
         default_factory=lambda data: data["LP_SYSTEM_DIR"] / "uploads"
     )
 
+    UMAMI_ANALYTICS_TAG: str = (
+        '<script defer src="https://cloud.umami.is/script.js" '
+        'data-website-id="ba9731f2-f746-4c4e-8fc6-d876e1556a6e"></script>'
+    )
+
     @model_validator(mode="after")
     def init_dirs_and_files(self):
         """Creates directories as needed on application startup"""

lightning_pose_app-2.0.4.1/src/litpose_app/utils/check_for_upgrade.py

@@ -0,0 +1,49 @@
+import logging
+import os
+import sys
+from textwrap import dedent
+
+logger = logging.getLogger(__name__)
+
+
+def check_for_upgrade():
+    if os.environ.get("LP_IGNORE_UPGRADE") == "1":
+        logger.info(f"LP_IGNORE_UPGRADE=1 present, Skipping upgrade check ")
+        return
+
+    import json
+    import urllib.request
+    from packaging import version
+    import importlib.metadata
+
+    package_name = "lightning-pose-app"
+    try:
+        current_version = importlib.metadata.version(package_name)
+        # Fetch latest version from PyPI
+        with urllib.request.urlopen(
+            f"https://pypi.org/pypi/{package_name}/json", timeout=5
+        ) as response:
+            data = json.load(response)
+            latest_version = data["info"]["version"]
+
+        if version.parse(latest_version) > version.parse(current_version):
+            print(
+                dedent(
+                    f"""
+                {'-' * 80}
+                🚀 A new version of {package_name} is available: {latest_version} (current: {current_version})
+                
+                To upgrade, run:
+                    pip install --upgrade {package_name}
+
+                To skip this check in the future, use the LP_IGNORE_UPGRADE env variable:
+                    LP_IGNORE_UPGRADE=1 litpose run_app
+                {'-' * 80}
+            """
+                )
+            )
+
+            sys.exit(0)
+    except Exception as e:
+        # Don't block startup if PyPI is down or package isn't installed via pip
+        logger.debug(f"Upgrade check failed: {e}")