generate-notebook-from-module

Generate Jupyter notebooks from Python module public APIs via AST parsing.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/sunLeee/optimization --skill generate-notebook-from-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-notebook-from-module
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/utility/generate-notebook-from-module
Command: npx skills add https://github.com/sunLeee/optimization --skill generate-notebook-from-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Python 모듈 구현 완료 시 대응하는 Jupyter Notebook을 자동 생성한다. 모듈의 public API를 분석하여 사용 예시 템플릿을 제공한다. convention-jupyter-setup의 '모듈 완성 시 노트북 필수' 규칙을 자동화한다.

Core Features & Use Cases

  • Public API를 AST로 추출하여 노트북에 반영한다.
  • 자동으로 코드/마크다운 셀 쌍의 템플릿 노트북을 생성한다.
  • 문서화/학습/탐색 워크플로우에 맞춰 모듈별 노트북 정렬 및 버전 관리를 지원한다.

Quick Start

Finish a Python module and run the generator to produce a corresponding notebook in notebooks/ directory.

Frequently Asked Questions about generate-notebook-from-module

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate a Jupyter Notebook from a Python module?

Generating a Jupyter Notebook from a Python module is automated by parsing the module's public API with Python AST and assembling structured notebooks with code and markdown example templates into a notebooks directory.

What is the best way to document a Python module's public API for exploration?

Documenting a Python module's public API for exploration is best achieved by extracting public functions through AST parsing and producing structured Jupyter Notebooks with API usage examples to support documentation and teaching workflows.

Do I need Python AST parsing to create module documentation notebooks?

Yes, Python AST parsing is required to analyze completed Python modules, extract their public API, and auto-generate corresponding Jupyter Notebooks with structured API example templates for documentation purposes.

Can I organize generated notebooks by task ordering for teaching workflows?

You can organize generated notebooks by task ordering for teaching workflows because the notebook assembler supports optional task-ordering and deterministic naming within the notebooks directory to align with documentation and learning objectives.

Does the notebook generator extract private methods from Python modules?

The notebook generator does not extract private methods from Python modules; it specifically analyzes the public API using AST parsing to ensure the generated notebook templates focus on external usage and exploration.