jellycell.cli.commands.export

jellycell export ipynb|md — export notebooks with reattached outputs.

Module Contents

Classes

ExportReport

JSON schema for jellycell export --json. Spec §10.1 contract.

Functions

export_ipynb_cmd	Write a .ipynb with cached outputs reattached to site/<stem>.ipynb.
export_md_cmd	Write a MyST markdown file with cached outputs to site/<stem>.md.
export_tearsheet_cmd	Write a curated markdown tearsheet.

Data

export_app

API

jellycell.cli.commands.export.export_app

‘Typer(…)’

class jellycell.cli.commands.export.ExportReport(/, **data: Any)

Bases: pydantic.BaseModel

JSON schema for jellycell export --json. Spec §10.1 contract.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

schema_version: int

1

source: str

None

output: str

None

format: str

None

jellycell.cli.commands.export.export_ipynb_cmd(ctx: typer.Context, notebook: pathlib.Path = typer.Argument(..., help='Source notebook (.py).')) → None

Write a .ipynb with cached outputs reattached to site/<stem>.ipynb.

jellycell.cli.commands.export.export_md_cmd(ctx: typer.Context, notebook: pathlib.Path = typer.Argument(..., help='Source notebook (.py).')) → None

Write a MyST markdown file with cached outputs to site/<stem>.md.

jellycell.cli.commands.export.export_tearsheet_cmd(ctx: typer.Context, notebook: pathlib.Path = typer.Argument(..., help='Source notebook (.py).'), output: pathlib.Path | None = typer.Option(None, '--output', '-o', help='Write to this path instead of the default manuscripts/tearsheets/<stem>.md.')) → None

Write a curated markdown tearsheet.

Defaults to manuscripts/tearsheets/<stem>.md so the auto-generated subfolder stays separate from the hand-authored writeups that live at the root of manuscripts/ (paper drafts, memos, thesis chapters). Use -o PATH to target anywhere else.

Unlike export md, this skips code source by default and only inlines what renders naturally in markdown (figures, JSON summaries, setup cells). The result is safe to commit and renders inline on GitHub.