fix: allow flexibility for opencv (#130)

Signed-off-by: Michele Dolfi <[email protected]>

Author: dolfim-ibm

.github/workflows/checks.yml

@@ -39,7 +39,7 @@ jobs:
           path: ~/.cache/pre-commit
           key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - name: Install dependencies
-        run: uv sync --frozen --all-extras
+        run: uv sync --frozen
       - name: Check code quality and consistency
         run: pre-commit run --all-files
       - name: Run tests
@@ -65,7 +65,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           enable-cache: true
       - name: Install dependencies
-        run: uv sync --all-extras
+        run: uv sync
       - name: Build package
         run: uv build
       - name: Check content of wheel

.github/workflows/pypi.yml

@@ -29,7 +29,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           enable-cache: true
       - name: Install dependencies
-        run: uv sync --all-extras
+        run: uv sync
       - name: Build package
         run: uv build
       - name: Publish distribution 📦 to PyPI

README.md

@@ -15,6 +15,18 @@ AI modules to support the Docling PDF document conversion project.
 - Layout model is an AI model that provides among other things ability to detect tables on the page. This package contains inference code for Layout model.
 
 
+## Install
+
+The package provides two variants which allow to seemlessly switch between `opencv-python` and `opencv-python-headless`.
+
+```sh
+# Option 1: with opencv-python-headless
+pip install "docling-ibm-models[opencv-python-headless]"
+
+# Option 2: with opencv-python
+pip install "docling-ibm-models[opencv-python]"
+```
+
 ## Pipeline Overview
 ![Architecture](docs/tablemodel_overview_color.png)
 

pyproject.toml

@@ -35,7 +35,6 @@ dependencies = [
   'jsonlines (>=3.1.0,<4.0.0)',
   'Pillow (>=10.0.0,<12.0.0)',
   'tqdm (>=4.64.0,<5.0.0)',
-  'opencv-python-headless (>=4.6.0.66,<5.0.0.0)',
   'huggingface_hub (>=0.23,<1)',
   'safetensors[torch] (>=0.4.3,<1)',
   'pydantic (>=2.0.0,<3.0.0)',
@@ -46,6 +45,10 @@ dependencies = [
   'accelerate (>=1.2.1,<2.0.0)',
 ]
 
+[project.optional-dependencies]
+opencv-python-headless = ['opencv-python-headless (>=4.6.0.66,<5.0.0.0)']
+opencv-python = ['opencv-python-headless (>=4.6.0.66,<5.0.0.0)']
+
 [project.urls]
 homepage = "https://github.com/docling-project/docling-ibm-models"
 repository = "https://github.com/docling-project/docling-ibm-models"
@@ -54,6 +57,7 @@ changelog = "https://github.com/docling-project/docling-ibm-models/blob/main/CHA
 
 [dependency-groups]
 dev = [
+    "opencv-python-headless (>=4.6.0.66,<5.0.0.0)",
     "pre-commit~=3.7",
     "mypy~=1.10",
     "black~=24.4",
@@ -75,6 +79,12 @@ dev = [
 
 [tool.uv]
 package = true
+conflicts = [
+    [
+        { extra = "opencv-python-headless" },
+        { extra = "opencv-python" },
+    ]
+]
 
 [tool.setuptools.packages.find]
 include = ["docling_ibm_models*"]