# AGENTS.md

💫 Industrial-strength Natural Language Processing (NLP) in Python

## Setup

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

## Commands

```
make version
make package
make test      # run the test suite, must pass before any commit
make clean
```

## Layout

- `spacy/`   872 source files
- `website/` 79 source files
- `bin/`     4 source files
- `extra/`   1 source file

## Conventions

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

## Gotchas

- `spacy/lang/fr/_tokenizer_exceptions_list.py` is 352KB. It will not fit comfortably in context, so read it in parts.
- 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.