@deepnote/convert 1.1.0

package/README.md

@@ -0,0 +1,94 @@
+# @deepnote/convert
+
+Convert Jupyter Notebook files (`.ipynb`) to Deepnote project files (`.deepnote`).
+
+## Installation
+
+```bash
+npm install @deepnote/convert
+```
+
+## CLI Usage
+
+The package provides a `deepnote-convert` command-line tool for converting Jupyter notebooks to Deepnote format.
+
+### Convert a Single Notebook
+
+Convert a single `.ipynb` file to a `.deepnote` file:
+
+```bash
+deepnote-convert path/to/notebook.ipynb
+```
+
+This will create a `notebook.deepnote` file in the current directory.
+
+### Convert a Directory of Notebooks
+
+Convert all `.ipynb` files in a directory to a single `.deepnote` project:
+
+```bash
+deepnote-convert path/to/notebooks/
+```
+
+This will create a `notebooks.deepnote` file in the current directory containing all notebooks from the directory.
+
+### Options
+
+#### `--projectName <name>`
+
+Set a custom name for the Deepnote project:
+
+```bash
+deepnote-convert notebook.ipynb --projectName "My Analysis"
+```
+
+If not specified, the project name will default to the filename (without extension) or directory name.
+
+#### `-o, --outputPath <path>`
+
+Specify where to save the output `.deepnote` file:
+
+```bash
+# Save to a specific file
+deepnote-convert notebook.ipynb -o output/project.deepnote
+
+# Save to a directory (filename will be auto-generated)
+deepnote-convert notebook.ipynb -o output/
+```
+
+If not specified, the output file will be saved in the current directory.
+
+### Examples
+
+```bash
+# Convert a single notebook with custom name
+deepnote-convert titanic.ipynb --projectName "Titanic Analysis"
+
+# Convert all notebooks in a directory
+deepnote-convert ./analysis --projectName "Data Science Project" -o ./output
+
+# Convert multiple notebooks from a folder
+deepnote-convert ~/notebooks/ml-experiments -o ~/projects/
+```
+
+## Programmatic Usage
+
+You can also use the conversion function programmatically in your Node.js or TypeScript applications.
+
+### Basic Usage
+
+```typescript
+import { convertIpynbFilesToDeepnoteFile } from '@deepnote/convert'
+
+await convertIpynbFilesToDeepnoteFile(
+  ['path/to/notebook.ipynb'],
+  {
+    outputPath: 'output.deepnote',
+    projectName: 'My Project'
+  }
+)
+
+## License
+
+Apache-2.0
+```

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+//#region src/jupyter-to-deepnote.d.ts
+interface ConvertIpynbFilesToDeepnoteFileOptions {
+  outputPath: string;
+  projectName: string;
+}
+/**
+ * Converts multiple Jupyter Notebook (.ipynb) files into a single Deepnote project file.
+ */
+declare function convertIpynbFilesToDeepnoteFile(inputFilePaths: string[], options: ConvertIpynbFilesToDeepnoteFileOptions): Promise<void>;
+//#endregion
+export { type ConvertIpynbFilesToDeepnoteFileOptions, convertIpynbFilesToDeepnoteFile };

package/dist/index.js

@@ -0,0 +1,87 @@
+import fs from "node:fs/promises";
+import { basename, dirname, extname } from "node:path";
+import { v4 } from "uuid";
+import { stringify } from "yaml";
+
+//#region src/jupyter-to-deepnote.ts
+/**
+* Converts multiple Jupyter Notebook (.ipynb) files into a single Deepnote project file.
+*/
+async function convertIpynbFilesToDeepnoteFile(inputFilePaths, options) {
+	const deepnoteFile = {
+		metadata: { createdAt: (/* @__PURE__ */ new Date()).toISOString() },
+		project: {
+			id: v4(),
+			initNotebookId: void 0,
+			integrations: [],
+			name: options.projectName,
+			notebooks: [],
+			settings: {}
+		},
+		version: "1.0.0"
+	};
+	for (const filePath of inputFilePaths) {
+		const name = basename(filePath, extname(filePath)) || "Untitled notebook";
+		const blocks = (await parseIpynbFile(filePath)).cells.map((cell, index) => {
+			const source = Array.isArray(cell.source) ? cell.source.join("") : cell.source;
+			return {
+				blockGroup: v4(),
+				content: source,
+				executionCount: cell.execution_count ?? void 0,
+				id: v4(),
+				metadata: {},
+				outputs: cell.cell_type === "code" ? cell.outputs : void 0,
+				sortingKey: createSortingKey(index),
+				type: cell.cell_type === "code" ? "code" : "markdown",
+				version: 1
+			};
+		});
+		deepnoteFile.project.notebooks.push({
+			blocks,
+			executionMode: "block",
+			id: v4(),
+			isModule: false,
+			name,
+			workingDirectory: void 0
+		});
+	}
+	const yamlContent = stringify(deepnoteFile);
+	const parentDir = dirname(options.outputPath);
+	await fs.mkdir(parentDir, { recursive: true });
+	await fs.writeFile(options.outputPath, yamlContent, "utf-8");
+}
+async function parseIpynbFile(filePath) {
+	let ipynbJson;
+	try {
+		ipynbJson = await fs.readFile(filePath, "utf-8");
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		throw new Error(`Failed to read ${filePath}: ${message}`);
+	}
+	try {
+		return JSON.parse(ipynbJson);
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		throw new Error(`Failed to parse ${filePath}: invalid JSON - ${message}`);
+	}
+}
+function createSortingKey(index) {
+	const maxLength = 6;
+	const chars = "0123456789abcdefghijklmnopqrstuvwxyz";
+	const base = 36;
+	if (index < 0) throw new Error("Index must be non-negative");
+	let result = "";
+	let num = index + 1;
+	let iterations = 0;
+	while (num > 0 && iterations < maxLength) {
+		num--;
+		result = chars[num % base] + result;
+		num = Math.floor(num / base);
+		iterations++;
+	}
+	if (num > 0) throw new Error(`Index ${index} exceeds maximum key length of ${maxLength}`);
+	return result;
+}
+
+//#endregion
+export { convertIpynbFilesToDeepnoteFile };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@deepnote/convert",
+  "version": "1.1.0",
+  "description": "",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/deepnote/deepnote.git",
+    "directory": "packages/convert"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "deepnote-convert": "./dist/bin.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "tsdown --format esm --dts",
+    "test": "vitest",
+    "watch": "tsdown --watch --format esm --dts"
+  },
+  "dependencies": {
+    "@deepnote/blocks": "workspace:*",
+    "chalk": "^5.6.2",
+    "cleye": "^1.3.4",
+    "ora": "^9.0.0",
+    "uuid": "^13.0.0",
+    "yaml": "^2.8.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsx": "^4.20.6",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}