check-notebook-coverage

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.

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.

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.

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.

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.