check-notebook-coverage

Map Python modules to notebooks and report missing coverage.

Updated Mar 19, 2026

Search Tags:#python #ci-cd #jupyter #mapping #module-coverage #notebook-validation

Ready to run

npx skills add https://github.com/sunLeee/optimization --skill check-notebook-coverage

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: check-notebook-coverage
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/quality/check/check-notebook-coverage
Command: npx skills add https://github.com/sunLeee/optimization --skill check-notebook-coverage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validate that every Python module has a corresponding Jupyter notebook coverage, ensuring code exploration and verification is complete.

Core Features & Use Cases

Detect missing notebook mappings for modules, generate coverage reports, and surface uncovered modules.
Help CI/CD pipelines enforce documentation and reproducibility by tying code modules to executable notebooks.
Use case: team ships a library; run the checker to ensure all public modules are represented by notebooks.

Quick Start

Run the notebook-coverage check to validate modules against notebooks in your project.

Frequently Asked Questions about check-notebook-coverage

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

FAQPage Schema

How do I check if Python modules have corresponding Jupyter notebooks?▼

To check notebook coverage for Python modules, run a validation process that maps modules to their corresponding notebooks and reports missing coverage. It identifies modules lacking at least one notebook that imports or demonstrates their public APIs.

What is Jupyter notebook coverage validation for Python codebases?▼

Notebook coverage validation is a process that enforces module completeness by tying Python code modules to executable Jupyter notebooks for verification and documentation, ensuring all public modules are represented.

How do I enforce notebook documentation for Python modules in CI/CD pipelines?▼

To enforce notebook documentation in CI/CD pipelines, integrate a validation check that ensures modules with public APIs have at least one notebook that imports or demonstrates them, generating a clear coverage report for reproducibility.

Does Python notebook coverage validation work for libraries shipping public APIs?▼

Yes, notebook coverage validation works for libraries shipping public APIs by detecting missing notebook mappings for modules and surfacing uncovered modules. Teams run the checker to ensure all public modules are represented by notebooks.

How do I generate a coverage report for missing module-to-notebook mappings?▼

To generate a coverage report for missing mappings, run the notebook-coverage check against your project. It identifies and maps Python modules to their corresponding notebooks, surfacing uncovered modules in a clear report.