# AGENTS.md

Extremely fast Query Engine for DataFrames, written in Rust

## Setup

```
cargo build
```

## Commands

```
make requirements
make requirements-all
make update-cargo-env
make build              # produce a build
make build-debug
make build-mindebug
```

## Layout

- `crates/`      2065 source files
- `py-polars/`   690 source files
- `docs/`        91 source files
- `pyo3-polars/` 31 source files
- `tools/`       2 source files

## Conventions

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

## Gotchas

- `py-polars/src/polars/dataframe/frame.py` is 505KB. It will not fit comfortably in context, so read it in parts.

---

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.