agentreadme

Report · marked 8 Oct 2026

home-assistant/core

Solid foundations, held back in a few specific places.

Python · 91,320 stars · 28,774 files · branch dev

Fix these first

01
File sizes fit in context
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.
02
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.
03
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

The full marking

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

Instructions 24/27 A

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

✓Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md, Copilot instructions
✗Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
5,551 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✗README as an entry point 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 13/20 B

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

✗Deterministic install 3/6
Only requirements.txt, which pins loosely at best.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
pyproject.toml scripts
✗Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
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 2/2
The language runtime version is pinned.
Found .python-version
✓Reproducible environment 2/2
.devcontainer/devcontainer.json gives a known-good environment.
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
13686 test files against 19319 source files.
e.g. benchmarks/test_core_events.py, benchmarks/test_core_states.py, benchmarks/test_core_template.py
✓Test command is discoverable 7/7
An agent can find and run `pytest`.
✓Continuous integration 4/4
15 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 9/20 C

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 94 patterns.
✗File sizes fit in context 0/6
56 source files are 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.
tests/helpers/test_device_registry.py — 492KB
tests/test_config_entries.py — 384KB
tests/helpers/test_script.py — 244KB
✗Repository weight 0/5
About 910MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 home-assistant/core
# AGENTS.md

:house_with_garden: Open source home automation that puts local control and privacy first.

## Setup

```
pip install -r requirements.txt
```

## Commands

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

## Layout

- `homeassistant/` 10468 source files
- `tests/`         8631 source files
- `script/`        139 source files
- `pylint/`        72 source files
- `benchmarks/`    5 source files
- `mypy_plugins/`  2 source files

## Conventions

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

## Gotchas

- `tests/helpers/test_device_registry.py` is 492KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/home-assistant/core.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Python AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

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 76 out of 100

[![agent ready](https://agentreadme.com/badge/home-assistant/core.svg)](https://agentreadme.com/home-assistant/core)

Other Python repositories, marked

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

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