agentreadme

Report · marked 25 Aug 2026

Textualize/rich

An agent can work here, but it will waste turns finding its footing.

Python · 57,240 stars · 553 files · branch main

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Pinned runtime version
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

The full marking

Every deduction below names the file or setting it came from.

Instructions 3/27 F

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
README as an entry point 3/3
README has a clear getting-started section.
Setup 12/14 A

Whether an agent can install the project and get it running without a human.

Deterministic install 6/6
poetry.lock pins the dependency tree.
Found poetry.lock
Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
Pinned runtime version 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 24/25 A+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 8/8
68 test files against 213 source files.
e.g. tests/__init__.py, tests/_card_render.py, tests/conftest.py
Test command is discoverable 7/7
An agent can find and run `make test`.
Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
pyproject.toml encodes the house style.
Static type checking 2/3
Type checking is configured, but not in strict mode.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 17/20 A

Whether the repo fits in a context window, or fights it.

No committed build output 6/6
No generated directories committed.
.gitignore hygiene 3/3
.gitignore covers 74 patterns.
File sizes fit in context 4/6
1 source file is over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
rich/_emoji_codes.py — 137KB
Repository weight 4/5
About 50.6MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for Textualize/rich
# AGENTS.md

Rich is a Python library for rich text and beautiful formatting in the terminal.

## Setup

```
poetry install
```

## Commands

```
make test               # run the test suite, must pass before any commit
make test-no-cov
make format-check
make format             # format
make typecheck          # type check without emitting
make typecheck-report
```

## Layout

- `rich/`       100 source files
- `tests/`      67 source files
- `examples/`   36 source files
- `tools/`      5 source files
- `benchmarks/` 3 source files
- `docs/`       1 source file

## Conventions

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

## Gotchas

- `rich/_emoji_codes.py` is 137KB. 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.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/Textualize/rich.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 69 out of 100

[![agent ready](https://agentreadme.com/badge/Textualize/rich.svg)](https://agentreadme.com/Textualize/rich)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 66 B yt-dlp/yt-dlp 54 C+ Significant-Gravitas/AutoGPT 63 B microsoft/markitdown 46 C

All Python repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in