lightning-pose-app 1.8.1a2__py3-none-any.whl → 1.8.1a4__py3-none-any.whl

lightning_pose_app-1.8.1a4.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.3
+Name: lightning-pose-app
+Version: 1.8.1a4
+Summary: 
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Requires-Dist: fastapi (>=0.115.0,<0.116.0)
+Requires-Dist: honcho (>=2.0,<3.0)
+Requires-Dist: httpx (>=0.28.0,<0.29.0) ; extra == "dev"
+Requires-Dist: pytest (>=8.4.0,<8.5.0) ; extra == "dev"
+Requires-Dist: pytest-mock (>=3.14.0,<3.15.0) ; extra == "dev"
+Requires-Dist: tomli (>=2.2.0,<2.3.0)
+Requires-Dist: tomli_w (>=1.2.0,<1.3.0)
+Requires-Dist: uvicorn[standard] (>=0.34.0,<0.35.0)
+Requires-Dist: wcmatch (>=10.0,<11.0)

lightning_pose_app-1.8.1a4.dist-info/RECORD

@@ -0,0 +1,29 @@
+litpose_app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litpose_app/config.py,sha256=6ZqU71kILT6q1IdYgvYKthYQa2cY9nMwgHeRih24F6s,861
+litpose_app/deps.py,sha256=P0o762ufSW-9nqlpYPRtlrxpKBJMzPZ1LLfTDfTl-4U,2552
+litpose_app/main.py,sha256=ftSNNRnToLN_DpRb_EfgarrxWhDmMsMX2fku4qNrzAU,5397
+litpose_app/ngdist/ng_app/3rdpartylicenses.txt,sha256=8IgJBztx-L-9cLvY7pJB5PSXQJiBowGNUNV7knEAeq0,25355
+litpose_app/ngdist/ng_app/app.component-UAQUAGNZ.css.map,sha256=e6lXWzmK3xppKK3tXHUccK1yGZqd1kzyTpDH0F1nC2g,344
+litpose_app/ngdist/ng_app/error-dialog.component-HYLQSJEP.css.map,sha256=zJuF-LfB994Y1IrnIz38mariDFb8yucffbWPXgHGbvw,355
+litpose_app/ngdist/ng_app/favicon.ico,sha256=QtbXVfx3HI-WqWh_kkBIQyYzJsDmLw_3Y4_UN7pBepE,15406
+litpose_app/ngdist/ng_app/index.html,sha256=y1By3uv-f39NnrfG7hmIPhzC0f0FEDY0U70oqmU6NlQ,23004
+litpose_app/ngdist/ng_app/main-VCJFCLFP.js,sha256=qKG_Ev1-OoVeTeqIVv9DKN8YmfIp2zn6-gBUNFVW__4,2725077
+litpose_app/ngdist/ng_app/main-VCJFCLFP.js.map,sha256=f68Eh0pGhxR0Ol3rkdj4ifPljiw-rnv4JgFBWXsdDmA,5561146
+litpose_app/ngdist/ng_app/prerendered-routes.json,sha256=p53cyKEVGQ6cGUee02kUdBp9HbdPChFTUp78gHJVBf4,18
+litpose_app/ngdist/ng_app/project-settings.component-HKHIVUJR.css.map,sha256=v5tyba9p8ec3ZbHYyyUGTEFdEAsqT0l7JqtGRGjki6w,371
+litpose_app/ngdist/ng_app/styles-ZM27COY6.css,sha256=3bpOGHzSsXAbzY4LgMt2d5xCLL0uY2HjdURJj1Rr3r0,69517
+litpose_app/ngdist/ng_app/styles-ZM27COY6.css.map,sha256=w1T6js2TzjwM4XKfCmyGpfWeqkqzolJbll3wXCRl8Go,75027
+litpose_app/ngdist/ng_app/video-player-controls.component-C4JZHYJ2.css.map,sha256=vX-dgeDCUCPLiea4Qy9O_EBm6IzzwB7R_uSBa0qU5Go,771
+litpose_app/ngdist/ng_app/video-tile.component-RDL4BSJ4.css.map,sha256=_pZ7FxqOAu535JfrRv1TSKgRpDyQvn9Q0U39KHyJ980,332
+litpose_app/ngdist/ng_app/viewer-page.component-KDHT6XH5.css.map,sha256=Uf1FgoCiF_qJpD4Ggk34Dq7kM73Q7i7NT6h3m30tbaY,211
+litpose_app/routes/ffprobe.py,sha256=UVKDu4ghXkYNuzI-91KPMNpQukHV9Goeps7ex_lG_SU,5526
+litpose_app/routes/files.py,sha256=HHyug226s_M4jMi8q7oI2dTWHTKu_J_c7vIbG0rdk9s,3102
+litpose_app/routes/project.py,sha256=pQW7zFdGHMy_eE0Z1bIXs9QLkV1-_MwFHsZR51-H6uQ,1957
+litpose_app/routes/transcode.py,sha256=9C4mMNgh0W7BHI2gdEnnoxMHVAoXag3eCXYhqOvUte4,2071
+litpose_app/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litpose_app/tasks/management.py,sha256=9wKT8i3CE8ueRCP3DpNd21UMy2_3Kn_LMLBp0dGStFc,120
+litpose_app/tasks/transcode_fine.py,sha256=bX8OblwMO_xaXXqZXJmmQPprCYIpPGHiboyEJli6FHs,209
+litpose_app/transcode_fine.py,sha256=zJKj1ozTSnmAEOddiqdy3ekRKdEAiNm2oMe9bcx520c,6142
+lightning_pose_app-1.8.1a4.dist-info/METADATA,sha256=sIyFToit6PIpDi4jTpjALkGwPXPp-u0l6znOtkpfsIQ,793
+lightning_pose_app-1.8.1a4.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+lightning_pose_app-1.8.1a4.dist-info/RECORD,,

litpose_app/config.py

@@ -0,0 +1,22 @@
+"""Routes should not access this directly, if they want to be able to
+modify these in unit tests.
+Instead, prefer to inject `config: deps.config into the route using FastAPI's dependency injection.
+See https://fastapi.tiangolo.com/tutorial/dependencies/."""
+
+from pathlib import Path
+
+from pydantic import BaseModel
+
+
+# Consider `pydantic_settings.BaseSettings` for potential future needs.
+class Config(BaseModel):
+    PROJECT_INFO_TOML_PATH: Path = Path("~/.lightning_pose/project.toml").expanduser()
+
+    ## Video transcoding settings
+
+    # Directory where finely transcoded videos are stored
+    FINE_VIDEO_DIR: Path = Path("~/.lightning_pose/finevideos").expanduser()
+
+    # We'll automatically transcode videos with size under this limit.
+    # Larger ones will have to be manually triggered (design TBD).
+    AUTO_TRANSCODE_VIDEO_SIZE_LIMIT_MB: int = 30

litpose_app/deps.py

@@ -0,0 +1,77 @@
+"""
+Dependencies that can be injected into routes.
+This has the benefit of making tests easier to write, as you can override dependencies.
+See FastAPI Dependency Injection docs: https://fastapi.tiangolo.com/tutorial/dependencies/
+"""
+
+from __future__ import annotations
+
+import logging
+import math
+import os
+from typing import TYPE_CHECKING
+
+from apscheduler.executors.debug import DebugExecutor
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+from apscheduler.executors.pool import ThreadPoolExecutor
+from fastapi import Depends
+
+from litpose_app.config import Config
+
+logger = logging.getLogger(__name__)
+
+
+def config() -> Config:
+    """Dependency that provides the app config object."""
+    from .main import app
+
+    if not hasattr(app.state, "config"):
+        app.state.config = Config()
+    return app.state.config
+
+
+def scheduler() -> AsyncIOScheduler:
+    """Dependency that provides the app's APScheduler instance."""
+    from .main import app
+
+    if not hasattr(app.state, "scheduler"):
+        # ffmpeg parallelizes transcoding to the optimal degree, but
+        # that doesn't always saturate a machine with a lot of cores.
+        # i.e. on a 24 logical core machine (12 physical * 2 hyperthreads per core)
+        # 3 was the ideal number of max_workers. Let's just guesstimate that
+        # ffmpeg uses 10 cores? No scientific evidence, but ceil(24/10) => 3.
+        transcode_workers = math.ceil(os.cpu_count() / 10)
+        executors = {
+            "transcode_pool": ThreadPoolExecutor(max_workers=transcode_workers),
+            "debug": DebugExecutor(),
+        }
+        app.state.scheduler = AsyncIOScheduler(executors=executors)
+    return app.state.scheduler
+
+
+if TYPE_CHECKING:
+    from .routes.project import ProjectInfo
+
+
+def project_info(config: Config = Depends(config)) -> ProjectInfo:
+    import tomli
+    from .routes.project import ProjectInfo
+
+    from pydantic import ValidationError
+
+    try:
+        # Open the file in binary read mode, as recommended by tomli
+        with open(config.PROJECT_INFO_TOML_PATH, "rb") as f:
+            # Load the TOML data into a Python dictionary
+            toml_data = tomli.load(f)
+
+        # Unpack the dictionary into the Pydantic model
+        return ProjectInfo(**toml_data)
+    except FileNotFoundError:
+        return None
+    except tomli.TOMLDecodeError as e:
+        logger.error(f"Could not decode pyproject.toml. Invalid syntax: {e}")
+        raise
+    except ValidationError as e:
+        logger.error(f"pyproject.toml is invalid. {e}")
+        raise

litpose_app/main.py

@@ -1,24 +1,53 @@
+import logging
+import sys
+from contextlib import asynccontextmanager
 from pathlib import Path
 from textwrap import dedent
 
-import tomli
-import tomli_w
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import FileResponse
-import sys
 import uvicorn
-from pydantic import BaseModel, ValidationError
+from fastapi import FastAPI, HTTPException, APIRouter, Request
+from fastapi.responses import FileResponse
 from starlette import status
-from starlette.requests import Request
 from starlette.responses import Response
 from starlette.staticfiles import StaticFiles
 
-from .run_ffprobe import run_ffprobe
-from .super_rglob import super_rglob
+from . import deps
+
+## Setup logging
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)
+logger = logging.getLogger(__name__)
+
+
+## Configure additional things to happen on server startup and shutdown.
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # Start apscheduler, which is responsible for executing background tasks
+    logger.info("Application startup: Initializing scheduler...")
+    scheduler = deps.scheduler()
+    scheduler.start()
+
+    yield  # Application is now ready to receive requests
+
+    logger.info("Application shutdown: Shutting down scheduler...")
+    if scheduler and scheduler.running:
+        scheduler.shutdown()
+        logger.info("Scheduler shut down.")
+    else:
+        logger.warning("Scheduler not found or not running during shutdown.")
 
-# use this example to pull useful features from:
-# https://github.com/fastapi/full-stack-fastapi-template
-app = FastAPI()
+
+app = FastAPI(lifespan=lifespan)
+
+router = APIRouter()
+from .routes import ffprobe, files, project, transcode
+
+router.include_router(ffprobe.router)
+router.include_router(files.router)
+router.include_router(project.router)
+router.include_router(transcode.router)
+app.include_router(router)
 
 
 @app.exception_handler(Exception)
@@ -41,17 +70,6 @@ async def debug_exception_handler(request: Request, exc: Exception):
     )
 
 
-PROJECT_INFO_TOML_PATH = Path("~/.lightning_pose/project.toml").expanduser()
-
-
-class ProjectInfo(BaseModel):
-    """Class to hold information about the project"""
-
-    data_dir: Path | None = None
-    model_dir: Path | None = None
-    views: list[str] | None = None
-
-
 """
 All our methods are RPC style (http url corresponds to method name).
 They should be POST requests, /rpc/<method_name>.
@@ -64,160 +82,9 @@ error in a dialog to the user. So if the client is supposed to
 handle the error in any way, for example, special form validation UX
 like underlining the invalid field,
 then the information about the error should be included in a valid
-response object rather than raised as a python error. 
+response object rather than raised as a python error.
 """
 
-
-class GetProjectInfoResponse(BaseModel):
-    projectInfo: ProjectInfo | None  # None if project info not yet initialized
-
-
-@app.post("/app/v0/rpc/getProjectInfo")
-def get_project_info() -> GetProjectInfoResponse:
-    try:
-        # Open the file in binary read mode, as recommended by tomli
-        with open(PROJECT_INFO_TOML_PATH, "rb") as f:
-            # Load the TOML data into a Python dictionary
-            toml_data = tomli.load(f)
-
-        # Unpack the dictionary into the Pydantic model
-        # Pydantic will handle all the validation from here.
-        obj = ProjectInfo(**toml_data)
-        return GetProjectInfoResponse(projectInfo=obj)
-
-    except FileNotFoundError:
-        return GetProjectInfoResponse(projectInfo=None)
-    except tomli.TOMLDecodeError as e:
-        print(f"Error: Could not decode the TOML file. Invalid syntax: {e}")
-        raise
-    except ValidationError as e:
-        # Pydantic's validation error is very informative
-        print(f"Error: Configuration is invalid. {e}")
-        raise
-
-
-class SetProjectInfoRequest(BaseModel):
-    projectInfo: ProjectInfo
-
-
-@app.post("/app/v0/rpc/setProjectInfo")
-def set_project_info(request: SetProjectInfoRequest) -> None:
-    try:
-        PROJECT_INFO_TOML_PATH.parent.mkdir(parents=True, exist_ok=True)
-
-        # Convert the Pydantic model to a dictionary for TOML serialization.
-        # Use mode=json to make the resulting dict json-serializable (and thus
-        # also toml serializable)
-        project_data_dict = request.projectInfo.model_dump(
-            mode="json", exclude_none=True
-        )
-        try:
-            with open(PROJECT_INFO_TOML_PATH, "rb") as f:
-                existing_project_data = tomli.load(f)
-        except FileNotFoundError:
-            existing_project_data = {}
-
-        # Apply changes onto existing data, i.e. PATCH semantics.
-        existing_project_data.update(project_data_dict)
-
-        # Open the file in binary write mode to write the TOML data
-        with open(PROJECT_INFO_TOML_PATH, "wb") as f:
-            tomli_w.dump(existing_project_data, f)
-
-        return None
-
-    except IOError as e:
-        # This catches errors related to file operations (e.g., permissions, disk full)
-        error_message = f"Failed to write project information to file: {str(e)}"
-        print(error_message)  # Log server-side
-        raise e
-    except Exception as e:  # Catch any other unexpected errors
-        error_message = (
-            f"An unexpected error occurred while saving project info: {str(e)}"
-        )
-        print(error_message)  # Log server-side
-        raise e
-
-
-class RGlobRequest(BaseModel):
-    baseDir: Path
-    pattern: str
-    noDirs: bool = False
-    stat: bool = False
-
-
-class RGlobResponseEntry(BaseModel):
-    path: Path
-
-    # Present only if request had stat=True or noDirs=True
-    type: str | None
-
-    # Present only if request had stat=True
-
-    size: int | None
-    # Creation timestamp, ISO format.
-    cTime: str | None
-    # Modified timestamp, ISO format.
-    mTime: str | None
-
-
-class RGlobResponse(BaseModel):
-    entries: list[RGlobResponseEntry]
-    relativeTo: Path  # this is going to be the same base_dir that was in the request.
-
-
-@app.post("/app/v0/rpc/rglob")
-def rglob(request: RGlobRequest) -> RGlobResponse:
-    # Prevent secrets like /etc/passwd and ~/.ssh/ from being leaked.
-    if not (request.pattern.endswith(".csv") or request.pattern.endswith(".mp4")):
-        raise HTTPException(
-            status_code=status.HTTP_403_FORBIDDEN,
-            detail="Only csv and mp4 files are supported.",
-        )
-
-    response = RGlobResponse(entries=[], relativeTo=request.baseDir)
-
-    results = super_rglob(
-        str(request.baseDir),
-        pattern=request.pattern,
-        no_dirs=request.noDirs,
-        stat=request.stat,
-    )
-    for r in results:
-        # Convert dict to pydantic model
-        converted = RGlobResponseEntry.model_validate(r)
-        response.entries.append(converted)
-
-    return response
-
-
-class FFProbeRequest(BaseModel):
-    path: Path
-
-
-class FFProbeResponse(BaseModel):
-    codec: str
-    width: int
-    height: int
-    fps: int
-    duration: float
-
-
-@app.post("/app/v0/rpc/ffprobe")
-def ffprobe(request: FFProbeRequest) -> FFProbeResponse:
-    if request.path.suffix != ".mp4":
-        raise HTTPException(
-            status_code=status.HTTP_403_FORBIDDEN,
-            detail="Only mp4 files are supported.",
-        )
-
-    result = run_ffprobe(str(request.path))
-
-    response = FFProbeResponse.model_validate(result)
-
-    return response
-
-
 """
 File server to serve csv and video files.
 FileResponse supports range requests for video buffering.
@@ -251,11 +118,12 @@ def read_file(file_path: Path):
 # This is necessary to use HTTP2 for faster concurrent request performance (ng serve doesn't support it).
 ###########################################################################
 
+
 # Serve ng assets (js, css)
 STATIC_DIR = Path(__file__).parent / "ngdist" / "ng_app"
 if not STATIC_DIR.is_dir():
     message = dedent(
-        f"""
+        """
         ⚠️  Warning: We couldn't find the necessary static assets (like HTML, CSS, JavaScript files).
         As a result, only the HTTP API is currently running.
 
@@ -276,25 +144,15 @@ app.mount("/static", StaticFiles(directory=STATIC_DIR, check_dir=False), name="s
 
 
 @app.get("/favicon.ico")
-def favicon():
+async def favicon():
     return FileResponse(Path(__file__).parent / "ngdist" / "ng_app" / "favicon.ico")
 
 
 # Catch-all route. serve index.html.
 @app.get("/{full_path:path}")
-def index(full_path: Path):
+async def index():
     return FileResponse(Path(__file__).parent / "ngdist" / "ng_app" / "index.html")
 
 
-def get_static_files_if_needed():
-    cache_dir = Path("~/.lightning_pose/cache").expanduser()
-    # Version check
-    # App should run with "latest compatible version"
-    # this means that if lightning pose is installed, it gets the latest version compatible with that version.
-    # otherwise it gets just the latest version.
-    # Download the files?
-
-
 def run_app(host: str, port: int):
-    get_static_files_if_needed()
     uvicorn.run(app, host=host, port=port)

litpose_app/ngdist/ng_app/3rdpartylicenses.txt

@@ -341,17 +341,17 @@ License: "Apache-2.0"
 Package: tslib
 License: "0BSD"
 
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 --------------------------------------------------------------------------------
 Package: @angular/common

litpose_app/ngdist/ng_app/index.html

@@ -329,6 +329,7 @@
     --color-green-400: oklch(79.2% 0.209 151.711);
     --color-sky-100: oklch(95.1% 0.026 236.824);
     --color-sky-700: oklch(50% 0.134 242.749);
+    --color-gray-400: oklch(70.7% 0.022 261.325);
     --color-black: #000;
     --spacing: 0.25rem;
     --container-xs: 20rem;
@@ -444,8 +445,8 @@
     }
   }
 }
-</style><link rel="stylesheet" href="/static/styles-AJ6NQDUD.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="/static/styles-AJ6NQDUD.css"></noscript></head>
+</style><link rel="stylesheet" href="/static/styles-ZM27COY6.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="/static/styles-ZM27COY6.css"></noscript></head>
   <body>
     <app-root></app-root>
-  <script src="/static/main-WFYIUX2C.js" type="module"></script></body>
+  <script src="/static/main-VCJFCLFP.js" type="module"></script></body>
 </html>