feat: Add SKILL.md for keplergl python package#3429
Open
Copilot wants to merge 18 commits into
Open
Conversation
Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/b75ca334-0504-44a7-8f53-3418eebc3f65 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
lixun910
May 9, 2026 17:42
View session
Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/d4f6dcf5-876f-43cc-9faf-1c9cd60bd9fd Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
…and update README Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/098df374-1773-49d4-8a4c-e13a34df7c47 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
… skills protocol Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/098df374-1773-49d4-8a4c-e13a34df7c47 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
…l and update README Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/098df374-1773-49d4-8a4c-e13a34df7c47 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
…ional step Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/b1583189-44ad-47cf-947d-453f2fcfd433 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
…kflow in SKILL Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/55d2a3b1-1d4e-4eaa-af09-c8f5f26ad2b9 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
lixun910
changed the title
lixun910
approved these changes
May 9, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Claude Code skill documentation to the Python bindings so AI assistants can reliably generate keplergl maps/configs (including the new default guidance for quantitative styling).
Changes:
- Introduces
bindings/python/SKILL.mdwith keplergl usage rules + explicit defaults (quantile scale + vibrant palette) and guidance for custom breaks. - Adds per-layer “skill reference” markdowns with ready-to-adapt config examples.
- Updates
bindings/python/README.mdwith instructions for using/installing the skill with Claude Code.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| bindings/python/SKILL.md | New top-level skill instructions, API summary, defaults, and a quantitative styling example |
| bindings/python/skill-references/arc-line-map.md | New arc/line layer reference example/config |
| bindings/python/skill-references/geojson-polygon-map.md | New GeoJSON/polygon layer reference example/config |
| bindings/python/skill-references/h3-hexagon-map.md | New H3 hexagonId layer reference example/config |
| bindings/python/skill-references/heatmap.md | New heatmap layer reference example/config |
| bindings/python/skill-references/hexbin-aggregation-map.md | New hexagon aggregation layer reference example/config |
| bindings/python/skill-references/point-map.md | New point layer reference example/config |
| bindings/python/skill-references/trip-animation-map.md | New trip layer reference example/config |
| bindings/python/README.md | New “Use with AI Coding Assistants” section and Claude Code skill installation instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
@copilot apply changes based on the comments in this thread |
Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/d4300622-677a-4b98-81ca-4cd43ad5e5c5 Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
Author
Applied the requested review-thread updates across SKILL/README/reference docs in commit |
Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/dca4bbac-713d-451b-9f10-0a76a069c50c Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/dca4bbac-713d-451b-9f10-0a76a069c50c Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
Collaborator
|
@copilot apply changes based on the comments in this thread |
… API docs Agent-Logs-Url: https://github.com/keplergl/kepler.gl/sessions/3e282275-ba68-458f-a020-3816c8f0b74b Co-authored-by: lixun910 <2423887+lixun910@users.noreply.github.com>
Author
Applied all four review comments in
|
… visualChannels guidance - Added requirement for `kepler.gl-jupyter >= 0.4.0` to ensure compatibility with examples. - Clarified that `colorField`, `colorScale`, `sizeField`, and `heightField` should be placed under `visualChannels` instead of `config` to avoid silent errors. - Included a new example for creating a GeoJSON choropleth map using visual channels.
…://github.com/keplergl/kepler.gl into copilot/xli-kepler-jupyter-skill-add-skill-md
- Introduced `cursor-plugin.json` and `plugin.json` to define the keplergl-map skill for interactive map visualizations. - Updated `README.md` to include references to the new summary panel feature. - Added SVG icons for the skill in both small and large sizes. - Created `summary-panel.md` to document the overlay feature for exported HTML maps. - Added `openai.yaml` for agent configuration related to the keplergl-map skill.
- Expanded the setup instructions in README.md to include Codex alongside Claude Code. - Modified the `.save_to_html` method in SKILL.md to set `read_only` to false by default, enhancing usability.
- Deleted `cursor-plugin.json`, `plugin.json`, and `SKILL.md` as they are no longer needed. - Removed associated SVG icons and YAML configuration for the OpenAI agent. - Cleaned up the README.md by removing references to the now-removed files and features.
- Added a step to build and zip the source package for the kepler.gl skill in the GitHub Actions workflow. - Updated the version in `plugin.json` from 1.0.0 to 0.0.1 to reflect a new release.
- Added specific download links for the kepler.gl skill for Claude, Codex, and source versions. - Clarified installation instructions for better user guidance.
lixun910
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces a kepler.gl skill designed for Claude Code, Codex etc. By leveraging the
kepler.gl-jupyterPython package, this skill enables agents to visualize geospatial results directly within existing workflows.Users can just prompt
to install this
kepler.glskillExample using kepler.gl skill in Codex:
Untitled.mp4