[dist] Make dvr-scan installable via pyproject.toml. (#205)

* [dist] Make dvr-scan installable via pyproject.toml

* [dist] pin packages using uv

* [dist] Update tweak_setup_cfg_for_headless.py to modify pyproject.toml

---------

Co-authored-by: Breakthrough <brandon248@gmail.com>

Author: frafra

.github/workflows/build.yml

@@ -58,12 +58,15 @@ jobs:
           version: "0.5.11"
           python-version: ${{ matrix.python-version }}
 
-      # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
       - name: Install Dependencies
         run: |
           uv pip install --upgrade build wheel virtualenv
-          uv pip install opencv-python-headless\<4.13 opencv-contrib-python-headless\<4.13 --only-binary :all:
-          uv pip install -r requirements_headless.txt -r docs/requirements.txt
+          # TODO: Figure out how to avoid installing the original OpenCV package.
+          uv pip install -e ".[dev]" -r docs/requirements.txt
+          # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
+          # Use headless OpenCV variant on CI to reduce download size.
+          uv pip uninstall opencv-python opencv-contrib-python
+          uv pip install "opencv-contrib-python-headless<4.13" --only-binary :all:
 
       - name: Setup FFmpeg
         # TODO: This action currently does not work for non-x64 builders (e.g. macos-14):
@@ -87,7 +90,7 @@ jobs:
       - name: Build Package (Headless)
         shell: bash
         run: |
-          python dist/tweak_setup_cfg_for_headless.py
+          python dist/build_headless.py
           python -m build
           git reset --hard HEAD
 

.github/workflows/check-code-format.yml

@@ -35,8 +35,7 @@ jobs:
       - name: Install Dependencies
         run: |
           uv pip install --upgrade pip
-          uv pip install --upgrade yapf toml
-          uv pip install -r requirements_headless.txt
+          uv pip install --upgrade yapf toml ruff
 
       - name: Check Code Format (yapf)
         if: ${{ hashFiles('.style.yapf') != '' }}

.github/workflows/publish-pypi.yaml

@@ -103,13 +103,13 @@ jobs:
         run: |
           uv pip install --upgrade build wheel virtualenv
           uv pip install opencv-python-headless opencv-contrib-python-headless --only-binary :all:
-          uv pip install -r requirements_headless.txt -r docs/requirements.txt
+          uv pip install -e . -r docs/requirements.txt
 
       - name: Build Package
         run: |
           python dist/pre_release.py
           python -m build
-          python dist/tweak_setup_cfg_for_headless.py
+          python dist/build_headless.py
           python -m build
           mkdir pkg
           mv dist/*.tar.gz pkg/

.gitignore

@@ -10,8 +10,6 @@ site/
 build/
 # Working directory for distribution assembly
 dist/dvr-scan/*
-dist/dvr-scan-*
-dist/dvr_scan-*
 
 # Editors/environment
 .DS_Store

dist/.gitignore

@@ -0,0 +1,4 @@
+*
+!*.py
+!*.txt
+!.gitignore

dist/build_headless.py

@@ -0,0 +1,48 @@
+#
+#      DVR-Scan: Video Motion Event Detection & Extraction Tool
+#   --------------------------------------------------------------
+#       [  Site: https://www.dvr-scan.com/                 ]
+#       [  Repo: https://github.com/Breakthrough/DVR-Scan  ]
+#
+# Copyright (C) 2016 Brandon Castellano <http://www.bcastell.com>.
+#
+
+# This script generates a headless (no GUI) version of the package
+# by modifying the pyproject.toml file. When the project is next built,
+# the headless variant will be used.
+#
+# *WARNING*: This modifies the existing pyproject.toml file in place.
+# The changes must be reverted to restore the full package.
+#
+
+import os
+import re
+
+# Correctly locate pyproject.toml relative to the script's location
+script_dir = os.path.dirname(os.path.abspath(__file__))
+project_root = os.path.abspath(os.path.join(script_dir, ".."))
+pyproject_path = os.path.join(project_root, "pyproject.toml")
+
+with open(pyproject_path, "r") as f:
+    content = f.read()
+
+# Rename package to headless variant
+assert 'name = "dvr-scan"' in content
+content = content.replace('name = "dvr-scan"', 'name = "dvr-scan-headless"', 1)
+
+# Remove dvr-scan-app entry point
+assert "dvr-scan-app" in content
+content = re.sub(r'^dvr-scan-app\s*=.*\n', "", content, flags=re.MULTILINE)
+
+# Swap GUI opencv for headless opencv
+assert "opencv-contrib-python<4.13" in content
+content = content.replace('"opencv-contrib-python<4.13"', '"opencv-contrib-python-headless<4.13"', 1)
+
+# Remove screeninfo (GUI dependency)
+assert "screeninfo" in content
+content = re.sub(r'^\s*"screeninfo",?\n', "", content, flags=re.MULTILINE)
+
+with open(pyproject_path, "w") as f:
+    f.write(content)
+
+print("Successfully generated headless pyproject.toml.")

dist/tweak_setup_cfg_for_headless.py

@@ -9,9 +9,79 @@
 # LICENSE file, or visit one of the above pages for details.
 #
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=64"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "dvr-scan"
+dynamic = ["version"]
+description = "Tool for finding and extracting motion events in video files (e.g. security camera footage)."
+readme = "README.md"
+license = { text = "BSD-2-Clause" }
+requires-python = ">=3.10"
+authors = [
+    { name = "Brandon Castellano", email = "brandon248@gmail.com" },
+]
+keywords = [
+    "analysis",
+    "computer-vision",
+    "video",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Console :: Curses",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Multimedia :: Video :: Conversion",
+    "Topic :: Multimedia :: Video :: Non-Linear Editor",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "numpy",
+    "platformdirs",
+    "scenedetect>=0.6.2",
+    "tqdm",
+    "pillow",
+    # TODO(#257): Unpin OpenCV versions once we figure out why frame numbers are mismatching in tests.
+    "opencv-contrib-python<4.13",
+    "screeninfo",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "ruff",
+]
+
+[project.scripts]
+dvr-scan = "dvr_scan.__main__:main"
+dvr-scan-app = "dvr_scan.app.__main__:main"
+
+[project.urls]
+"Bug Tracker" = "https://github.com/Breakthrough/DVR-Scan/issues"
+Documentation = "https://www.dvr-scan.com/docs"
+Homepage = "https://www.dvr-scan.com/"
+Repository = "https://github.com/Breakthrough/DVR-Scan"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["dvr_scan*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "dvr_scan.__version__"}
+
 [tool.ruff]
 exclude = [
     "docs"
@@ -43,3 +113,7 @@ select = [
 ]
 fixable = ["ALL"]
 unfixable = []
+
+[tool.pytest.ini_options]
+addopts = "--verbose"
+python_files = ["tests/*.py"]