PyGWalker is a Python library that turns a pandas dataframe into an interactive interface for exploring, cleaning, annotating, and visualizing data. It is used in Jupyter Notebook by people who want drag-and-drop data analysis or natural-language queries instead of writing every visualization manually.
Borrowing it
Nothing to install: this file belongs to Kanaries/pygwalker. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/Kanaries/pygwalker/main/AGENTS.mdgit clone --depth 1 https://github.com/Kanaries/pygwalkerWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/kanaries/pygwalker/agents-md)<a href="https://agentmods.dev/instructions/kanaries/pygwalker/agents-md"><img src="https://agentmods.dev/badge/instructions/kanaries/pygwalker/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/kanaries/pygwalker/agents-md"><img src="https://agentmods.dev/badge/instructions/kanaries/pygwalker/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.02990 | $0.02990 |
| Opus 5.5 | $0.01196 | $0.01196 |
| Sonnet 5.5 | $0.00598 | $0.00598 |
| Haiku 4.5 | $0.00299 | $0.00299 |
Grade A, and why
pygwalker AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 216 lines — stays where its author put it; the contents beside it link to each section on GitHub.
AGENTS.md — PyGWalker contributor & agent guide
This is the fast-start map of the PyGWalker repo for both human contributors and coding agents. It explains how the project is put together, how to run it in dev mode with live frontend reload, and where all the logs go. Read this first — it is written to save you from re-deriving the architecture by grepping.
Deeper references:
docs/ARCHITECTURE.md(how it is built),docs/DEVELOPMENT.md(dev workflow + troubleshooting),docs/CONTRIBUTING.md(validation & CI).
1. What PyGWalker is (30-second model)
PyGWalker turns a pandas / polars / pyarrow dataframe into an interactive Graphic Walker UI inside notebooks, Streamlit, and plain web servers. It has two halves that ship together:
- Python package (
pygwalker/) — public API (walk,render,table,Walker,to_html), data parsing, and the transports that talk to the UI. - Frontend app (
app/, React + Vite) — the UI. It is compiled into JavaScript bundles that are checked into the wheel underpygwalker/templates/dist/and loaded by the Python side at render time.
The Python side never renders charts itself; it hands built JS + serialized data to a notebook/browser and then answers data/spec requests over a message channel.
2. Repo map
| Path | What lives here |
|---|---|
pygwalker/api/ |
Public entry points. adapter.py picks jupyter vs webserver; jupyter.py = notebook dispatch; walker.py = the reusable Walker; pygwalker.py = the core PygWalker. |
pygwalker/services/ |
Rendering + display. anywidget_widget.py (default transport), render.py + templates/*.html (iframe transport), global_var.py (runtime globals), jupyter_display.py. |
pygwalker/communications/ |
Kernel⇄frontend transports: anywidget_comm.py (default), hacker_comm.py (iframe), streamlit_comm.py, gradio_comm.py, reflex_comm.py. protocol.py is the shared message schema. |
pygwalker/data_parsers/ |
Dataframe/connector adapters (pandas, polars, pyarrow, SQL, spark…). |
pygwalker/templates/dist/ |
Build output (git-ignored). The JS bundles the Python side loads. |
pygwalker/utils/ |
Helpers: frontend_assets.py (locate/load bundles), log.py (logging), encoders. |
app/src/ |
Frontend source. index.tsx = entry; utils/communication.tsx = transports; dataSource/ = data ingest; interfaces/comm.generated.ts = generated protocol types; store/ = MobX state. |
scripts/ |
dev.py (dev orchestrator), compile.sh (build frontend), local_ci.py (mirror CI), generate_comm_protocol_ts.py (regenerate protocol types). |
tests/ |
Python tests + *.ipynb notebooks run by nbmake. app/tests/ holds Playwright smoke tests. |
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 2mo ago First seen · 216 lines · 2,990 tokens per session scan A a084b376225d
pygwalker AGENTS.md is an instructions file published in the GitHub repository Kanaries/pygwalker (16,003 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 2,990 tokens to every session, about $0.0120 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
pygwalker AGENTS.md compared with instructions from other repositories
| Mod | Type | Stars | Last push | Licence | Scan | Tokens | Works with |
|---|---|---|---|---|---|---|---|
| pygwalker AGENTS.mdKanaries/pygwalker | Instructions file | 16k | 2mo ago | Apache-2.0 | A | 2,990 | Codex, OpenCode |
| vscode buildNext.instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 9,719 | GitHub Copilot |
| next.js AGENTS.mdvercel/next.js | Instructions file | 143k | today | MIT | A | 7,461 | Codex, OpenCode |
| vscode oss-third-party-notices.instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 5,516 | GitHub Copilot |
| langchain AGENTS.mdlangchain-ai/langchain | Instructions file | 149k | today | MIT | A | 4,680 | Codex, OpenCode |
| vscode copilot-instructions.mdmicrosoft/vscode | Instructions file | 195k | today | MIT | A | 3,093 | GitHub Copilot |
| deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness | Instructions file | 274k | 2d ago | MIT | A | 4,313 | Codex, OpenCode |