@deepnote/convert 1.2.0 → 1.2.1

package/README.md

@@ -5,7 +5,7 @@ Convert Jupyter Notebook files (`.ipynb`) to Deepnote project files (`.deepnote`
 ## Installation
 
 ```bash
-npm install @deepnote/convert
+npm install -g @deepnote/convert
 ```
 
 ## CLI Usage
@@ -78,17 +78,14 @@ You can also use the conversion function programmatically in your Node.js or Typ
 ### Basic Usage
 
 ```typescript
-import { convertIpynbFilesToDeepnoteFile } from '@deepnote/convert'
+import { convertIpynbFilesToDeepnoteFile } from "@deepnote/convert";
 
-await convertIpynbFilesToDeepnoteFile(
-  ['path/to/notebook.ipynb'],
-  {
-    outputPath: 'output.deepnote',
-    projectName: 'My Project'
-  }
-)
+await convertIpynbFilesToDeepnoteFile(["path/to/notebook.ipynb"], {
+  outputPath: "output.deepnote",
+  projectName: "My Project",
+});
+```
 
 ## License
 
 Apache-2.0
-```

package/dist/bin.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/bin.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+import { t as convertIpynbFilesToDeepnoteFile } from "./src-n1bYyJ74.js";
+import { cli } from "cleye";
+import fs from "node:fs/promises";
+import { basename, extname, resolve } from "node:path";
+import chalk from "chalk";
+import ora from "ora";
+
+//#region src/cli.ts
+async function convert(options) {
+	const { inputPath, projectName: customProjectName, outputPath: customOutputPath, cwd = process.cwd() } = options;
+	const resolveProjectName = (possibleName) => {
+		if (customProjectName) return customProjectName;
+		if (possibleName) return possibleName;
+		return "Untitled project";
+	};
+	const resolveOutputPath = async (outputFilename) => {
+		if (customOutputPath) {
+			const absoluteOutputPath = resolve(cwd, customOutputPath);
+			if ((await fs.stat(absoluteOutputPath).catch(() => null))?.isDirectory()) return resolve(absoluteOutputPath, outputFilename);
+			return absoluteOutputPath;
+		}
+		return resolve(cwd, outputFilename);
+	};
+	const absolutePath = resolve(cwd, inputPath);
+	if ((await fs.stat(absolutePath)).isDirectory()) {
+		const ipynbFiles = (await fs.readdir(absolutePath, { withFileTypes: true })).filter((entry) => entry.isFile() && entry.name.toLowerCase().endsWith(".ipynb")).map((entry) => entry.name).sort((a, b) => a.localeCompare(b));
+		if (ipynbFiles.length === 0) throw new Error("No .ipynb files found in the specified directory.");
+		const spinner = ora("Converting Jupyter Notebooks to a Deepnote project...").start();
+		try {
+			const filenameWithoutExtension = basename(absolutePath);
+			const projectName = resolveProjectName(filenameWithoutExtension);
+			const outputPath = await resolveOutputPath(`${filenameWithoutExtension}.deepnote`);
+			await convertIpynbFilesToDeepnoteFile(ipynbFiles.map((file) => resolve(absolutePath, file)), {
+				projectName,
+				outputPath
+			});
+			spinner.succeed(`The Deepnote project has been saved to ${chalk.bold(outputPath)}`);
+			return outputPath;
+		} catch (error) {
+			spinner.fail("Conversion failed");
+			throw error;
+		}
+	}
+	const ext = extname(absolutePath).toLowerCase();
+	if (ext === ".ipynb") {
+		const spinner = ora("Converting the Jupyter Notebook to a Deepnote project...").start();
+		try {
+			const filenameWithoutExtension = basename(absolutePath, ext);
+			const projectName = resolveProjectName(filenameWithoutExtension);
+			const outputPath = await resolveOutputPath(`${filenameWithoutExtension}.deepnote`);
+			await convertIpynbFilesToDeepnoteFile([absolutePath], {
+				projectName,
+				outputPath
+			});
+			spinner.succeed(`The Deepnote project has been saved to ${chalk.bold(outputPath)}`);
+			return outputPath;
+		} catch (error) {
+			spinner.fail("Conversion failed");
+			throw error;
+		}
+	}
+	if (ext === ".deepnote") throw new Error("The .deepnote format is not supported for conversion yet.");
+	throw new Error("Unsupported file type. Please provide a .ipynb or .deepnote file.");
+}
+
+//#endregion
+//#region src/bin.ts
+async function main() {
+	const argv = cli({
+		name: "deepnote-convert",
+		parameters: ["<path>"],
+		flags: {
+			projectName: {
+				description: "The name of the Deepnote project.",
+				type: String
+			},
+			outputPath: {
+				alias: "o",
+				description: "The path where the .deepnote file will be saved.",
+				type: String
+			},
+			cwd: {
+				description: "The working directory to resolve paths relative to.",
+				type: String
+			}
+		}
+	});
+	await convert({
+		inputPath: argv._.path,
+		projectName: argv.flags.projectName,
+		outputPath: argv.flags.outputPath,
+		cwd: argv.flags.cwd ?? process.cwd()
+	});
+}
+if (process.env.NODE_ENV !== "test" && process.env.VITEST !== "true") main().catch((error) => {
+	console.error(error);
+	process.exit(1);
+});
+
+//#endregion
+export {  };

package/dist/index.js

@@ -1,87 +1,3 @@
-import fs from "node:fs/promises";
-import { basename, dirname, extname } from "node:path";
-import { v4 } from "uuid";
-import { stringify } from "yaml";
+import { t as convertIpynbFilesToDeepnoteFile } from "./src-n1bYyJ74.js";
 
-//#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/dist/src-n1bYyJ74.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 as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepnote/convert",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "",
   "keywords": [],
   "repository": {
@@ -33,7 +33,7 @@
     "ora": "^9.0.0",
     "uuid": "^13.0.0",
     "yaml": "^2.8.1",
-    "@deepnote/blocks": "1.3.5"
+    "@deepnote/blocks": "1.3.6"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",
@@ -48,8 +48,8 @@
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
-    "build": "tsdown --format esm --dts",
+    "build": "tsdown --format esm --dts src/bin.ts src/index.ts",
     "test": "vitest",
-    "watch": "tsdown --watch --format esm --dts"
+    "watch": "tsdown --watch --format esm --dts src/bin.ts src/index.ts"
   }
 }