agentreadme

Report · marked 25 Aug 2026

pathwaycom/pathway

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

Python · 62,388 stars · 2,512 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
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.

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/20 B+

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

Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
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 rust-toolchain.toml
Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 22/22 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
258 test files against 1061 source files.
e.g. .github/workflows/mac_test.yml, .github/workflows/package_test.yml, .github/workflows/ubuntu_test.yml
Test command is discoverable 7/7
An agent can find and run `pytest`.
Continuous integration 4/4
5 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
clippy.toml encodes the house style.
Static type checking n/a
Not applicable — the Rust compiler type checks every build.
Context economy 13/20 B

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 16 patterns.
File sizes fit in context 0/6
11 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.
python/pathway/web_dashboard/frontend/assets/index-BCRWi5Lr.js — 2078KB
src/python_api.rs — 341KB
src/engine/dataflow.rs — 269KB
Repository weight 4/5
About 145.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 pathwaycom/pathway
# AGENTS.md

Python ETL framework for stream processing, real-time analytics, LLM pipelines, and RAG.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `python/`            322 source files
- `external/`          291 source files
- `src/`               142 source files
- `integration_tests/` 118 source files
- `docs/`              78 source files
- `examples/`          72 source files

## Conventions

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

## Gotchas

- `python/pathway/web_dashboard/frontend/assets/index-BCRWi5Lr.js` is 2078KB. 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/pathwaycom/pathway.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 60 out of 100

[![agent ready](https://agentreadme.com/badge/pathwaycom/pathway.svg)](https://agentreadme.com/pathwaycom/pathway)

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