Skip to content

docs: add README section for AI coding assistants #1503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timsaucer merged 1 commit into from
Apr 24, 2026
+16 −0
Merged

docs: add README section for AI coding assistants #1503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,22 @@ You can verify the installation by running:
'0.6.0'
```

## Using DataFusion with AI coding assistants

This project ships a [`SKILL.md`](SKILL.md) at the repo root that teaches AI
coding assistants how to write idiomatic DataFusion Python. It follows the
[Agent Skills](https://agentskills.io) open standard.

**Preferred:** `npx skills add apache/datafusion-python` — installs the skill in
Claude Code, Cursor, Windsurf, Cline, Codex, Copilot, Gemini CLI, and other
supported agents.

**Manual:** paste this line into your project's `AGENTS.md` / `CLAUDE.md`:

```
For DataFusion Python code, see https://github.com/apache/datafusion-python/blob/main/SKILL.md
```

## How to develop

This assumes that you have rust and cargo installed. We use the workflow recommended by [pyo3](https://github.com/PyO3/pyo3) and [maturin](https://github.com/PyO3/maturin). The Maturin tools used in this workflow can be installed either via `uv` or `pip`. Both approaches should offer the same experience. It is recommended to use `uv` since it has significant performance improvements
Expand Down
Loading