Metadata-Version: 2.1
Name: face-mask-detector
Version: 0.2.0
Summary: A library and tool for detecting face masks in images and video streams
Home-page: https://github.com/senofsky/face-mask-detector
Author: Mark V Senofsky
Author-email: mark.v.senofsky@gmail.com
License: MIT
Description: face-mask-detector
        ----------------------
        
        ![Example Image](docs/before-and-after-face-mask-detection-example.png)
        
        ![PyPI - License](https://img.shields.io/pypi/l/face-mask-detector?style=flat)
        [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/senofsky/face-mask-detector/issues)
        
        A library and tool for detecting face masks in images and video streams
        
        Installation
        ---------------
        
        To install `face-mask-detector` from source, clone this repository and run the
        following in the project root directory:
        
        ```
        pip install -e '.[dev]'
        ```
        
        As always, the usage of a python [virtual
        environments](https://docs.python.org/3/tutorial/venv.html) is recommended for a
        development setup.
        
        Quick Start
        -------------
        
        All commands are expected to be run in the project root directory.
        
        To detect face masks in a image, run:
        
        ```
        python scripts/detect_face_mask_in_image.py --image path/to/image
        ```
        
        To start your webcam and detect face masks in the video stream, run:
        
        ```
        python scripts/detect_face_masks_in_webcam_video_stream.py
        ```
        
        To train the face-mask-detector model, run:
        
        ```
        make model
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: dev
