ce-notebook-audit

Scan notebooks for private-member usage, policy violations, and rendering errors.

78|15|Updated May 1, 2023
One-click install
npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-notebook-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ce-notebook-audit
Source: https://github.com/Moffran/calibrated_explanations/tree/main/.claude/skills/ce-notebook-audit
Command: npx skills add https://github.com/Moffran/calibrated_explanations --skill ce-notebook-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit notebooks in notebooks/ for public-API correctness, policy compliance, and private-member usage violations.

Core Features & Use Cases

  • Scan for private-member usage in notebooks
  • Check agent instruction file consistency
  • Run navigation tests to verify rendering and instruction compliance

Quick Start

Run the notebook audit workflow to scan notebooks for private-member usage, public-API correctness, and policy compliance.

Frequently Asked Questions about ce-notebook-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit Jupyter notebooks for private API usage and policy violations?

You can audit notebooks for private API usage and policy violations by scanning the notebooks/ directory to detect private-member access, restricted imports, and rendering errors. The tool enforces detection rules defined in ADR-012 and generates actionable compliance reports.

What is notebook policy compliance checking and when do I need it?

Notebook policy compliance checking scans notebooks for private-member access, restricted imports, and rendering errors. You need it for data science teams and educational workloads to enforce public-API correctness and verify agent instruction consistency across CI and local environments.

How do I check agent instruction file consistency in CI pipelines?

To check agent instruction file consistency in CI pipelines, run the notebook audit workflow which validates agent instructions and executes navigation tests. This verifies rendering and instruction compliance to ensure no restricted imports or private-member usage violations exist.

Can I use notebook auditing for educational workloads and data science teams?

Yes, notebook auditing is explicitly applicable to data science teams and educational workloads. It scans notebooks for private-member access, restricted imports, and rendering errors across both CI and local environments to enforce policy compliance and public-API correctness.

What's the best way to scan notebooks for restricted imports and rendering errors?

The best way to scan notebooks for restricted imports and rendering errors is to run the notebook audit workflow. It enforces detection rules from ADR-012 and related ADRs, validates instruction consistency, and produces actionable audit reports detailing all violations.

Why does my notebook audit report show private-member usage violations?

Your notebook audit report shows private-member usage violations because the scanner detected code accessing non-public APIs. The audit enforces ADR-012 detection rules to identify private-member access, restricted imports, and rendering errors across your notebooks/ directory.