jellycell.tearsheets._audit

jellycell.tearsheets.audit — notebook → audit manuscript.

Thin wrapper over :func:jellycell.export.tearsheet.export_tearsheet that pulls manifests from the project’s cache for you. Useful when you want to generate the same per-notebook tearsheet the CLI produces, but from inside a :py:obj:jc.step-tagged cell so the output becomes part of the cache graph.

Module Contents

Functions

audit

Render a per-notebook tearsheet (cells, artifacts, JSON summaries) as markdown.

API

jellycell.tearsheets._audit.audit(notebook: str | pathlib.Path, *, out_path: str | pathlib.Path, template_overrides: dict[str, str] | None = None) → pathlib.Path

Render a per-notebook tearsheet (cells, artifacts, JSON summaries) as markdown.

Equivalent to jellycell export tearsheet <notebook> but callable from inside a notebook cell. Reads manifests from the active project’s cache; a cell that hasn’t run yet shows up as “(not cached)” in the output.

Args: notebook: Path to the .py source notebook. Walks up for the nearest jellycell.toml to resolve the project root. out_path: Destination markdown file. Parent dirs are created. template_overrides: Reserved for header pinning (author, month_year, version). Currently unused by the underlying exporter — passed along as a no-op for API symmetry with :func:findings and :func:methodology. Future releases will flow these into the rendered header.

Returns: The resolved Path that was written.

Raises: ProjectNotFoundError: No jellycell.toml was found walking up from notebook. FileNotFoundError: notebook does not exist.