HEStimate API

FastAPI API for face verification and comparison using DeepFace.

Prerequisites

• Python 3.11+

---

Installation

• Create a venv and activate it following the python doc
• Install the requirements

pip install -r requirements.txt

Run the API locally

fastapi dev main.py

The API will be available at:

http://127.0.0.1:8000/

Documentation

FastAPI automatically generates an interactive documentation at:

http://127.0.0.1:8000/docs

Unit Tests

Run the tests:

pytest -q

Coverage

To measure the test coverage of the project:

coverage run -m pytest
coverage report -m

You can also generate an HTML report for easier navigation:

coverage html