faceswitch 0.1.0__py3-none-any.whl

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/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/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/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/detectors/__init__.py

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

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/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/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,14 @@
+faceswitch/__init__.py,sha256=CfMUboGJXNY-jAYow2WGLc2pFHIE3nSd_YsFsKkVaIE,297
+faceswitch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+faceswitch/core/__init__.py,sha256=oX4Jx0RnS8D7OTOOfasbX7OJ6m1xhIH5fOE8L1rjHHw,195
+faceswitch/core/interfaces.py,sha256=brbsKWNez65PCKfDD7Nd7cs2Njh4EYdg9IqTMiw2aQo,703
+faceswitch/core/types.py,sha256=nTrzwxnmlhqU47bZ-Vuot0Fix3oeue45IP_C0jbW-lA,240
+faceswitch/detectors/__init__.py,sha256=fW0Ym2U0tbJTZDaZ-h9V2qVZpomgnrTYoAC9f4JdM1w,149
+faceswitch/detectors/hog/__init__.py,sha256=4zGIkQBGFT64eGiitXCK37ByPmkMn2zX2CNqJ0b85ew,197
+faceswitch/detectors/hog/config.py,sha256=l7QAPqQMBnhdpC-Sv5wRNc_UqbOS-3h__fM5xE3Rtyw,197
+faceswitch/detectors/hog/detector.py,sha256=Fs-UVMQzKZf0ejI8z_yGr1zdok1ylbpq-Bqm6dVP9wU,1620
+faceswitch-0.1.0.dist-info/licenses/LICENSE,sha256=u3OZilfgdcUEli-0GiNoTHjfcBN7kPAGGa0W0Yf1wck,1067
+faceswitch-0.1.0.dist-info/METADATA,sha256=hP8ctXwQ_YU-Qrr4JmoFuhSQ3pIzxNlMsb-ohvuYFrc,1778
+faceswitch-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+faceswitch-0.1.0.dist-info/top_level.txt,sha256=uwNxCDMFWivgtcpl3RhrH4DDfegs2i4Arh4SFXucuB0,11
+faceswitch-0.1.0.dist-info/RECORD,,

faceswitch-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

faceswitch-0.1.0.dist-info/licenses/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.dist-info/top_level.txt

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