Index of every page on this site: llms.txt
All skills
openai avatar

/jupyter-notebook

@49f948f official
by openaiopenai/skills29k stars
2,023
Run it yourself

Use when the user asks to create, scaffold, or edit Jupyter notebooks (`.ipynb`) for experiments, explorations, or tutorials; prefer the bundled templates and run the helper script `new_notebook.py` to generate a clean starting notebook.

Use this Skill: https://skilld.dev/gh/openai/skills/jupyter-notebook

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈64 tokens for metadata: the name and description. ≈967 when used: this file. ≈758 more on demand in 5 files.

Description uses 3.2% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈256 characters, or 3.2%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Jupyter Notebook Skill

Create clean, reproducible Jupyter notebooks for two primary modes:

  • Experiments and exploratory analysis
  • Tutorials and teaching-oriented walkthroughs

Prefer the bundled templates and the helper script for consistent structure and fewer JSON mistakes.

When to use

  • Create a new .ipynb notebook from scratch.
  • Convert rough notes or scripts into a structured notebook.
  • Refactor an existing notebook to be more reproducible and skimmable.
  • Build experiments or tutorials that will be read or re-run by other people.

Decision tree

  • If the request is exploratory, analytical, or hypothesis-driven, choose experiment.
  • If the request is instructional, step-by-step, or audience-specific, choose tutorial.
  • If editing an existing notebook, treat it as a refactor: preserve intent and improve structure.

Skill path (set once)

export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
export JUPYTER_NOTEBOOK_CLI="$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py"

User-scoped skills install under $CODEX_HOME/skills (default: ~/.codex/skills).

Workflow

  1. Lock the intent. Identify the notebook kind: experiment or tutorial. Capture the objective, audience, and what "done" looks like.

  2. Scaffold from the template. Use the helper script to avoid hand-authoring raw notebook JSON.

uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind experiment \
  --title "Compare prompt variants" \
  --out output/jupyter-notebook/compare-prompt-variants.ipynb
uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind tutorial \
  --title "Intro to embeddings" \
  --out output/jupyter-notebook/intro-to-embeddings.ipynb
  1. Fill the notebook with small, runnable steps. Keep each code cell focused on one step. Add short markdown cells that explain the purpose and expected result. Avoid large, noisy outputs when a short summary works.

  2. Apply the right pattern. For experiments, follow references/experiment-patterns.md. For tutorials, follow references/tutorial-patterns.md.

  3. Edit safely when working with existing notebooks. Preserve the notebook structure; avoid reordering cells unless it improves the top-to-bottom story. Prefer targeted edits over full rewrites. If you must edit raw JSON, review references/notebook-structure.md first.

  4. Validate the result. Run the notebook top-to-bottom when the environment allows. If execution is not possible, say so explicitly and call out how to validate locally. Use the final pass checklist in references/quality-checklist.md.

Templates and helper script

  • Templates live in assets/experiment-template.ipynb and assets/tutorial-template.ipynb.
  • The helper script loads a template, updates the title cell, and writes a notebook.

Script path:

  • $JUPYTER_NOTEBOOK_CLI (installed default: $CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py)

Temp and output conventions

  • Use tmp/jupyter-notebook/ for intermediate files; delete when done.
  • Write final artifacts under output/jupyter-notebook/ when working in this repo.
  • Use stable, descriptive filenames (for example, ablation-temperature.ipynb).

Dependencies (install only when needed)

Prefer uv for dependency management.

Optional Python packages for local notebook execution:

uv pip install jupyterlab ipykernel

The bundled scaffold script uses only the Python standard library and does not require extra dependencies.

Environment

No required environment variables.

Reference map

  • references/experiment-patterns.md: experiment structure and heuristics.
  • references/tutorial-patterns.md: tutorial structure and teaching flow.
  • references/notebook-structure.md: notebook JSON shape and safe editing rules.
  • references/quality-checklist.md: final validation checklist.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo5 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides a structured framework for creating Jupyter notebooks using templates and a helper script. It includes security considerations regarding the processing of user-supplied content into executable notebook files and the installation of standard external packages. These processes are managed through bundled templates and local scripts. See the detailed analysis for context.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer9mo

    10/10 files flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 49f948f. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Activeupdated 10 months ago
  • Python
  • jupyter
  • notebook
  • ipynb
  • experimentation
  • tutorial
  • analysis
  • exploration

README badge

README badge for openai/skills/jupyter-notebook

Scaffolds clean Jupyter notebooks for experiments and tutorials using a bundled template and helper script. Handles both exploratory analysis and instructional walkthroughs with consistent structure and JSON safety.

Generated from the current SKILL.md.

What types of notebooks does this skill create?
The skill scaffolds two types: experiment notebooks for exploratory analysis and hypothesis-driven work, and tutorial notebooks for step-by-step instruction. Use the `--kind` flag with the helper script to choose between them.
Do I need to install dependencies to use this skill?
No. The bundled scaffold script uses only the Python standard library. JupyterLab and ipykernel are optional and only needed if you want to run notebooks locally.
How do I create a new notebook with this skill?
Run the bundled `new_notebook.py` helper script with `--kind`, `--title`, and `--out` flags. For example: `uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" --kind experiment --title "Compare prompt variants" --out output/jupyter-notebook/compare-prompt-variants.ipynb`.
Can I edit existing notebooks with this skill?
Yes. The skill includes patterns for refactoring existing notebooks while preserving their intent. Refer to `references/notebook-structure.md` before editing raw JSON to avoid mistakes.
Where should I save the final notebook?
Save final notebooks under `output/jupyter-notebook/` with stable, descriptive filenames. Use `tmp/jupyter-notebook/` for intermediate files and clean them up when done.

Generated from the current SKILL.md. These answers refresh after source changes.