cookbook-audit

Name: cookbook-audit
Availability: InStock
Author: aRustyDev

Audit Anthropic Cookbook notebooks against a rubric and generate markdown reports.

1|Updated Aug 31, 2024

Search Tags:#code quality #automation #quality assurance #security scan #notebook audit #technical accuracy #cookbook review

Ready to run

npx skills add https://github.com/aRustyDev/dotfiles --skill cookbook-audit-arustydev

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cookbook-audit
Source: https://github.com/aRustyDev/dotfiles/tree/main/.claude/skills/cookbook-audit
Command: npx skills add https://github.com/aRustyDev/dotfiles --skill cookbook-audit-arustydev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires nbconvert, detect-secrets, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the auditing of Anthropic Cookbook notebooks against a defined rubric, ensuring high quality, consistency, and adherence to best practices without manual review.

Core Features & Use Cases

Automated Validation: Runs technical checks for issues like hardcoded API keys and suppressed outputs.
Markdown Conversion: Converts notebooks to markdown for easier, context-rich review.
Comprehensive Rubric: Evaluates narrative, code quality, technical accuracy, and actionability.
Use Case: Before publishing a new cookbook, use this skill to automatically audit it, generate a detailed report, and identify areas for improvement, saving significant manual review time.

Quick Start

Audit the notebook located at 'cookbooks/my_new_feature.ipynb' and provide a detailed report.

Frequently Asked Questions about cookbook-audit

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

FAQPage Schema

How do I automate quality checks for Jupyter notebooks?▼

Automated notebook auditing runs technical validation against a defined rubric, checking for issues like hardcoded secrets, suppressed outputs, and code quality problems. This Skill executes python3 validate_notebook.py to scan your notebook, applies detect-secrets for credential detection, and generates a structured audit report with actionable findings.

Can I detect hardcoded secrets in notebook files automatically?▼

Yes. This Skill uses detect-secrets to scan notebooks for exposed API keys and credentials before publication. It integrates secret scanning into the audit workflow, flagging security risks alongside code and narrative quality issues in a single comprehensive report.

What's the best way to audit a cookbook notebook before publishing?▼

Run the notebook through automated validation using this Skill to evaluate narrative clarity, code quality, technical accuracy, and actionability against a rubric. It converts the notebook to markdown for context-rich review and produces an executive-style audit report with specific improvement areas.

How does notebook-to-markdown conversion help with code review?▼

Converting notebooks to markdown via nbconvert creates a human-readable format optimized for review workflows. This Skill applies conversion as part of its audit process, making it easier to spot narrative gaps, verify technical accuracy, and provide feedback without reopening the original notebook file.

What rubric does this notebook auditor use to score quality?▼

The audit evaluates four dimensions: narrative quality, code quality, technical accuracy, and actionability. The Skill scores each category against a defined rubric and generates a structured report identifying gaps and recommendations specific to each area.

Do I need to manually review notebooks if I use automated auditing?▼

Automated auditing reduces manual review time by pre-screening notebooks for rubric violations and security risks. It flags issues systematically and generates detailed reports, but human review of recommendations and edge cases remains part of a complete publication workflow.