@deepnote/转换

Deepnote 项目文件之间的双向转换器( E).deepnote)和多种笔记本格式: Jupyter(.ipynb),克特尔多(.qmd(百分比) (百分比).py马里莫和马里莫.py) (中文(简体) ).

# Convert any supported format to Deepnote
npx @deepnote/convert notebook.ipynb
npx @deepnote/convert document.qmd
npx @deepnote/convert notebook.py  # percent or marimo format

# Convert Deepnote to any supported format
npx @deepnote/convert project.deepnote                      # defaults to Jupyter
npx @deepnote/convert project.deepnote --outputFormat quarto
npx @deepnote/convert project.deepnote --outputFormat percent
npx @deepnote/convert project.deepnote --outputFormat marimo

安装

npm install -g @deepnote/convert

支持的格式

CLI 使用量

软件包提供了 deepnote-convert 用于双向转换的命令行工具.

转换为深注

任何支持的格式转换为 .deepnote 自动 :

# Single file
deepnote-convert notebook.ipynb
deepnote-convert document.qmd
deepnote-convert notebook.py  # auto-detects percent vs marimo

# Directory of files — one single-notebook .deepnote per notebook (into the dir, or use -o <dir>)
deepnote-convert path/to/notebooks/

从深音转换

使用 --outputFormat 选择目标格式(默认为 jupyter:

deepnote-convert project.deepnote                        # → Jupyter notebooks
deepnote-convert project.deepnote --outputFormat jupyter # → Jupyter notebooks
deepnote-convert project.deepnote --outputFormat quarto  # → Quarto documents
deepnote-convert project.deepnote --outputFormat percent # → Percent format files
deepnote-convert project.deepnote --outputFormat marimo  # → Marimo notebooks

选项

--projectName <name>

设置 Deepnote 项目的自定义名称( 当转换为 .deepnote:

deepnote-convert notebook.ipynb --projectName "My Analysis"

-o, --outputPath <path>

指定保存输出的地点 :

# To Deepnote: Save to a specific file or directory
deepnote-convert notebook.ipynb -o output/project.deepnote
deepnote-convert notebook.ipynb -o output/

# From Deepnote: Specify output directory
deepnote-convert project.deepnote -o output/notebooks/

--outputFormat <format>

转换时选择输出格式 .deepnote数字 :

deepnote-convert project.deepnote --outputFormat quarto

选项 : jupyter (违约), quarto, (中文(简体) ), percent, (中文(简体) ), marimo

--singleFile

默认转换时 改为 深注,单元格输出在 a 下拆分为单独的快照文件 snapshots/ 目录 .deepnote,将主文件输出为无。 过 --singleFile 将产出插入单项 .deepnote 并跳过快照:

deepnote-convert notebook.ipynb --singleFile

实例

# Jupyter → Deepnote
deepnote-convert titanic.ipynb --projectName "Titanic Analysis"
deepnote-convert ./notebooks -o ./output

# Quarto → Deepnote
deepnote-convert analysis.qmd --projectName "Data Report"

# Percent → Deepnote (auto-detected from # %% markers)
deepnote-convert script.py

# Marimo → Deepnote (auto-detected from @app.cell decorators)
deepnote-convert reactive.py

# Deepnote → various formats
deepnote-convert project.deepnote                        # Jupyter (default)
deepnote-convert project.deepnote --outputFormat quarto  # Quarto
deepnote-convert project.deepnote --outputFormat percent # Percent
deepnote-convert project.deepnote --outputFormat marimo  # Marimo

Python 文件检测

转换时 .py 文件,转换器自动检测格式 :

• 马里莫: 包含 import marimo 财务报告和审定财务报表 @app.cell 装饰器
• 百分比: 包含 # %% 单元格标记

在目录扫描时, 使用明确的命名 :

• *.marimo.py 用于 Marimo 文件
• *.percent.py % 格式文件

无损失回转转换

转换器支持 Jupyter 的无损失回转转换 :

• 深注 · Jupyter · 深注: 在 Jupyter 单元格元数据中保存所有深注专用元数据
• Jupyter – 深注 – Jupyter →: 在添加 Deepnote 元数据的同时保留原Jupyter 内容

其他格式(Quarto,Percent,Marimo)保留了内容和结构,但可能不会保留所有Deepnote特定元数据.

平台兼容性

自朱皮特以来.ipynb)是标准格式,来自使用Jupyter的云平台的笔记本被完全支持元数据保存:

平台专用的单元格元数据在圆通转换过程中被保存,允许笔记本在Deepnote中被编辑并导出回原平台而不会丢失设置.

程序用途

转换为深注

import {
  convertIpynbFileToDeepnoteFile,
  convertQuartoFileToDeepnoteFile,
  convertPercentFileToDeepnoteFile,
  convertMarimoFileToDeepnoteFile,
} from "@deepnote/convert";

// Each call converts ONE source notebook into ONE single-notebook .deepnote file.

// From Jupyter
await convertIpynbFileToDeepnoteFile("notebook.ipynb", {
  outputPath: "output.deepnote",
  projectName: "My Project",
});

// From Quarto
await convertQuartoFileToDeepnoteFile("document.qmd", {
  outputPath: "output.deepnote",
  projectName: "My Project",
});

// From Percent
await convertPercentFileToDeepnoteFile("script.py", {
  outputPath: "output.deepnote",
  projectName: "My Project",
});

// From Marimo
await convertMarimoFileToDeepnoteFile("notebook.py", {
  outputPath: "output.deepnote",
  projectName: "My Project",
});

从深音转换

import {
  convertDeepnoteFileToJupyterFiles,
  convertDeepnoteFileToQuartoFiles,
  convertDeepnoteFileToPercentFiles,
  convertDeepnoteFileToMarimoFiles,
} from "@deepnote/convert";

// To Jupyter
await convertDeepnoteFileToJupyterFiles("project.deepnote", {
  outputDir: "./jupyter-notebooks",
});

// To Quarto
await convertDeepnoteFileToQuartoFiles("project.deepnote", {
  outputDir: "./quarto-docs",
});

// To Percent
await convertDeepnoteFileToPercentFiles("project.deepnote", {
  outputDir: "./percent-scripts",
});

// To Marimo
await convertDeepnoteFileToMarimoFiles("project.deepnote", {
  outputDir: "./marimo-notebooks",
});

纯转换( 无文件 I/ O)

供方案使用内存数据:

import fs from "node:fs/promises";
import { deserializeDeepnoteFile } from "@deepnote/blocks";
import {
  convertDeepnoteToJupyterNotebooks,
  convertDeepnoteToQuartoDocuments,
  convertDeepnoteToPercentNotebooks,
  convertDeepnoteToMarimoApps,
} from "@deepnote/convert";

// Read and deserialize the Deepnote file
const yamlContent = await fs.readFile("project.deepnote", "utf-8");
const deepnoteFile = deserializeDeepnoteFile(yamlContent);

// Convert to any format (pure functions, no I/O)
const jupyterNotebooks = convertDeepnoteToJupyterNotebooks(deepnoteFile);
const quartoDocuments = convertDeepnoteToQuartoDocuments(deepnoteFile);
const percentNotebooks = convertDeepnoteToPercentNotebooks(deepnoteFile);
const marimoApps = convertDeepnoteToMarimoApps(deepnoteFile);

// Work with the results in memory
for (const { filename, notebook } of jupyterNotebooks) {
  console.log(`${filename}: ${notebook.cells.length} cells`);
}

许可证

阿帕奇 - 2.0