# AGENTS.md

The lean application framework for Python.  Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and a web browser.

## Setup

```
uv sync
```

## Commands

```
make run
make test                   # run the test suite, must pass before any commit
make testv
make test-snapshot-update
make test-coverage
make coverage
```

## Layout

- `tests/`    410 source files
- `docs/`     314 source files
- `src/`      247 source files
- `examples/` 15 source files
- `tools/`    2 source files

## Conventions

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

## Gotchas

- `src/textual/app.py` is 180KB. 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.