nwb-video-widgets 0.1.0__tar.gz

nwb_video_widgets-0.1.0/.github/workflows/auto-publish.yml

@@ -0,0 +1,39 @@
+# Publish to PyPI when a GitHub Release is published AND the tag starts with 'v'.
+# Uses PyPI Trusted Publishing (no API token needed).
+
+name: Upload Package to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write   # required for PyPI Trusted Publishing
+
+jobs:
+  deploy:
+    # Only run if the release tag starts with 'v' (e.g., v0.1.0)
+    if: startsWith(github.event.release.tag_name, 'v')
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade build
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Publish to PyPI (OIDC + attestations)
+        uses: pypa/gh-action-pypi-publish@v1.12.4
+        with:
+          attestations: true

nwb_video_widgets-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest tests/ -v

nwb_video_widgets-0.1.0/.gitignore

@@ -0,0 +1,214 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+widget_notebook.ipynb
+design_docs/drafts
+
+# Original large GIFs (use preprocessed versions instead)
+assets/pose_estimation..gif
+assets/video_widget.gif
+

nwb_video_widgets-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CatalystNeuro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nwb_video_widgets-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: nwb-video-widgets
+Version: 0.1.0
+Summary: Interactive Jupyter widgets for NWB video and pose visualization
+Project-URL: Homepage, https://github.com/catalystneuro/nwb-video-widgets
+Project-URL: Repository, https://github.com/catalystneuro/nwb-video-widgets
+Author: Heberto Mayorquin
+License-Expression: MIT
+License-File: LICENSE
+Keywords: anywidget,jupyter,neuroscience,nwb,pose,video,widget
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: anywidget>=0.9.0
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pynwb
+Provides-Extra: dandi
+Requires-Dist: dandi>=0.60.0; extra == 'dandi'
+Requires-Dist: h5py; extra == 'dandi'
+Requires-Dist: remfile>=0.1.13; extra == 'dandi'
+Provides-Extra: test
+Requires-Dist: opencv-python-headless; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# nwb-video-widgets
+
+[![PyPI version](https://badge.fury.io/py/nwb-video-widgets.svg)](https://badge.fury.io/py/nwb-video-widgets)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Interactive Jupyter widgets for NWB video and pose estimation visualization. Built with [anywidget](https://anywidget.dev/) for compatibility across JupyterLab, Jupyter Notebook, VS Code, and Google Colab.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Video Player Widgets](#video-player-widgets)
+- [Pose Estimation Widgets](#pose-estimation-widgets)
+## Installation
+
+For local only NWB file usage:
+
+```bash
+pip install nwb-video-widgets
+```
+
+For DANDI integration and streaming support:
+
+```bash
+pip install nwb-video-widgets[dandi]
+```
+
+## Video Player Widgets
+
+Multi-camera synchronized video player with configurable layout (Row, Column, or Grid).
+
+![Video Widget Demo](assets/video_widget_preprocessed.gif)
+
+**Features:**
+
+- Interactive settings panel for video selection
+- Multiple layout modes (Row, Column, Grid)
+- Synchronized playback across all videos
+- Session time display with NWB timestamps
+
+### DANDI Streaming
+
+Use `NWBDANDIVideoPlayer` for videos hosted on DANDI:
+
+```python
+from dandi.dandiapi import DandiAPIClient
+from nwb_video_widgets import NWBDANDIVideoPlayer
+
+client = DandiAPIClient()
+dandiset = client.get_dandiset("000409", "draft")
+asset = dandiset.get_asset_by_path("sub-NYU-39/sub-NYU-39_ses-..._behavior.nwb")
+
+widget = NWBDANDIVideoPlayer(asset=asset)
+widget
+```
+
+### Local Files
+
+Use `NWBLocalVideoPlayer` for local NWB files:
+
+```python
+from pynwb import read_nwb
+from nwb_video_widgets import NWBLocalVideoPlayer
+
+nwbfile = read_nwb("experiment.nwb")
+widget = NWBLocalVideoPlayer(nwbfile)
+widget
+```
+
+---
+
+## Pose Estimation Widgets
+
+Overlays DeepLabCut keypoints on streaming video with support for camera selection.
+
+![Pose Estimation Widget Demo](assets/pose_estimation_preprocessed.gif)
+
+**Features:**
+
+- Camera selection via settings panel
+- Keypoint visibility toggles (All/None/individual)
+- Label display toggle
+- Session time display (NWB timestamps)
+- Custom keypoint colors via colormap or explicit hex values
+- Supports split files (videos in raw file, pose in processed file)
+
+### DANDI Streaming
+
+Use `NWBDANDIPoseEstimationWidget` for DANDI-hosted files:
+
+```python
+from dandi.dandiapi import DandiAPIClient
+from nwb_video_widgets import NWBDANDIPoseEstimationWidget
+
+client = DandiAPIClient()
+dandiset = client.get_dandiset("000409", "draft")
+
+# Single file (videos + pose in same file)
+asset = dandiset.get_asset_by_path("sub-.../sub-..._combined.nwb")
+widget = NWBDANDIPoseEstimationWidget(asset=asset)
+
+# Or split files (videos in raw, pose in processed)
+raw_asset = dandiset.get_asset_by_path("sub-.../sub-..._desc-raw.nwb")
+processed_asset = dandiset.get_asset_by_path("sub-.../sub-..._desc-processed.nwb")
+widget = NWBDANDIPoseEstimationWidget(
+    asset=processed_asset,
+    video_asset=raw_asset,
+)
+widget
+```
+
+### Local Files
+
+Use `NWBLocalPoseEstimationWidget` for local NWB files:
+
+```python
+from pynwb import read_nwb
+from nwb_video_widgets import NWBLocalPoseEstimationWidget
+
+# Single file
+nwbfile = read_nwb("experiment.nwb")
+widget = NWBLocalPoseEstimationWidget(nwbfile)
+widget
+
+# Or split files
+nwbfile_raw = read_nwb("raw.nwb")
+nwbfile_processed = read_nwb("processed.nwb")
+widget = NWBLocalPoseEstimationWidget(
+    nwbfile=nwbfile_processed,
+    video_nwbfile=nwbfile_raw,
+)
+widget
+```
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `keypoint_colors` | `str` or `dict` | Matplotlib colormap name (e.g., `'tab10'`) or dict mapping keypoint names to hex colors |
+| `default_camera` | `str` | Camera to display initially |
+

nwb_video_widgets-0.1.0/README.md

@@ -0,0 +1,141 @@
+# nwb-video-widgets
+
+[![PyPI version](https://badge.fury.io/py/nwb-video-widgets.svg)](https://badge.fury.io/py/nwb-video-widgets)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Interactive Jupyter widgets for NWB video and pose estimation visualization. Built with [anywidget](https://anywidget.dev/) for compatibility across JupyterLab, Jupyter Notebook, VS Code, and Google Colab.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Video Player Widgets](#video-player-widgets)
+- [Pose Estimation Widgets](#pose-estimation-widgets)
+## Installation
+
+For local only NWB file usage:
+
+```bash
+pip install nwb-video-widgets
+```
+
+For DANDI integration and streaming support:
+
+```bash
+pip install nwb-video-widgets[dandi]
+```
+
+## Video Player Widgets
+
+Multi-camera synchronized video player with configurable layout (Row, Column, or Grid).
+
+![Video Widget Demo](assets/video_widget_preprocessed.gif)
+
+**Features:**
+
+- Interactive settings panel for video selection
+- Multiple layout modes (Row, Column, Grid)
+- Synchronized playback across all videos
+- Session time display with NWB timestamps
+
+### DANDI Streaming
+
+Use `NWBDANDIVideoPlayer` for videos hosted on DANDI:
+
+```python
+from dandi.dandiapi import DandiAPIClient
+from nwb_video_widgets import NWBDANDIVideoPlayer
+
+client = DandiAPIClient()
+dandiset = client.get_dandiset("000409", "draft")
+asset = dandiset.get_asset_by_path("sub-NYU-39/sub-NYU-39_ses-..._behavior.nwb")
+
+widget = NWBDANDIVideoPlayer(asset=asset)
+widget
+```
+
+### Local Files
+
+Use `NWBLocalVideoPlayer` for local NWB files:
+
+```python
+from pynwb import read_nwb
+from nwb_video_widgets import NWBLocalVideoPlayer
+
+nwbfile = read_nwb("experiment.nwb")
+widget = NWBLocalVideoPlayer(nwbfile)
+widget
+```
+
+---
+
+## Pose Estimation Widgets
+
+Overlays DeepLabCut keypoints on streaming video with support for camera selection.
+
+![Pose Estimation Widget Demo](assets/pose_estimation_preprocessed.gif)
+
+**Features:**
+
+- Camera selection via settings panel
+- Keypoint visibility toggles (All/None/individual)
+- Label display toggle
+- Session time display (NWB timestamps)
+- Custom keypoint colors via colormap or explicit hex values
+- Supports split files (videos in raw file, pose in processed file)
+
+### DANDI Streaming
+
+Use `NWBDANDIPoseEstimationWidget` for DANDI-hosted files:
+
+```python
+from dandi.dandiapi import DandiAPIClient
+from nwb_video_widgets import NWBDANDIPoseEstimationWidget
+
+client = DandiAPIClient()
+dandiset = client.get_dandiset("000409", "draft")
+
+# Single file (videos + pose in same file)
+asset = dandiset.get_asset_by_path("sub-.../sub-..._combined.nwb")
+widget = NWBDANDIPoseEstimationWidget(asset=asset)
+
+# Or split files (videos in raw, pose in processed)
+raw_asset = dandiset.get_asset_by_path("sub-.../sub-..._desc-raw.nwb")
+processed_asset = dandiset.get_asset_by_path("sub-.../sub-..._desc-processed.nwb")
+widget = NWBDANDIPoseEstimationWidget(
+    asset=processed_asset,
+    video_asset=raw_asset,
+)
+widget
+```
+
+### Local Files
+
+Use `NWBLocalPoseEstimationWidget` for local NWB files:
+
+```python
+from pynwb import read_nwb
+from nwb_video_widgets import NWBLocalPoseEstimationWidget
+
+# Single file
+nwbfile = read_nwb("experiment.nwb")
+widget = NWBLocalPoseEstimationWidget(nwbfile)
+widget
+
+# Or split files
+nwbfile_raw = read_nwb("raw.nwb")
+nwbfile_processed = read_nwb("processed.nwb")
+widget = NWBLocalPoseEstimationWidget(
+    nwbfile=nwbfile_processed,
+    video_nwbfile=nwbfile_raw,
+)
+widget
+```
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `keypoint_colors` | `str` or `dict` | Matplotlib colormap name (e.g., `'tab10'`) or dict mapping keypoint names to hex colors |
+| `default_camera` | `str` | Camera to display initially |
+