Skip to content

Default to base e2b SDK in READMEs#1232

Merged
beran-t merged 2 commits intomainfrom
fix-code-interpreter-imports
Mar 24, 2026
Merged

Default to base e2b SDK in READMEs#1232
beran-t merged 2 commits intomainfrom
fix-code-interpreter-imports

Conversation

@beran-t
Copy link
Copy Markdown
Contributor

@beran-t beran-t commented Mar 23, 2026

Summary

  • Updated root README, js-sdk README, and python-sdk README to show base e2b SDK install and usage as the default
  • Code-interpreter is now shown as an optional step for when runCode()/run_code() is actually needed
  • SDK links in descriptions now point to base e2b packages on npm/PyPI

Why

The base e2b package covers commands, files, git, networking, and sandbox lifecycle. Users who don't need code execution shouldn't be directed to install @e2b/code-interpreter / e2b-code-interpreter as their first step.

Test plan

  • Verify README renders correctly on GitHub
  • Confirm base SDK examples use correct import syntax
  • Confirm code-interpreter section still shows correct usage for runCode()

The base e2b package covers commands, files, git, and networking.
Code-interpreter should only be installed when runCode()/run_code()
is needed. Updated all three READMEs (root, js-sdk, python-sdk) to
show base SDK install and usage first, with code-interpreter as a
separate step for code execution.
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 23, 2026

⚠️ No Changeset found

Latest commit: 9eaed43

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 23, 2026

Package Artifacts

Built from fe192a0. Download artifacts from this workflow run.

JS SDK (e2b@2.15.1-fix-code-interpreter-imports.0):

npm install ./e2b-2.15.1-fix-code-interpreter-imports.0.tgz

CLI (@e2b/cli@2.8.3-fix-code-interpreter-imports.0):

npm install ./e2b-cli-2.8.3-fix-code-interpreter-imports.0.tgz

Python SDK (e2b==2.16.0+fix-code-interpreter-imports):

pip install ./e2b-2.16.0+fix.code.interpreter.imports-py3-none-any.whl

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0a57c22919

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

JavaScript / TypeScript
```ts
import { Sandbox } from '@e2b/code-interpreter'
import Sandbox from 'e2b'
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use named Sandbox import in quickstart snippet

e2b publishes a CommonJS main entry and no exports map, so in plain Node ESM environments import Sandbox from 'e2b' binds to the module object rather than the Sandbox class; users who copy this snippet can hit Sandbox.create is not a function at runtime. Switching the example to import { Sandbox } from 'e2b' avoids that interop pitfall and matches the SDK’s own API examples.

Useful? React with 👍 / 👎.

README.md Outdated
console.log(execution.text) // outputs 2
```

### 4. Check docs
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be 5

@beran-t beran-t merged commit a240f99 into main Mar 24, 2026
22 checks passed
@beran-t beran-t deleted the fix-code-interpreter-imports branch March 24, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants