Add notebook analyzer and fix formatting (#476)

* Add notebook analyzer and fix formatting

* Fix one finding in report

* Change recommendations

* fix: handle failures, kernels, paths, and repository-wide scans

* Add documentation

Author: Ekarerina-Ulyanova

docs/api/operations/analysis/notebook_report/analyzer.md

@@ -0,0 +1,3 @@
+# Notebook Report Analyzer
+
+::: osa_tool.operations.analysis.notebook_report.analyzer

docs/api/operations/analysis/notebook_report/models.md

@@ -0,0 +1,3 @@
+# Notebook Report Models
+
+::: osa_tool.operations.analysis.notebook_report.models

docs/api/operations/analysis/notebook_report/report_maker.md

@@ -0,0 +1,3 @@
+# Notebook Report Maker
+
+::: osa_tool.operations.analysis.notebook_report.report_maker

docs/scheduler/index.md

@@ -130,6 +130,7 @@ to the repository.
 | attachment           | `--attachment`           | str  | Path to a local PDF or .docx file, or a URL to a PDF resource                                                                      | `null`                           | —                           |
 | translate_dirs       | `--translate-dirs`       | flag | Enable automatic translation of directory names into English                                                                       | `false`                          | —                           |
 | convert_notebooks    | `--convert-notebooks`    | list | Convert Jupyter notebooks to `.py` format. Provide paths, or leave empty for repo directory                                        | —                                | —                           |
+| notebook_report      | `--notebook-report`      | list | Analyze Jupyter notebooks and generate a notebook PDF report. Provide one or multiple paths, or leave empty for repo directory   | —                                | —                           |
 | delete_dir           | `--delete-dir`           | flag | Delete the downloaded repository after processing                                                                                  | `false`                          | —                           |
 | ensure_license       | `--ensure-license`       | str  | Enable LICENSE file compilation                                                                                                    | `null`                           | `bsd-3`, `mit`, `ap2`       |
 | no_fork              | `--no-fork`              | flag | Do not create a public fork to the target repository                                                                               | `false`                          | —                           |

mkdocs.yml

@@ -46,6 +46,10 @@ nav:
           - Catalog: api/operations/operations_catalog.md
           - Registry: api/operations/registry.md
           - Analysis:
+              - Notebook Report:
+                  - Analyzer: api/operations/analysis/notebook_report/analyzer.md
+                  - Models: api/operations/analysis/notebook_report/models.md
+                  - Report Maker: api/operations/analysis/notebook_report/report_maker.md
               - Repository Report Generator: api/operations/analysis/repository_report/report_generator.md
               - Repository Report Maker: api/operations/analysis/repository_report/report_maker.md
               - Repository Report Validation: api/operations/analysis/repository_report/response_validation.md

osa_tool/config/settings/arguments.yaml

@@ -16,6 +16,7 @@ arguments:
   convert_notebooks:
     aliases: [ "--convert-notebooks" ]
     type: list
+    allow_empty: true
     description: |
       Convert Jupyter notebooks from .ipynb to .py format.
       Provide one or multiple paths, or leave empty for repo directory.
@@ -77,6 +78,14 @@ arguments:
     aliases: [ "--scorecard" ]
     type: flag
     description: "Run OpenSSF Scorecard analysis and include the results in the PDF reports."
+  notebook_report:
+    aliases: [ "--notebook-report" ]
+    type: list
+    allow_empty: true
+    description: |
+      Analyze Jupyter notebooks and generate a notebook PDF report.
+      Provide one or multiple paths, or leave empty for repo directory.
+    example: notebooks/eda.ipynb research notebooks/experiments
 
   readme:
     aliases: [ "--readme" ]

osa_tool/config/settings/config.toml

@@ -53,6 +53,7 @@ community_docs = false
 docstring = false
 report = false
 scorecard = false
+# notebook_report = []
 readme = false
 refine_readme = false
 requirements = false