Agent skill

Python API Consistency Validator

by ArabelaTso in ArabelaTso/Skills-4-SE

Validate API consistency between two versions of Python libraries.

Apache-2.0Auto-check passedSecurity

Install Python API Consistency Validator

skills CLI
$ npx skills add ArabelaTso/Skills-4-SE --skill python-api-consistency-validator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ArabelaTso/Skills-4-SE python-api-consistency-validator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ArabelaTso/Skills-4-SE.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/python-api-consistency-validator .claude/skills/python-api-consistency-validator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
python-api-consistency-validator
GitHub stars
253
Token cost
~609 tokens
SKILL.md length
154 words
Files
2 (incl. scripts)
Skills in repo
150
Repo updated
First seen
Licence
Apache-2.0

At a glance

Validate API consistency between two versions of Python libraries.

  • Works in 5 steps: Function Signatures - Parameters, return… → Class Definitions - Methods,… → Parameter Changes - Added, removed, or… → …
  • You need to compare API behavior
  • SKILL.md covers Overview, Quick Start, What Gets Validated and Validation Report, plus 2 more sections
  • Runs Python scripts from its folder; calls python

What it does

Python API Consistency Validator is an agent skill from ArabelaTso/Skills-4-SE. Validate API consistency between two versions of Python libraries. Use when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Python code, compares function signatures, class definitions, parameter types, return types, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Python libraries and packages.

Its SKILL.md is about 610 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including scripts (for example `scripts/validate.py`).

It sits in Security, covering Static analysis and SAST. It works with Python. The repository describes itself as: A curated list of 180+ useful Claude Skills for Software Engineering and resources for customizing AI for SE workflows. The licence is Apache-2.0.

When your agent uses it

  • You need to compare API behavior
  • Exceptions between library versions to identify breaking changes
  • Incompatible modifications
  • Behavior differences

Example prompts

  • “/python-api-consistency-validator”

Requirements

  • Python 3

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Function Signatures - Parameters, return types, decorators
  2. Class Definitions - Methods, inheritance, attributes
  3. Parameter Changes - Added, removed, or modified parameters
  4. Return Type Changes - Modified return types
  5. Removed APIs - Deleted functions, classes, or methods

What it can do on your machine

Read from SKILL.md and the folder at commit 4f38503. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/ (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • python

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Python API Consistency Validator loads about 609 tokens when it runs. Until then it costs about 136 tokens; SKILL.md has 154 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~136
When it runs · the whole SKILL.md, loaded when a task matches
~609

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from ArabelaTso/Skills-4-SE at commit 4f38503, republished under its Apache-2.0 licence (© ArabelaTso). 154 words, ~609 tokens.

Download SKILL.mdSave it as .claude/skills/python-api-consistency-validator/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
python-api-consistency-validator
description
Validate API consistency between two versions of Python libraries. Use when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Python code, compares function signatures, class definitions, parameter types, return types, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Python libraries and packages.

Python API Consistency Validator

Overview

This skill validates API consistency between two versions of Python libraries by comparing signatures, behavior, and exceptions. It identifies breaking changes, incompatible modifications, and provides detailed reports to guide safe API migration or upgrade.

Quick Start

bash
# Compare two versions of a Python library
python scripts/validate.py /path/to/old_version /path/to/new_version

# Specify output file
python scripts/validate.py old_lib/ new_lib/ --output report.json

What Gets Validated

  1. Function Signatures - Parameters, return types, decorators
  2. Class Definitions - Methods, inheritance, attributes
  3. Parameter Changes - Added, removed, or modified parameters
  4. Return Type Changes - Modified return types
  5. Removed APIs - Deleted functions, classes, or methods

Validation Report

The tool generates a JSON report with:

  • Breaking Changes: API removals, incompatible modifications
  • Warnings: Type changes, signature modifications
  • Info: New additions, non-breaking changes
  • Summary: Total issues by severity

Example report:

json
{
  "summary": {
    "breaking_changes": 3,
    "warnings": 5,
    "info": 2
  },
  "breaking_changes": [
    {
      "type": "function_removed",
      "name": "deprecated_func",
      "severity": "breaking",
      "message": "Function 'deprecated_func' was removed"
    }
  ]
}

Usage

bash
python scripts/validate.py <old_version_path> <new_version_path> [--output <report.json>]

The validator exits with code 1 if breaking changes are found, 0 otherwise.

Tips

  • Run validation before upgrading dependencies
  • Review breaking changes carefully
  • Check warnings for potential issues
  • Use in CI/CD pipelines to catch API changes
  • Compare against semantic versioning expectations

© ArabelaTso, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (scripts) in skills/python-api-consistency-validator of ArabelaTso/Skills-4-SE.

  • SKILL.md
  • scripts/validate.py

Open the folder on GitHubat commit 4f38503

Compare with similar skills

Python API Consistency Validator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Python API Consistency Validator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Python API Consistency Validator this skillArabelaTso/Skills-4-SE253—~609Automated safety check: PassApache-2.0
C To AstNarwhal-Lab/MagicSkills316—~1.1kAutomated safety check: PassMIT
Security Setupluongnv89/skills131—~4.5kAutomated safety check: PassMIT
CodeQL Security Scantrailofbits/skills7.4k—~4.6kAutomated safety check: NotesCC-BY-SA-4.0
Kedro Security Reviewkedro-org/kedro11k—~3.3kAutomated safety check: PassCustom licence
Skylosduriantaco/skylos843—~581Automated safety check: PassApache-2.0

Similar skills

  • C To Ast

    Narwhal-Lab/MagicSkills

    Parse C source code into an Abstract Syntax Tree (AST). An agent skill from Narwhal-Lab/MagicSkills.

    316 GitHub stars~1.1k tokensUpdated 6 mo ago
    SecurityAuto-check passed
  • Security Setup

    luongnv89/skills

    Install local-first security hardening: pre-commit secret detection, offline dependency scans, static analysis, reports, and gated free CI.

    131 GitHub stars~4.5k tokensUpdated today
    SecurityAuto-check passed
  • CodeQL Security Scan

    trailofbits/skills

    Official

    Scans a codebase for vulnerabilities with CodeQL's data flow and taint tracking in run-all or important-only modes, including data extensions for project-specific sources and sinks.

    7.4k GitHub stars~4.6k tokensUpdated today
    SecurityAuto-check: notes
  • Kedro Security Review

    kedro-org/kedro

    Run a Kedro security scan on the full codebase or just a pull request.

    11k GitHub stars~3.3k tokensUpdated today
    SecurityAuto-check passed
  • Skylos

    duriantaco/skylos

    Run, interpret, or modify Skylos safely. An agent skill from duriantaco/skylos.

    843 GitHub stars~581 tokensUpdated today
    SecurityAuto-check passed
  • Security Verification Gate

    fengshao1227/ccg-workflow

    Scans code with a bundled Node script for injection, secrets, XSS and other risky patterns, ranks findings by severity and checks that security decisions are documented.

    5.9k GitHub stars~621 tokensUpdated 22 days ago
    SecurityAuto-check: notes

More from ArabelaTso/Skills-4-SE

All 150 skills in this repo
  • Framework Migration Assistant

    ArabelaTso/Skills-4-SE

    Automatically migrate Python web applications between frameworks (Flask → FastAPI, Django → FastAPI).

    253 GitHub stars~1.9k tokensUpdated 1 mo ago
    Auto-check passed
  • Metamorphic Test Generator

    ArabelaTso/Skills-4-SE

    Generate test cases using metamorphic testing by applying transformations based on metamorphic properties.

    253 GitHub stars~798 tokensUpdated 1 mo ago
    Auto-check passed
  • Reproduction Trace Instrumenter

    ArabelaTso/Skills-4-SE

    Instruments programs to capture execution traces specifically for reproducing reported bugs, enabling consistent replay and diagnosis of failures.

    253 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Spring Mvc To Boot Migrator

    ArabelaTso/Skills-4-SE

    Automatically migrate Spring MVC applications to Spring Boot.

    253 GitHub stars~2.2k tokensUpdated 1 mo ago
    Auto-check passed
  • State Snapshot Instrumenter

    ArabelaTso/Skills-4-SE

    Instrument programs (Python, C/C++, Java) to capture snapshots of key program states at runtime, including variables, memory, and call stacks.

    253 GitHub stars~2.2k tokensUpdated 1 mo ago
    Auto-check passed

Works with

Categories

Questions about Python API Consistency Validator

What does Python API Consistency Validator do?

Validate API consistency between two versions of Python libraries. Python API Consistency Validator is an agent skill from ArabelaTso/Skills-4-SE. Validate API consistency between two versions of Python libraries.

When should I use Python API Consistency Validator?

Python API Consistency Validator fits situations like: you need to compare API behavior; exceptions between library versions to identify breaking changes; incompatible modifications; behavior differences.

How do I install Python API Consistency Validator in Claude Code?

Run `npx skills add ArabelaTso/Skills-4-SE --skill python-api-consistency-validator -a claude-code`. Or copy the skill folder (skills/python-api-consistency-validator in ArabelaTso/Skills-4-SE) into .claude/skills/python-api-consistency-validator in your project. Claude Code loads it when a task matches its description.

How do I install Python API Consistency Validator in Codex?

Run `npx skills add ArabelaTso/Skills-4-SE --skill python-api-consistency-validator -a codex`. Or copy the skill folder (skills/python-api-consistency-validator in ArabelaTso/Skills-4-SE) into .agents/skills/python-api-consistency-validator in your project. Codex loads it when a task matches its description.

Can I use Python API Consistency Validator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ArabelaTso/Skills-4-SE --skill python-api-consistency-validator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/python-api-consistency-validator, .gemini/skills/python-api-consistency-validator, .github/skills/python-api-consistency-validator and .opencode/skills/python-api-consistency-validator in your project.

What does Python API Consistency Validator need to run?

Going by SKILL.md and its folder, Python API Consistency Validator needs Python for the scripts in its folder and the command-line tools its instructions call (python). Our summary lists: Python 3.

Does Python API Consistency Validator access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Python API Consistency Validator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Python API Consistency Validator use?

Python API Consistency Validator is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Python API Consistency Validator use?

About 609 tokens (SKILL.md is roughly 2.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Python API Consistency Validator?

Skills that share tags, products or a category with Python API Consistency Validator: C To Ast (Narwhal-Lab/MagicSkills, 316 stars), Security Setup (luongnv89/skills, 131 stars), CodeQL Security Scan (trailofbits/skills, 7.4k stars) and Kedro Security Review (kedro-org/kedro, 11k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Python API Consistency Validator?

ArabelaTso (a GitHub user) maintains it in ArabelaTso/Skills-4-SE, which has 253 GitHub stars. The repository holds 150 skills in this directory. The repository was last updated on August 21, 2026.

Source: ArabelaTso/Skills-4-SE on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.