lightning-pose-app 1.8.1a3__tar.gz → 1.8.1a5__tar.gz

lightning_pose_app-1.8.1a5/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.3
+Name: lightning-pose-app
+Version: 1.8.1a5
+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: apscheduler (>=3.11.0,<3.12.0)
+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-asyncio (>=1.0.0,<1.1.0) ; extra == "dev"
+Requires-Dist: pytest-mock (>=3.14.0,<3.15.0) ; extra == "dev"
+Requires-Dist: reactivex (>=4.0.0,<4.1.0)
+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.1a5/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[project]
+name = "lightning-pose-app"
+version = "1.8.1a5"
+requires-python = ">=3.10"
+dependencies = [
+    "apscheduler~=3.11.0",
+    "fastapi~=0.115.0",
+    "honcho~=2.0",
+    "reactivex~=4.0.0",
+    "uvicorn[standard]~=0.34.0",
+    "wcmatch~=10.0",
+    "tomli~=2.2.0",
+    "tomli_w~=1.2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "httpx~=0.28.0",
+    "pytest~=8.4.0",
+    "pytest-mock~=3.14.0",
+    "pytest-asyncio~=1.0.0"
+]
+
+[tool.poetry]
+packages = [
+    { include = "litpose_app", from = "src" }
+]
+# We need this to override the .gitignore.
+include = ["**/ngdist/**/*"]

lightning_pose_app-1.8.1a5/src/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

lightning_pose_app-1.8.1a5/src/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

lightning_pose_app-1.8.1a5/src/litpose_app/main.py

@@ -0,0 +1,161 @@
+import logging
+import sys
+from contextlib import asynccontextmanager
+from pathlib import Path
+from textwrap import dedent
+
+import uvicorn
+from fastapi import FastAPI, HTTPException, APIRouter, Request
+from fastapi.responses import FileResponse
+from starlette import status
+from starlette.responses import Response
+from starlette.staticfiles import StaticFiles
+
+from . import deps
+from .tasks.management import setup_active_task_registry
+
+## 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()
+    app.state.scheduler = scheduler
+    scheduler.start()
+    setup_active_task_registry(app)
+
+    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.")
+
+
+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)
+async def debug_exception_handler(request: Request, exc: Exception):
+    """Puts error stack trace in response when any server exception occurs.
+
+    By default, FastAPI returns 500 "internal server error" on any Exception
+    that is not a subclass of HttpException. This is usually recommended in production apps.
+
+    In our app, it's more convenient to expose exception details to the user. The
+    security risk is minimal."""
+    import traceback
+
+    return Response(
+        status_code=500,
+        content="".join(
+            traceback.format_exception(type(exc), value=exc, tb=exc.__traceback__)
+        ),
+        headers={"Content-Type": "text/plain"},
+    )
+
+
+"""
+All our methods are RPC style (http url corresponds to method name).
+They should be POST requests, /rpc/<method_name>.
+Request body is some object (pydantic model).
+Response body is some object pydantic model.
+
+The client expects all RPC methods to succeed. If any RPC doesn't
+return the expected response object, it will be shown as an
+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.
+"""
+
+"""
+File server to serve csv and video files.
+FileResponse supports range requests for video buffering.
+For security - only supports reading out of data_dir and model_dir
+If we need to read out of other directories, they should be added to Project Info.
+"""
+
+
+@app.get("/app/v0/files/{file_path:path}")
+def read_file(file_path: Path):
+    # Prevent secrets like /etc/passwd and ~/.ssh/ from being leaked.
+    if file_path.suffix not in (".csv", ".mp4"):
+        raise HTTPException(
+            status_code=status.HTTP_403_FORBIDDEN,
+            detail="Only csv and mp4 files are supported.",
+        )
+    file_path = Path("/") / file_path
+
+    # Only capable of returning files that exist (not directories).
+    if not file_path.is_file():
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+
+    return FileResponse(file_path)
+
+
+###########################################################################
+# Serving angular
+#
+# In dev mode, `ng serve` serves ng, and proxies to us for backend requests.
+# In production mode, we will serve ng.
+# 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(
+        """
+        ⚠️  Warning: We couldn't find the necessary static assets (like HTML, CSS, JavaScript files).
+        As a result, only the HTTP API is currently running.
+
+        This usually happens if you've cloned the source code directly.
+        To fix this and get the full application working, you'll need to either:
+
+        - Build the application: Refer to development.md in the repository for steps.
+        - Copy static files: Obtain these files from a PyPI source distribution of a released
+        version and place them in:
+
+            {STATIC_DIR}
+        """
+    )
+    # print(f'{Fore.white}{Back.yellow}{message}{Style.reset}', file=sys.stderr)
+    print(f"{message}", file=sys.stderr)
+
+app.mount("/static", StaticFiles(directory=STATIC_DIR, check_dir=False), name="static")
+
+
+@app.get("/favicon.ico")
+async def favicon():
+    return FileResponse(Path(__file__).parent / "ngdist" / "ng_app" / "favicon.ico")
+
+
+# Catch-all route. serve index.html.
+@app.get("/{full_path:path}")
+async def index():
+    return FileResponse(Path(__file__).parent / "ngdist" / "ng_app" / "index.html")
+
+
+def run_app(host: str, port: int):
+    uvicorn.run(app, host=host, port=port)

{lightning_pose_app-1.8.1a3 → lightning_pose_app-1.8.1a5}/src/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

{lightning_pose_app-1.8.1a3 → lightning_pose_app-1.8.1a5}/src/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-4V6RXJMC.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="/static/styles-4V6RXJMC.css"></noscript></head>
+</style><link rel="stylesheet" href="/static/styles-GMK322VW.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="/static/styles-GMK322VW.css"></noscript></head>
   <body>
     <app-root></app-root>
-  <script src="/static/main-LJHMLKBL.js" type="module"></script></body>
+  <script src="/static/main-6XYUWDGZ.js" type="module"></script></body>
 </html>