faceswitch 0.1.0__tar.gz

faceswitch-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mohsin Ali
+
+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.

faceswitch-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: faceswitch
+Version: 0.1.0
+Summary: Simple multi-model face detection library
+Author: FaceSwitch Contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/yourusername/faceswitch
+Project-URL: Bug Tracker, https://github.com/yourusername/faceswitch/issues
+Project-URL: Documentation, https://github.com/yourusername/faceswitch/blob/main/README.md
+Keywords: face-detection,computer-vision,hog,dlib
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: hog
+Requires-Dist: dlib>=19.24; extra == "hog"
+Provides-Extra: examples
+Requires-Dist: opencv-python>=4.8; extra == "examples"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# FaceSwitch
+
+FaceSwitch is an installable Python library for face detection backends.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+Install the HOG backend dependency:
+
+```bash
+pip install -e '.[hog]'
+```
+
+## Minimal Usage
+
+```python
+import cv2
+from faceswitch import HogDetector
+
+image = cv2.imread("tests/Lenna_test_image.png")
+detector = HogDetector()
+faces = detector.detect(image)
+print(f"Detected: {len(faces)}")
+```
+
+## Example Script
+
+```bash
+pip install -e '.[hog,examples]'
+python examples/demo_hog.py tests/Lenna_test_image.png
+```

faceswitch-0.1.0/README.md

@@ -0,0 +1,34 @@
+# FaceSwitch
+
+FaceSwitch is an installable Python library for face detection backends.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+Install the HOG backend dependency:
+
+```bash
+pip install -e '.[hog]'
+```
+
+## Minimal Usage
+
+```python
+import cv2
+from faceswitch import HogDetector
+
+image = cv2.imread("tests/Lenna_test_image.png")
+detector = HogDetector()
+faces = detector.detect(image)
+print(f"Detected: {len(faces)}")
+```
+
+## Example Script
+
+```bash
+pip install -e '.[hog,examples]'
+python examples/demo_hog.py tests/Lenna_test_image.png
+```

faceswitch-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "faceswitch"
+version = "0.1.0"
+description = "Simple multi-model face detection library"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "FaceSwitch Contributors" }]
+keywords = ["face-detection", "computer-vision", "hog", "dlib"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "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 :: Scientific/Engineering :: Image Recognition",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = []
+
+[project.urls]
+"Homepage" = "https://github.com/yourusername/faceswitch"
+"Bug Tracker" = "https://github.com/yourusername/faceswitch/issues"
+"Documentation" = "https://github.com/yourusername/faceswitch/blob/main/README.md"
+
+[project.optional-dependencies]
+hog = ["dlib>=19.24"]
+examples = ["opencv-python>=4.8"]
+dev = ["pytest>=8.0"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["faceswitch*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+
+[tool.setuptools.package-data]
+faceswitch = ["py.typed"]

faceswitch-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

faceswitch-0.1.0/src/faceswitch/__init__.py

@@ -0,0 +1,9 @@
+"""Public FaceSwitch library API."""
+
+from faceswitch.core.interfaces import FaceDetector
+from faceswitch.core.types import FaceBox
+from faceswitch.detectors.hog import HogDetector, HogDetectorConfig
+
+__all__ = ["FaceBox", "FaceDetector", "HogDetector", "HogDetectorConfig"]
+
+__version__ = "0.1.0"

faceswitch-0.1.0/src/faceswitch/core/__init__.py

@@ -0,0 +1,6 @@
+"""Core contracts and types for detector implementations."""
+
+from faceswitch.core.interfaces import FaceDetector
+from faceswitch.core.types import FaceBox
+
+__all__ = ["FaceBox", "FaceDetector"]

faceswitch-0.1.0/src/faceswitch/core/interfaces.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import numpy as np
+    from numpy.typing import NDArray
+
+from faceswitch.core.types import FaceBox
+
+
+class FaceDetector(ABC):
+    """Contract for face detector implementations."""
+
+    @abstractmethod
+    def detect(self, image: "NDArray[np.uint8]") -> list[FaceBox]:
+        """Return detected faces from a numpy image array.
+        
+        Args:
+            image: Input image as numpy array (uint8, grayscale or BGR/RGB).
+            
+        Returns:
+            List of FaceBox objects containing detected face locations.
+        """
+        raise NotImplementedError

faceswitch-0.1.0/src/faceswitch/core/types.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class FaceBox:
+    """Face bounding box in xyxy format."""
+
+    x1: int
+    y1: int
+    x2: int
+    y2: int
+    confidence: float | None = None

faceswitch-0.1.0/src/faceswitch/detectors/__init__.py

@@ -0,0 +1,5 @@
+"""Detector implementations."""
+
+from faceswitch.detectors.hog import HogDetector, HogDetectorConfig
+
+__all__ = ["HogDetector", "HogDetectorConfig"]

faceswitch-0.1.0/src/faceswitch/detectors/hog/__init__.py

@@ -0,0 +1,6 @@
+"""HOG detector package."""
+
+from faceswitch.detectors.hog.config import HogDetectorConfig
+from faceswitch.detectors.hog.detector import HogDetector
+
+__all__ = ["HogDetector", "HogDetectorConfig"]

faceswitch-0.1.0/src/faceswitch/detectors/hog/config.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class HogDetectorConfig:
+    """Configuration for dlib HOG detector."""
+
+    upsample_times: int = 1

faceswitch-0.1.0/src/faceswitch/detectors/hog/detector.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import numpy as np
+from numpy.typing import NDArray
+
+from faceswitch.core.interfaces import FaceDetector
+from faceswitch.core.types import FaceBox
+from faceswitch.detectors.hog.config import HogDetectorConfig
+
+
+class HogDetector(FaceDetector):
+    """HOG-based frontal face detector using dlib."""
+
+    def __init__(self, config: HogDetectorConfig | None = None) -> None:
+        """Initialize and cache dlib's frontal face detector."""
+        try:
+            import dlib  # type: ignore
+        except ImportError as exc:
+            raise ImportError(
+                "HogDetector requires optional dependency 'dlib'. "
+                "Install with: pip install 'faceswitch[hog]'"
+            ) from exc
+
+        self.config = config or HogDetectorConfig()
+        self._detector = dlib.get_frontal_face_detector()
+
+    def detect(self, image: NDArray[np.uint8]) -> list[FaceBox]:
+        """Detect faces from a numpy ndarray (uint8, grayscale or BGR/RGB image)."""
+        if image is None:
+            return []
+
+        if len(image.shape) == 3:
+            gray = (
+                0.114 * image[:, :, 0] + 0.587 * image[:, :, 1] + 0.299 * image[:, :, 2]
+            ).astype("uint8")
+        else:
+            gray = image
+
+        detections = self._detector(gray, self.config.upsample_times)
+        return [
+            FaceBox(
+                x1=int(face.left()),
+                y1=int(face.top()),
+                x2=int(face.right()),
+                y2=int(face.bottom()),
+                confidence=None,
+            )
+            for face in detections
+        ]

faceswitch-0.1.0/src/faceswitch.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: faceswitch
+Version: 0.1.0
+Summary: Simple multi-model face detection library
+Author: FaceSwitch Contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/yourusername/faceswitch
+Project-URL: Bug Tracker, https://github.com/yourusername/faceswitch/issues
+Project-URL: Documentation, https://github.com/yourusername/faceswitch/blob/main/README.md
+Keywords: face-detection,computer-vision,hog,dlib
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: hog
+Requires-Dist: dlib>=19.24; extra == "hog"
+Provides-Extra: examples
+Requires-Dist: opencv-python>=4.8; extra == "examples"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# FaceSwitch
+
+FaceSwitch is an installable Python library for face detection backends.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+Install the HOG backend dependency:
+
+```bash
+pip install -e '.[hog]'
+```
+
+## Minimal Usage
+
+```python
+import cv2
+from faceswitch import HogDetector
+
+image = cv2.imread("tests/Lenna_test_image.png")
+detector = HogDetector()
+faces = detector.detect(image)
+print(f"Detected: {len(faces)}")
+```
+
+## Example Script
+
+```bash
+pip install -e '.[hog,examples]'
+python examples/demo_hog.py tests/Lenna_test_image.png
+```

faceswitch-0.1.0/src/faceswitch.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+README.md
+pyproject.toml
+src/faceswitch/__init__.py
+src/faceswitch/py.typed
+src/faceswitch.egg-info/PKG-INFO
+src/faceswitch.egg-info/SOURCES.txt
+src/faceswitch.egg-info/dependency_links.txt
+src/faceswitch.egg-info/requires.txt
+src/faceswitch.egg-info/top_level.txt
+src/faceswitch/core/__init__.py
+src/faceswitch/core/interfaces.py
+src/faceswitch/core/types.py
+src/faceswitch/detectors/__init__.py
+src/faceswitch/detectors/hog/__init__.py
+src/faceswitch/detectors/hog/config.py
+src/faceswitch/detectors/hog/detector.py
+tests/test_hog_detector.py
+tests/test_public_api.py

faceswitch-0.1.0/src/faceswitch.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

faceswitch-0.1.0/src/faceswitch.egg-info/requires.txt

@@ -0,0 +1,9 @@
+
+[dev]
+pytest>=8.0
+
+[examples]
+opencv-python>=4.8
+
+[hog]
+dlib>=19.24

faceswitch-0.1.0/src/faceswitch.egg-info/top_level.txt

@@ -0,0 +1 @@
+faceswitch

faceswitch-0.1.0/tests/test_hog_detector.py

@@ -0,0 +1,34 @@
+import importlib.util
+from pathlib import Path
+
+import pytest
+
+from faceswitch import HogDetector
+
+
+def test_hog_detector_optional_dependency_behavior() -> None:
+    has_dlib = importlib.util.find_spec("dlib") is not None
+
+    if has_dlib:
+        detector = HogDetector()
+        assert detector is not None
+    else:
+        try:
+            HogDetector()
+            assert False, "Expected ImportError when dlib is missing"
+        except ImportError as exc:
+            assert "faceswitch[hog]" in str(exc)
+
+
+def test_hog_detector_detects_lenna_face() -> None:
+    pytest.importorskip("dlib")
+    cv2 = pytest.importorskip("cv2")
+
+    image_path = Path(__file__).parent / "assets" / "Lenna_test_image.png"
+    image = cv2.imread(str(image_path))
+    assert image is not None, f"Could not read test image: {image_path}"
+
+    detector = HogDetector()
+    faces = detector.detect(image)
+
+    assert len(faces) >= 1

faceswitch-0.1.0/tests/test_public_api.py

@@ -0,0 +1,7 @@
+from faceswitch import FaceBox, FaceDetector, HogDetector
+
+
+def test_public_api_exports_classes() -> None:
+    assert isinstance(FaceBox, type)
+    assert isinstance(FaceDetector, type)
+    assert isinstance(HogDetector, type)