# AGENTS.md

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

## Setup

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

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `deeptutor/`     740 source files
- `web/`           581 source files
- `tests/`         475 source files
- `deeptutor_cli/` 21 source files
- `scripts/`       11 source files
- `deeptutor_web/` 1 source file

## Conventions

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

## Gotchas

- `deeptutor/api/routers/knowledge.py` is 130KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.
- 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.