# AGENTS.md

🕵️‍♂️ Collect a dossier on a person by username from 3000+ sites

## Setup

```
poetry install
```

## Commands

```
make test          # run the test suite, must pass before any commit
make rerun-tests
make lint          # lint
make speed
make format        # format
make pull
```

## Layout

- `tests/`       29 source files
- `maigret/`     20 source files
- `utils/`       13 source files
- `docs/`        2 source files
- `pyinstaller/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/build-docker-image.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.