agentreadme

Report · marked 26 Aug 2026

satwikkansal/wtfpython

An agent will struggle here, mostly for fixable reasons.

Python · 37,063 stars · 44 files · branch master

47 /100 C
Instructions 0/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 6/14Whether an agent can install the project and get it running without a human. Losing marks on discoverable commands and pinned runtime version.Verification loop 11/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and lint and format rules.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

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

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
Tests exist
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.

The full marking

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

Instructions 0/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 0/3
No README. This is the first file anything reads, human or machine.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 6/14 C

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 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
–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 11/25 C

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

✗Tests exist 0/8
No test files found. An agent has no way to know whether its change broke anything.
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.
✓Test command is discoverable 7/7
An agent can find and run `pytest`.
✓Continuous integration 4/4
1 GitHub Actions workflow define what "passing" means.
✗Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
✗Static type checking 0/3
No static type checking.
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 20/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 12 patterns.
✓File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
✓Repository weight 5/5
About 1.5MB 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 satwikkansal/wtfpython 
# AGENTS.md

What the f*ck Python? 😱

## Setup

```
poetry install
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `irrelevant/` 4 source files
- `snippets/`   2 source files

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- CI defines what passing means. See `.github/workflows/pr.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/satwikkansal/wtfpython.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 47 out of 100

[![agent ready](https://agentreadme.com/badge/satwikkansal/wtfpython.svg)](https://agentreadme.com/satwikkansal/wtfpython)

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