Report · marked 26 Aug 2026

ocrmypdf/OCRmyPDF

Solid foundations, held back in a few specific places.

Python · 34,580 stars · 532 files · branch main

70 /100 B+

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 14/18Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop 24/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 19/20Whether the repo fits in a context window, or fights it. Losing marks on repository weight.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

Fix these first

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Environment config

Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.

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 14/18 A-

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

✓Deterministic install 6/6

uv.lock pins the dependency tree.

Found uv.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

pyproject.toml scripts

scripts/ directory

✗Environment config 2/4

Env vars are mentioned in the README but there's no example file to copy.

Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.

✗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

348 test files against 176 source files.

e.g. tests/__init__.py, tests/cache/README.rst, tests/cache/v1/2400dpi-98cf83ef/__-l__eng__000001_ocr.png__000001_ocr_hocr__hocr__txt/hocr.bin

✓Test command is discoverable 7/7

An agent can find and run `pytest`.

✓Continuous integration 4/4

3 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 19/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 38 patterns.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✗Repository weight 4/5

About 70.4MB 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 ocrmypdf/OCRmyPDF

# AGENTS.md

OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched

## Setup

```
uv sync
```

## Commands

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

## Layout

- `tests/`   83 source files
- `src/`     79 source files
- `misc/`    11 source files
- `bin/`     1 source file
- `docs/`    1 source file
- `scripts/` 1 source file

## Conventions

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

---

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/ocrmypdf/OCRmyPDF.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](https://agentreadme.com/badge/ocrmypdf/OCRmyPDF.svg)](https://agentreadme.com/ocrmypdf/OCRmyPDF)

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