Metadata-Version: 2.1
Name: face-mask-detector
Version: 0.2.2
Summary: A library and command line utility 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
Keywords: face-mask-detection,face-mask,covid-19,machine-learning,computer-vision
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: imutils (==0.5.3)
Requires-Dist: importlib-resources (==3.0.0)
Requires-Dist: numpy (==1.19.0)
Requires-Dist: opencv-python (==4.3.0.36)
Requires-Dist: tensorflow (==2.2.0)
Requires-Dist: pillow (==7.2.0)
Requires-Dist: scikit-learn (==0.23.1)
Requires-Dist: compose (==1.1.1)
Requires-Dist: matplotlib (==3.2.2)
Provides-Extra: dev
Requires-Dist: black (==19.10b0) ; extra == 'dev'
Requires-Dist: mypy (==0.770) ; extra == 'dev'
Requires-Dist: pytest (==5.4.3) ; extra == 'dev'
Requires-Dist: typing (==3.7.4.1) ; extra == 'dev'

<div align="center">

# face-mask-detector
![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 command line utility for detecting face masks in images and video streams**

![Demo Gif](docs/assets/demo.gif)

<img src="docs/assets/before-and-after-face-mask-detection-example.png" width="450">

</div>

Install
---------------

As always, the use of a python [virtual
environment](https://docs.python.org/3/tutorial/venv.html) is recommended for a
development setup:

``` sh
python -m venv venv
source venv/bin/activate
```

To install using `pip`:

``` sh
pip install face-mask-detector
```

Quick Start
-------------

To detect face masks in a image, run:

```sh
face-mask-detector --image path/to/image
```

To start your webcam and detect face masks in the video stream, run:

```sh
face-mask-detector
```

Contribute
-------------

I :heart: pull requests and defect reports - I welcome contributions of any kind!

To install `face-mask-detector` from source, clone this repository and run the
following in the project root directory:

```sh
pip install -e '.[dev]'
```


