Metadata-Version: 2.5
Name: kedro-skills
Version: 0.3.0
Summary: Distribute AI coding skills to Kedro projects.
Project-URL: Homepage, https://github.com/kedro-org/kedro-skills
Project-URL: Source, https://github.com/kedro-org/kedro-skills
Project-URL: Tracker, https://github.com/kedro-org/kedro-skills/issues
Author: Kedro
License: Apache Software License (Apache 2.0)
License-File: LICENSE
Keywords: AGENTS.md,AI,Kedro,data engineering,data science,skills
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: click>=8.0
Requires-Dist: kedro>=1.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Requires-Dist: mypy>=1.12.1; extra == 'dev'
Requires-Dist: pre-commit>=4.3.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.11.2; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
Description-Content-Type: text/markdown

# kedro-skills

[![Python Version](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://pypi.org/project/kedro-skills/)
[![PyPI Version](https://img.shields.io/pypi/v/kedro-skills.svg)](https://pypi.org/project/kedro-skills/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

Distribute AI coding skills to Kedro projects. One command installs contextual
guidance selected by the task or matching files — across Cursor, GitHub Copilot,
Claude Code, and Codex CLI.

## Installation

```bash
pip install kedro-skills
```

## Quick start

```bash
# Inside any Kedro project:
kedro skills list
kedro skills install kedro-catalog-config
```

This writes managed files into your Kedro project. They should be committed to git so
the whole team benefits.

Outside a Kedro project, the commands use the current directory instead.

## Available skills

| Skill | Activates on | Guidance |
|-------|--------------|----------|
| `kedro-build-demo` | Requests for a new demo or proof of concept | A new, small end-to-end Kedro demo with a working result, an offline HTML walkthrough and Kedro-Viz guidance; other audience material only on request |
| `kedro-catalog-config` | `conf/**/*.yml`, `conf/**/*.yaml` | Data catalog entries: dataset types, factories, credentials, interpolation |
| `kedro-deploy-databricks` | `databricks.yml`, `resources/*.yml`, `conf/**/databricks*.yml`, `conf/**/databricks/**/*.yml`, `.github/workflows/*databricks*.yml` (and `.yaml`) | Deploying to Databricks: choosing a path, packaging, conf and environments, volumes, secrets, nodes to tasks, checking before deploying |
| `kedro-explain-project` | `src/**/pipeline_registry.py`, `src/**/settings.py` | Explaining an existing project: pipelines, data flow, catalog, configuration and Kedro-Viz |
| `kedro-llm-context-nodes` | `src/**/pipelines/**/*.py` | The `llm_context_node` API for composing LLMs, prompts and tools |
| `kedro-parameters-and-config` | `conf/**/parameters*.yml` and `conf/**/credentials*.yml` | Parameters, credentials, configuration interpolation and runtime overrides. |
| `kedro-testing-pipelines` | `tests/**/*.py` | Node unit tests, in-memory pipeline tests and `KedroSession` smoke tests |

## What it writes

```
my-kedro-project/
├── .agents/skills/kedro-catalog-config/SKILL.md              # canonical (Agent Skills standard)
├── AGENTS.md                                                 # content discovery (Cursor, Copilot, Codex CLI)
├── .cursor/rules/kedro-catalog-config.mdc                    # glob-scoped activation (Cursor)
├── .github/instructions/kedro-catalog-config.instructions.md # glob-scoped activation (Copilot)
└── .claude/skills/kedro-catalog-config/SKILL.md              # Claude Code (inline copy, always discoverable)
```

`AGENTS.md` is the content-discovery channel — one file reaches Cursor, Copilot,
and Codex CLI. `.cursor/rules/` and
`.github/instructions/` add glob-scoped activation for skills with file patterns.
Skills with `paths: []`, such as `kedro-build-demo`, use their descriptions instead:
their wrappers omit file patterns, and their AGENTS.md blocks apply only to
matching requests. They can be installed in an empty folder before a project exists.

If you installed the earlier PR preview as `build-demo`, run
`kedro skills uninstall build-demo` with that preview still installed, before
upgrading the package. Then install `kedro-build-demo`. The preview name is not
an alias for the new name.

## CLI reference

| Command | Description |
|---------|-------------|
| `kedro skills list` | Show available skills and their install status |
| `kedro skills install <id>` | Install a skill for all supported IDEs |
| `kedro skills install --all` | Install every available skill |
| `kedro skills install --ide cursor,claude` | Restrict to specific IDEs |
| `kedro skills install --force` | Overwrite even if files were hand-edited |
| `kedro skills update` | Re-render all installed skills (picks up package upgrades) |
| `kedro skills update --force` | Overwrite modified files during update |
| `kedro skills uninstall <id>` | Remove a skill and all its managed files |
| `kedro skills uninstall --force` | Remove even if files were hand-edited |

## IDE-specific notes

- **Claude Code:** Reads `.claude/skills/<id>/SKILL.md` directly. The skill is always discoverable (no `paths:` scoping in the Claude copy). If you want `AGENTS.md` content in Claude sessions too, add `@AGENTS.md` to a `CLAUDE.md` file.
- **Cursor:** `.cursor/rules/*.mdc` uses `globs:` for matching files, or a description with `alwaysApply: false` for agent-selected relevance when no paths are specified.
- **GitHub Copilot:** `.github/instructions/*.instructions.md` uses `applyTo:` for matching files, or a description for on-demand discovery when no paths are specified.
- **Codex CLI:** Reads `AGENTS.md` natively. Each skill block states whether it applies to matching files or matching requests.

## How to try it out

```bash
# Install kedro-skills from source (in the kedro-skills repo root)
pip install .

# Create a test Kedro project
pip install kedro
kedro new --name test-project -s spaceflights-pandas
cd test-project

# See what's available
kedro skills list

# Install the kedro-catalog-config skill
kedro skills install kedro-catalog-config

# Check what was written
ls .agents/skills/kedro-catalog-config/SKILL.md
cat AGENTS.md
ls .cursor/rules/
ls .github/instructions/
ls .claude/skills/kedro-catalog-config/

# Running install again is safe — nothing changes
kedro skills install kedro-catalog-config --ide cursor,copilot,claude

# If you hand-edit a managed file, update will let you know
echo "modified" > .cursor/rules/kedro-catalog-config.mdc
kedro skills update          # refuses and names the modified file
kedro skills update --force  # overwrites your edit with the managed version

# Clean removal when you no longer need a skill
kedro skills uninstall kedro-catalog-config
kedro skills list            # back to "not installed"
```

## Telemetry

When [`kedro-telemetry`](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-telemetry)
is installed (it ships with Kedro), the `install`, `update` and `uninstall`
commands report anonymous usage events:

| Event | Properties |
|---|---|
| `kedro_skills_install` | `skill_id`, `target_ides` (sorted, comma-separated), `install_all` (whether `--all` was used), `success` |
| `kedro_skills_update` | `skills_updated` (count), `drift_detected` (whether locally modified skill files were found), `success` |
| `kedro_skills_uninstall` | `skill_id` |

Skill ids are reported when they match a skill shipped with this package;
anything else is sent as `unknown`. `kedro skills list` sends no event. No
skill content, file paths, project details or personal data are ever sent.
The standard
[Kedro telemetry opt-out](https://docs.kedro.org/en/stable/about/telemetry/)
(`DO_NOT_TRACK`, `KEDRO_DISABLE_TELEMETRY`, or a `.telemetry` file with
`consent: false`) disables these events too.

## Development

See [README_DEV.md](README_DEV.md) for setup, running tests, authoring skills, and releasing.

## Links

- [Agent Skills standard](https://agentskills.io/)
- [Kedro docs](https://docs.kedro.org)
