cv-frames 0.0.3__tar.gz → 0.0.4__tar.gz

{cv_frames-0.0.3 → cv_frames-0.0.4}/.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v3
@@ -24,11 +24,11 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
-          pip install -e .
+          pip install -e .[opencv]
 
       - name: Run the tests
         run: |
-          PYTHONFAULTHANDLER=2 pytest --cov=cvframes --cov-report term-missing tests/
+          PYTHONFAULTHANDLER=2 pytest tests/
 
       - name: Run pre-commit checks
         uses: pre-commit/action@v3.0.1

cv_frames-0.0.4/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]
+      - id: check-json
+      - id: check-docstring-first
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.3
+    hooks:
+      - id: ruff-check
+        args: ["--fix"]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        additional_dependencies: ["types-PyYAML"]
+        args: ["--config-file", "pyproject.toml"]

{cv_frames-0.0.3/cv_frames.egg-info → cv_frames-0.0.4}/PKG-INFO

@@ -1,13 +1,21 @@
 Metadata-Version: 2.4
 Name: cv-frames
-Version: 0.0.3
+Version: 0.0.4
 Summary: Read frames from OpenCV like humans
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
-Requires-Dist: opencv-python
 Requires-Dist: numpy
 Requires-Dist: click
 Provides-Extra: web
 Requires-Dist: aiohttp; extra == "web"
+Provides-Extra: opencv
+Requires-Dist: opencv-python; extra == "opencv"
+Provides-Extra: opencv-contrib
+Requires-Dist: opencv-contrib-python; extra == "opencv-contrib"
+Provides-Extra: opencv-headless
+Requires-Dist: opencv-python-headless; extra == "opencv-headless"
+Provides-Extra: opencv-contrib-headless
+Requires-Dist: opencv-contrib-python-headless; extra == "opencv-contrib-headless"
 
 cv-frames
 =========
@@ -34,6 +42,16 @@ Install via pip:
 
     pip install cv-frames
 
+If you install ``cv-frames`` standalone, you need to specify an OpenCV backend:
+
+.. code-block:: bash
+
+    pip install cv-frames[opencv]
+
+If ``cv-frames`` is part of a project that already depends on OpenCV
+(e.g. ``opencv-python`` or ``opencv-contrib-python`` is listed in your
+``requirements.txt``), no optional dependency is needed.
+
 ----
 
 Command Line Usage

cv_frames-0.0.3/PKG-INFO → cv_frames-0.0.4/README.rst

@@ -1,14 +1,3 @@
-Metadata-Version: 2.4
-Name: cv-frames
-Version: 0.0.3
-Summary: Read frames from OpenCV like humans
-Description-Content-Type: text/x-rst
-Requires-Dist: opencv-python
-Requires-Dist: numpy
-Requires-Dist: click
-Provides-Extra: web
-Requires-Dist: aiohttp; extra == "web"
-
 cv-frames
 =========
 
@@ -34,6 +23,16 @@ Install via pip:
 
     pip install cv-frames
 
+If you install ``cv-frames`` standalone, you need to specify an OpenCV backend:
+
+.. code-block:: bash
+
+    pip install cv-frames[opencv]
+
+If ``cv-frames`` is part of a project that already depends on OpenCV
+(e.g. ``opencv-python`` or ``opencv-contrib-python`` is listed in your
+``requirements.txt``), no optional dependency is needed.
+
 ----
 
 Command Line Usage

cv_frames-0.0.3/README.rst → cv_frames-0.0.4/cv_frames.egg-info/PKG-INFO

@@ -1,3 +1,22 @@
+Metadata-Version: 2.4
+Name: cv-frames
+Version: 0.0.4
+Summary: Read frames from OpenCV like humans
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Requires-Dist: numpy
+Requires-Dist: click
+Provides-Extra: web
+Requires-Dist: aiohttp; extra == "web"
+Provides-Extra: opencv
+Requires-Dist: opencv-python; extra == "opencv"
+Provides-Extra: opencv-contrib
+Requires-Dist: opencv-contrib-python; extra == "opencv-contrib"
+Provides-Extra: opencv-headless
+Requires-Dist: opencv-python-headless; extra == "opencv-headless"
+Provides-Extra: opencv-contrib-headless
+Requires-Dist: opencv-contrib-python-headless; extra == "opencv-contrib-headless"
+
 cv-frames
 =========
 
@@ -23,6 +42,16 @@ Install via pip:
 
     pip install cv-frames
 
+If you install ``cv-frames`` standalone, you need to specify an OpenCV backend:
+
+.. code-block:: bash
+
+    pip install cv-frames[opencv]
+
+If ``cv-frames`` is part of a project that already depends on OpenCV
+(e.g. ``opencv-python`` or ``opencv-contrib-python`` is listed in your
+``requirements.txt``), no optional dependency is needed.
+
 ----
 
 Command Line Usage

{cv_frames-0.0.3 → cv_frames-0.0.4}/cv_frames.egg-info/SOURCES.txt

@@ -10,6 +10,8 @@ cv_frames.egg-info/SOURCES.txt
 cv_frames.egg-info/dependency_links.txt
 cv_frames.egg-info/entry_points.txt
 cv_frames.egg-info/requires.txt
+cv_frames.egg-info/scm_file_list.json
+cv_frames.egg-info/scm_version.json
 cv_frames.egg-info/top_level.txt
 cvframes/__init__.py
 cvframes/cli.py

cv_frames-0.0.4/cv_frames.egg-info/requires.txt

@@ -0,0 +1,17 @@
+numpy
+click
+
+[opencv]
+opencv-python
+
+[opencv-contrib]
+opencv-contrib-python
+
+[opencv-contrib-headless]
+opencv-contrib-python-headless
+
+[opencv-headless]
+opencv-python-headless
+
+[web]
+aiohttp

cv_frames-0.0.4/cv_frames.egg-info/scm_file_list.json

@@ -0,0 +1,19 @@
+{
+  "files": [
+    ".github/workflows/publish.yml",
+    ".github/workflows/tests.yml",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    "README.rst",
+    "cvframes/__init__.py",
+    "cvframes/cli.py",
+    "cvframes/iterate.py",
+    "cvframes/web/__init__.py",
+    "cvframes/web/client.py",
+    "cvframes/web/server.py",
+    "cvframes/web/static/index.html",
+    "pyproject.toml",
+    "requirements.txt",
+    "tests/test_iterate.py"
+  ]
+}

cv_frames-0.0.4/cv_frames.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.0.4",
+  "distance": 0,
+  "node": "g1a4274555c3fe3cef38d9dbff907b15a6b300752",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-24"
+}

{cv_frames-0.0.3 → cv_frames-0.0.4}/cvframes/cli.py

@@ -13,9 +13,10 @@ def main():
 
 @main.command(name="show")
 @click.argument("filepath", type=click.Path(exists=True))
-def show(filepath):
-    for i, (_, frame) in enumerate(iterate(filepath)):
-        print("Frame:", i)
+@click.option("--start-frame", type=int, default=0)
+def show(filepath, start_frame: int):
+    for i, (_, frame) in enumerate(iterate(filepath, start_frame=start_frame)):
+        click.echo(f"Frame: {i + start_frame}")
         cv2.imshow("cvframes-show", frame)
 
         # Wait for a key press and check if it's 'q' to exit

{cv_frames-0.0.3 → cv_frames-0.0.4}/cvframes/iterate.py

@@ -1,5 +1,6 @@
+from collections.abc import Callable, Generator
 from pathlib import Path
-from typing import Callable, Generator, Optional, Tuple, TypeVar, Union
+from typing import TypeVar
 
 import cv2
 import numpy as np
@@ -8,34 +9,67 @@ T = TypeVar("T")
 
 
 class IOCapture:
-    def __init__(self, source: Union[str, Path], oname: Union[str, Path] = ""):
+    def __init__(
+        self,
+        source: str | Path,
+        oname: str | Path = "",
+        oshape: tuple[int, int] | None = None,
+    ):
         self.icap = cv2.VideoCapture(str(source))
-        self.ocap = (
-            cv2.VideoWriter(
-                str(oname),
+        self.oname = str(oname) if oname else None
+        self.oshape = oshape
+        self._ocap: cv2.VideoWriter | None = None
+
+    @property
+    def ocap(self) -> cv2.VideoWriter | None:
+        if self.oname is None:
+            return None
+
+        if self.oshape is None:
+            return None
+
+        if self._ocap is None:
+            self._ocap = cv2.VideoWriter(
+                self.oname,
                 cv2.VideoWriter_fourcc(*"mp4v"),
                 self.icap.get(cv2.CAP_PROP_FPS),
-                (
-                    int(self.icap.get(cv2.CAP_PROP_FRAME_WIDTH)),
-                    int(self.icap.get(cv2.CAP_PROP_FRAME_HEIGHT)),
-                ),
+                self.oshape,
             )
-            if oname
-            else None
-        )
+
+            if not self._ocap.isOpened():
+                raise RuntimeError(
+                    f"Cannot open output video file: {self.oname}"
+                )
+
+        return self._ocap
 
     def is_opened(self) -> bool:
         return self.icap.isOpened()
 
-    def read(self) -> Tuple[bool, np.ndarray]:
+    def read(self) -> tuple[bool, np.ndarray]:
         return self.icap.read()
 
     def write(self, frame: np.ndarray) -> None:
+        height, width = frame.shape[:2]
+        shape = (width, height)
+
+        if self.oshape is None:
+            self.oshape = shape
+            return
+
+        if shape != self.oshape:
+            raise ValueError(
+                "All output frames must have the same resolution. "
+                f"Expected {self.oshape[0]}x{self.oshape[1]}, "
+                f"got {width}x{height}."
+            )
+
         if self.ocap is not None:
             self.ocap.write(frame)
 
     def release(self) -> None:
         self.icap.release()
+
         if self.ocap is not None:
             self.ocap.release()
 
@@ -45,11 +79,11 @@ class IOCapture:
 
 def iterate_generic(
     ipath: Path,
-    opath: Optional[Path],
+    opath: Path | None,
     start_frame: int,
     stop_frame: int,
     process_frames: Callable[[np.ndarray], T],
-) -> Generator[Tuple[IOCapture, T], None, None]:
+) -> Generator[tuple[IOCapture, T], None, None]:
     capture = IOCapture(str(ipath), oname=opath or "")
     capture.set(cv2.CAP_PROP_POS_FRAMES, start_frame)
     count = start_frame
@@ -73,10 +107,10 @@ def iterate_generic(
 
 def iterate(
     ipath: Path,
-    opath: Optional[Path] = None,
+    opath: Path | None = None,
     start_frame: int = -1,
     stop_frame: int = -1,
-) -> Generator[Tuple[IOCapture, np.ndarray], None, None]:
+) -> Generator[tuple[IOCapture, np.ndarray], None, None]:
     return iterate_generic(
         ipath,
         opath,
@@ -88,11 +122,11 @@ def iterate(
 
 def iterate_sbs(
     ipath: Path,
-    opath: Optional[Path] = None,
+    opath: Path | None = None,
     start_frame: int = -1,
     stop_frame: int = -1,
-) -> Generator[Tuple[IOCapture, Tuple[np.ndarray, np.ndarray]], None, None]:
-    def processor(frame: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+) -> Generator[tuple[IOCapture, tuple[np.ndarray, np.ndarray]], None, None]:
+    def processor(frame: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
         _, width, _ = frame.shape
         mid = width // 2
         return frame[:, :mid, :], frame[:, mid:, :]

{cv_frames-0.0.3 → cv_frames-0.0.4}/cvframes/web/server.py

@@ -24,6 +24,13 @@ MAPPING = {
 }
 
 
+async def send_frame(ws, frame: bytes, to_remove: set):
+    try:
+        await ws.send_bytes(frame)
+    except Exception:  # noqa: BLE001 - a broken client must not stop the rest
+        to_remove.add(ws)
+
+
 async def broadcast_task(
     frame_queue: asyncio.Queue,
     clients: set,
@@ -39,13 +46,9 @@ async def broadcast_task(
                     to_remove.add(ws)
                     continue
 
-                async def send(ws):
-                    try:
-                        await ws.send_bytes(frame)
-                    except Exception:
-                        to_remove.add(ws)
-
-                tasks.append(asyncio.create_task(send(ws)))
+                tasks.append(
+                    asyncio.create_task(send_frame(ws, frame, to_remove))
+                )
             await asyncio.gather(*tasks, return_exceptions=True)
             for ws in to_remove:
                 clients.remove(ws)
@@ -77,7 +80,7 @@ async def handle_tcp_connection(
                 buffer = buffer[end:]
                 await frame_queue.put(jpg)
 
-    except Exception as e:
+    except Exception as e:  # noqa: BLE001 - report and close the socket
         print(f"[TCP] Error: {e}")
     finally:
         writer.close()
@@ -128,7 +131,7 @@ async def websocket_handler(request):
                 print(f"[WS] Error: {ws.exception()}")
                 break
 
-    except Exception as e:
+    except Exception as e:  # noqa: BLE001 - report and drop the client
         print(f"[WS] Receive error: {e}")
 
     finally:

{cv_frames-0.0.3 → cv_frames-0.0.4}/pyproject.toml

@@ -1,22 +1,39 @@
-[tool.black]
+[tool.ruff]
 line-length = 79
+target-version = "py310"
 
-[tool.isort]
-profile = "black"
-line_length = 79
+[tool.ruff.format]
+quote-style = "double"
+line-ending = "lf"
+indent-style = "space"
+skip-magic-trailing-comma = false
+
+[tool.ruff.lint]
+extend-select = [
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    # "B",   # bugbear
+    # "C90", # mccabe
+    # "D",  # pydocstyle
+    "ERA",  # eradicate
+]
+ignore = [
+    "E203",
+    "B008", # Do not perform function call
+    "RUF009", # Don not perform partials
+    # "W503",
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
 
 [tool.mypy]
 python_version = "3.10"
 strict = false
 ignore_missing_imports = true
 
-[tool.flake8]
-max-line-length = 79
-ignore = [
-    "E203", # Whitespace before ':'
-    "W503", # Line break before binary operator
-]
-
 [tool.pytest.ini_options]
 addopts = "--cov=cvframes --cov-report=term-missing"
 
@@ -30,15 +47,19 @@ name = "cv-frames"
 dynamic = ["version"]
 description = "Read frames from OpenCV like humans"
 readme = "README.rst"
+requires-python = ">=3.10"
 
 dependencies = [
-    "opencv-python",
     "numpy",
     "click",
 ]
 
 [project.optional-dependencies]
 web = ["aiohttp"]
+opencv = ["opencv-python"]
+opencv-contrib = ["opencv-contrib-python"]
+opencv-headless = ["opencv-python-headless"]
+opencv-contrib-headless = ["opencv-contrib-python-headless"]
 
 [project.scripts]
 cv-frames = "cvframes.cli:main"

{cv_frames-0.0.3 → cv_frames-0.0.4}/requirements.txt

@@ -1,3 +1,3 @@
 pytest
-pytest-coverage
+pytest-cov
 pre-commit

{cv_frames-0.0.3 → cv_frames-0.0.4}/tests/test_iterate.py

@@ -1,5 +1,4 @@
 from pathlib import Path
-from typing import Optional
 
 import cv2
 import numpy as np
@@ -31,7 +30,7 @@ def video(tmp_path: Path):
         Path("output.mp4"),
     ],
 )
-def test_iterate(video: Path, opath: Optional[Path]):
+def test_iterate(video: Path, opath: Path | None):
     # sourcery skip: no-loop-in-tests
     for capture, frame in iterate(video, opath=opath):
         capture.write(frame)
@@ -46,7 +45,7 @@ def test_iterate(video: Path, opath: Optional[Path]):
         Path("output.mp4"),
     ],
 )
-def test_iterate_sbs(video: Path, opath: Optional[Path]):
+def test_iterate_sbs(video: Path, opath: Path | None):
     # sourcery skip: no-loop-in-tests
     for capture, (lframe, rframe) in iterate_sbs(
         Path("input.mp4"), opath=opath

cv_frames-0.0.3/.pre-commit-config.yaml

@@ -1,39 +0,0 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
-    hooks:
-      - id: check-added-large-files
-        args: ["--maxkb=1000"]
-      - id: check-json
-      - id: check-docstring-first
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--settings-path", "pyproject.toml"]
-
-
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
-        args: ["--config", "pyproject.toml"]
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.921
-    hooks:
-      - id: mypy
-        additional_dependencies: ["types-PyYAML"]
-        args: ["--config-file", "pyproject.toml"]
-
-
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.1.2
-    hooks:
-      - id: flake8
-        # args: ["--config", "pyproject.toml"]
-        args: ["--max-line-length=79"]

cv_frames-0.0.3/cv_frames.egg-info/requires.txt

@@ -1,6 +0,0 @@
-opencv-python
-numpy
-click
-
-[web]
-aiohttp