Merge pull request #5 from e2b-dev/prerelease

Prerelease

Author: jakubno

.changeset/config.json

@@ -3,10 +3,7 @@
   "changelog": "@changesets/cli/changelog",
   "commit": false,
   "fixed": [],
-  "ignore": [
-    "e2b-docs",
-    "reverse-proxy"
-  ],
+  "ignore": [],
   "linked": [],
   "access": "public",
   "baseBranch": "main",

.changeset/little-paws-ring.md

@@ -0,0 +1,6 @@
+---
+"@e2b/code-interpreter": patch
+"@e2b/code-interpreter-python": patch
+---
+
+Release

.github/workflows/python_tests.yml

@@ -40,6 +40,6 @@ jobs:
         run: poetry build
 
       - name: Run tests
-        run: poetry run pytest -n 1 --verbose -x
+        run: poetry run pytest --verbose -x
         env:
           E2B_API_KEY: ${{ secrets.E2B_API_KEY }}

.github/workflows/release.yml

@@ -114,17 +114,17 @@ jobs:
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1
         with:
-          version: 1.5.1
+          version: 1.8.1
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
 
       - uses: pnpm/action-setup@v2
 
-      - name: Setup Node.js 18
+      - name: Setup Node.js 20
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: pnpm
 
       - name: Configure pnpm

.github/workflows/release_candidates.yml

@@ -22,7 +22,7 @@ jobs:
 
       - name: Setup Node.js 20
         uses: actions/setup-node@v4
-        if: ${{ contains( github.event.pull_request.labels.*.name, 'js-rc') || contains( github.event.pull_request.labels.*.name, 'python-rc') }}
+        if: ${{ contains( github.event.pull_request.labels.*.name, 'js-rc') }}
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org
@@ -43,7 +43,7 @@ jobs:
         if: ${{ contains( github.event.pull_request.labels.*.name, 'js-rc') }}
         run: |
           npm version prerelease --preid=${{ github.head_ref }}
-          npm publish --tag rc
+          npm publish --tag rc || true
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
@@ -57,14 +57,14 @@ jobs:
         uses: snok/install-poetry@v1
         if: ${{ contains( github.event.pull_request.labels.*.name, 'python-rc') }}
         with:
-          version: 1.5.1
+          version: 1.8.1
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
 
       - name: Release Candidate
         if: ${{ contains( github.event.pull_request.labels.*.name, 'python-rc') }}
-        working-directory: /python
+        working-directory: python
         run: |
           poetry version prerelease
           poetry build

README.md

@@ -39,8 +39,8 @@ from e2b_code_interpreter import CodeInterpreter
 with CodeInterpreter() as sandbox:
     sandbox.notebook.exec_cell("x = 1")
 
-    result = sandbox.notebook.exec_cell("x+=1; x")
-    print(result.text)  # outputs 2
+    execution = sandbox.notebook.exec_cell("x+=1; x")
+    print(execution.text)  # outputs 2
 
 ```
 
@@ -52,8 +52,8 @@ import { CodeInterpreter } from '@e2b/code-interpreter'
 const sandbox = await CodeInterpreter.create()
 await sandbox.notebook.execCell('x = 1')
 
-const result = await sandbox.notebook.execCell('x+=1; x')
-console.log(result.text)  // outputs 2
+const execution = await sandbox.notebook.execCell('x+=1; x')
+console.log(execution.text)  // outputs 2
 
 await sandbox.close()
 ```
@@ -86,10 +86,10 @@ with CodeInterpreter() as sandbox:
     sandbox.notebook.exec_cell("!pip install matplotlib")
 
     # plot random graph
-    result = sandbox.notebook.exec_cell(code)
+    execution = sandbox.notebook.exec_cell(code)
 
 # there's your image
-image = result.data[0].png
+image = execution.results[0].png
 
 # example how to show the image / prove it works
 i = base64.b64decode(image)
@@ -121,10 +121,10 @@ plt.show()
 // you can install dependencies in "jupyter notebook style"
 await sandbox.notebook.execCell("!pip install matplotlib")
 
-const result = await sandbox.notebook.execCell(code)
+const execution = await sandbox.notebook.execCell(code)
 
 // this contains the image data, you can e.g. save it to file or send to frontend
-result.data[0].png
+execution.results[0].png
 
 await sandbox.close()
 ```
@@ -138,35 +138,47 @@ from e2b_code_interpreter import CodeInterpreter
 
 code = """
 import time
+import pandas as pd
 
 print("hello")
-time.sleep(5)
+time.sleep(3)
+data = pd.DataFrame(data=[[1, 2], [3, 4]], columns=["A", "B"])
+display(data.head(10))
+time.sleep(3)
 print("world")
 """
+
 with CodeInterpreter() as sandbox:
-    sandbox.notebook.exec_cell(code, on_stdout=print, on_stderr=print)
+    sandbox.notebook.exec_cell(code, on_stdout=print, on_stderr=print, on_display_data=(lambda data: print(data.text)))
+
 ```
 
 #### JavaScript
 
 ```js
-import { CodeInterpreter } from "@e2b/code-interpreter"
+import { CodeInterpreter } from '@e2b/code-interpreter'
 
-code = `
+const code = `
 import time
+import pandas as pd
 
 print("hello")
-time.sleep(5)
+time.sleep(3)
+data = pd.DataFrame(data=[[1, 2], [3, 4]], columns=["A", "B"])
+display(data.head(10))
+time.sleep(3)
 print("world")
 `
 
 const sandbox = await CodeInterpreter.create()
 
-await sandbox.notebook.execCell(
-  code,
-  (out) => console.log(out),
-  (outErr) => console.error(outErr),
-)
+await sandbox.notebook.execCell(code, {
+  onStdout: (out) => console.log(out),
+  onStderr: (outErr) => console.error(outErr),
+  onDisplayData: (outData) => console.log(outData.text)
+})
+
+await sandbox.close()
 ```
 
 ### Pre-installed Python packages inside the sandbox

js/README.md

@@ -23,8 +23,8 @@ import { CodeInterpreter } from '@e2b/code-interpreter'
 const sandbox = await CodeInterpreter.create()
 await sandbox.notebook.execCell('x = 1')
 
-const result = await sandbox.notebook.execCell('x += 1; x')
-console.log(result.text)  // outputs 2
+const execution = await sandbox.notebook.execCell('x+=1; x')
+console.log(execution.text)  // outputs 2
 
 await sandbox.close()
 ```
@@ -45,15 +45,15 @@ y = np.sin(x)
 
 plt.plot(x, y)
 plt.show()
-`
+`;
 
 // you can install dependencies in "jupyter notebook style"
 await sandbox.notebook.execCell("!pip install matplotlib")
 
-const result = await sandbox.notebook.execCell(code)
+const execution = await sandbox.notebook.execCell(code)
 
 // this contains the image data, you can e.g. save it to file or send to frontend
-result.data[0].png
+execution.results[0].png
 
 await sandbox.close()
 ```
@@ -63,21 +63,27 @@ await sandbox.close()
 ```js
 import { CodeInterpreter } from '@e2b/code-interpreter'
 
-code = `
+const code = `
 import time
+import pandas as pd
 
 print("hello")
-time.sleep(5)
+time.sleep(3)
+data = pd.DataFrame(data=[[1, 2], [3, 4]], columns=["A", "B"])
+display(data.head(10))
+time.sleep(3)
 print("world")
-`;
+`
 
 const sandbox = await CodeInterpreter.create()
 
-await sandbox.notebook.execCell(
-  code,
-  (out) => console.log(out),
-  (outErr) => console.error(outErr),
-)
+await sandbox.notebook.execCell(code, {
+  onStdout: (out) => console.log(out),
+  onStderr: (outErr) => console.error(outErr),
+  onDisplayData: (outData) => console.log(outData.text)
+})
+
+await sandbox.close()
 ```
 
 ### Pre-installed Python packages inside the sandbox

js/example.js

@@ -1,12 +1,11 @@
 const { CodeInterpreter } = require('./dist')
 const dotenv = require('dotenv')
-dotenv.config();
+dotenv.config()
 
 async function main() {
-    const sandbox = await CodeInterpreter.create()
-    const r =await sandbox.notebook.execCell('x = 1; x')
-    console.log(r)
+  const sandbox = await CodeInterpreter.create()
+  const r = await sandbox.notebook.execCell('x = 1; x')
+  console.log(r)
 }
 
 main().catch(console.error)
-

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e2b/code-interpreter",
-  "version": "0.0.0",
+  "version": "0.0.1-prerelease.2",
   "description": "E2B Code Interpreter - Stateful code execution",
   "homepage": "https://e2b.dev",
   "license": "MIT",

js/src/code-interpreter.ts

@@ -1,5 +1,5 @@
 import { ProcessMessage, Sandbox, SandboxOpts } from 'e2b'
-import {Data, JupyterKernelWebSocket, Result} from './messaging'
+import { Result, JupyterKernelWebSocket, Execution } from './messaging'
 import { createDeferredPromise } from './utils'
 
 interface Kernels {
@@ -46,10 +46,12 @@ export class JupyterExtension {
     return this.kernelIDPromise.promise
   }
 
-  constructor(private sandbox: CodeInterpreter) { }
+  constructor(private sandbox: CodeInterpreter) {}
 
   async connect(timeout?: number) {
-    return this.startConnectingToDefaultKernel(this.setDefaultKernelID, { timeout })
+    return this.startConnectingToDefaultKernel(this.setDefaultKernelID, {
+      timeout
+    })
   }
 
   /**
@@ -61,24 +63,43 @@ export class JupyterExtension {
    * @param kernelID The ID of the kernel to execute the code on. If not provided, the default kernel is used.
    * @param onStdout A callback function to handle standard output messages from the code execution.
    * @param onStderr A callback function to handle standard error messages from the code execution.
+   * @param onDisplayData A callback function to handle display data messages from the code execution.
+   * @param timeout The maximum time to wait for the code execution to complete, in milliseconds.
    * @returns A promise that resolves with the result of the code execution.
    */
   async execCell(
     code: string,
-    kernelID?: string,
-    onStdout?: (msg: ProcessMessage) => any,
-    onStderr?: (msg: ProcessMessage) => any,
-    onDisplayData?: (data: Data) => any
-  ): Promise<Result> {
-    kernelID = kernelID || await this.defaultKernelID
-    const ws = this.connectedKernels[kernelID] || await this.connectToKernelWS(kernelID)
-
-    return await ws.sendExecutionMessage(code, onStdout, onStderr, onDisplayData)
+    {
+      kernelID,
+      onStdout,
+      onStderr,
+      onDisplayData,
+      timeout
+    }: {
+      kernelID?: string
+      onStdout?: (msg: ProcessMessage) => Promise<void> | void
+      onStderr?: (msg: ProcessMessage) => Promise<void> | void
+      onDisplayData?: (data: Result) => Promise<void> | void
+      timeout?: number
+    } = {}
+  ): Promise<Execution> {
+    kernelID = kernelID || (await this.defaultKernelID)
+    const ws =
+      this.connectedKernels[kernelID] ||
+      (await this.connectToKernelWS(kernelID))
+
+    return await ws.sendExecutionMessage(
+      code,
+      onStdout,
+      onStderr,
+      onDisplayData,
+      timeout
+    )
   }
 
   private async startConnectingToDefaultKernel(
     resolve: (value: string) => void,
-    opts?: { timeout?: number },
+    opts?: { timeout?: number }
   ) {
     const kernelID = (
       await this.sandbox.filesystem.read('/root/.jupyter/kernel_id', opts)