# AGENTS.md

The world's simplest facial recognition api for Python and the command line

## Setup

```
pip install -r requirements.txt
```

## Commands

```
make try
make except
make help
make clean
make clean-build
make clean-pyc
```

## Layout

- `examples/`         22 source files
- `face_recognition/` 4 source files
- `tests/`            2 source files
- `docs/`             1 source file

## Conventions

- Tests live alongside the code they cover, following `examples/knn_examples/test/alex_lacamoire1.jpg`.
- CI defines what passing means. See `.github/workflows/main.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.