notebook-tester

Execute Jupyter notebooks and verify outputs for errors and quality metrics.

Updated Nov 16, 2025
One-click install
npx skills add https://github.com/Ming-Kai-LC/self-learn --skill notebook-tester
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: notebook-tester
Source: https://github.com/Ming-Kai-LC/self-learn/tree/main/.claude/skills/notebook-tester
Command: npx skills add https://github.com/Ming-Kai-LC/self-learn --skill notebook-tester

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jupyter, nbconvert, pytest, and includes scripts (resource) components.

What problem does it solve?

Manually testing Jupyter notebooks for execution errors, output correctness, and educational quality is tedious, time-consuming, and prone to human error. This Skill automates the entire validation process.

Core Features & Use Cases

  • Execution Validation: Ensures notebooks run completely without errors, verifying cell outputs and execution times.
  • Quality Metrics: Calculates educational quality metrics like Markdown-to-code ratio, exercise count, and presence of learning objectives.
  • CI/CD Integration: Provides scripts and workflows for automated testing in continuous integration pipelines.

Quick Start

Validate the execution and quality metrics of 'my_lesson.ipynb' to ensure it runs without errors and meets educational standards.

Frequently Asked Questions about notebook-tester

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

FAQPage Schema
How do I automate testing of Jupyter notebooks in CI/CD pipelines?

Automate Jupyter notebook testing by executing cells with nbconvert, verifying outputs for errors, and running quality checks via Python scripts in your CI/CD workflow. This ensures notebooks pass validation gates before deployment.

Can I validate that my Jupyter notebooks run without errors across different environments?

Yes, notebook-tester executes notebooks end-to-end and validates cell outputs, detecting execution errors and output mismatches across environments. It reports failures and ensures consistent behavior.

What educational quality metrics can I check for Jupyter notebooks?

Quality metrics include Markdown-to-code ratio, exercise count, presence of learning objectives, and prerequisites. These automated checks ensure educational notebooks meet predefined standards.

How do I ensure educational notebooks meet learning standards before sharing?

Run automated validation to execute all cells, verify correct outputs, and compute quality metrics like exercise coverage and learning objectives. Failures block publication until notebooks meet your quality gates.

Do I need pytest and nbconvert to test Jupyter notebooks?

Yes, notebook-tester relies on nbconvert for notebook execution and pytest for validation scripting. Both are required dependencies for automated notebook testing and quality checks.