Upgrade Template to new SDK (#166)

* initial commit

* cursor suggestions

* updated

* fix template

* fmt

* removed unused env vars

* updated ci

* python build ci test

* dependencies

* removed dotenv from ci

* add capture for template id, build id

* fixes java test, template name

* lint

* added changeset

* readded cleanup

* updated release CI

* updated dockerhub push tag

* updated readme

* remove poetry from template build ci

* generate template alias before test run

* updated workflow

* updated generated template alias for clarity

* updated output

* removed unused build_id output

* corrected outputs

* pin r, java, deno versions

* install java from source, keep java 11

* make sure python & js kernels always installed

* fixes java home

* make kernels set

Author: mishushakov

.changeset/empty-wasps-count.md

@@ -0,0 +1,5 @@
+---
+'@e2b/code-interpreter-template': minor
+---
+
+updated template to new SDK

.github/workflows/build_test_template.yml

@@ -3,7 +3,7 @@ name: Build Template
 on:
   workflow_call:
     secrets:
-      E2B_TESTS_ACCESS_TOKEN:
+      E2B_API_KEY:
         required: true
     inputs:
       E2B_DOMAIN:
@@ -22,7 +22,7 @@ jobs:
     name: Build E2B Template
     runs-on: ubuntu-latest
     outputs:
-      template_id: ${{ steps.build-template.outputs.template_id }}
+      template_id: ${{ steps.generate-template-id.outputs.template_id }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -34,22 +34,27 @@ jobs:
           echo "Version: $VERSION"
           sed -i "s/e2b_charts/e2b_charts==${VERSION}/g" requirements.txt
 
-      - name: Install E2B CLI
-        run: npm install -g @e2b/cli
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.13' 
+
+      - name: Install development dependencies
+        working-directory: ./template
+        run: pip install -r requirements-dev.txt
+
+      - name: Generate Template ID
+        id: generate-template-id
+        run: |
+          E2B_TESTS_TEMPLATE=e2b-code-interpreter-ci-$(uuidgen)
+          echo "Generated Template ID: $E2B_TESTS_TEMPLATE"
+          echo "template_id=$E2B_TESTS_TEMPLATE" >> $GITHUB_OUTPUT
 
       - name: Build E2B template
         id: build-template
-        run: |
-          rm -f e2b.toml
-          e2b template build --memory-mb 1024 -c "/root/.jupyter/start-up.sh" -d "Dockerfile"
-          TEMPLATE_ID=$(grep "template_id" e2b.toml | cut -d '"' -f 2)
-          echo "Captured Template ID: $TEMPLATE_ID"
-          echo "template_id=$TEMPLATE_ID" >> $GITHUB_OUTPUT
         working-directory: ./template
+        run: |
+          python build_ci.py
         env:
-          E2B_ACCESS_TOKEN: ${{ secrets.E2B_TESTS_ACCESS_TOKEN }}
+          E2B_API_KEY: ${{ secrets.E2B_API_KEY }}
           E2B_DOMAIN: ${{ inputs.E2B_DOMAIN }}
-
-      - name: Output template ID
-        run: |
-          echo "Template ID from step output: ${{ steps.build-template.outputs.template_id }}"
+          E2B_TESTS_TEMPLATE: ${{ steps.generate-template-id.outputs.template_id }}

.github/workflows/pull_request.yml

@@ -17,7 +17,7 @@ jobs:
   build-template:
     uses: ./.github/workflows/build_test_template.yml
     secrets:
-      E2B_TESTS_ACCESS_TOKEN: ${{ secrets.E2B_TESTS_ACCESS_TOKEN }}
+      E2B_API_KEY: ${{ secrets.E2B_API_KEY }}
     with:
       E2B_DOMAIN: ${{ vars.E2B_DOMAIN }}
   js-sdk:

.github/workflows/release.yml

@@ -200,13 +200,13 @@ jobs:
 
           sed -i "s/e2b_charts/e2b_charts==${VERSION}/g" requirements.txt
 
-      - name: Build Docker image
-        uses: docker/build-push-action@v6
-        with:
-          context: ./template
-          push: true
-          platforms: linux/amd64
-          tags: ${{ secrets.DOCKERHUB_USERNAME }}/code-interpreter:latest
+      - name: Build and push to DockerHub
+        working-directory: ./template
+        run: |
+          python build_docker.py | docker buildx build \
+            --platform linux/amd64 \
+            --push \
+            --tag ${{ secrets.DOCKERHUB_USERNAME }}/code-interpreter:latest -f - .
 
   build-template:
     name: Build E2B template
@@ -219,14 +219,22 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-      - name: Install E2B CLI
-        run: npm install -g @e2b/cli
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.13' 
 
-      - name: Build e2b
-        run: e2b template build
+      - name: Install development dependencies
         working-directory: ./template
+        run: pip install -r requirements-dev.txt
+
+      - name: Build E2B template
+        id: build-template
+        working-directory: ./template
+        run: |
+          python build_prod.py
         env:
-          E2B_ACCESS_TOKEN: ${{ secrets.E2B_ACCESS_TOKEN }}
+          E2B_API_KEY: ${{ secrets.E2B_API_KEY }}
+          E2B_DOMAIN: ${{ vars.E2B_DOMAIN }}
 
   python-tests:
     name: Python Tests

Makefile

@@ -1,5 +1,5 @@
 start-template-server:
-	docker run --rm -e E2B_LOCAL=true -p 49999:49999 -it $$(docker build . -q -f ./template/test.Dockerfile)
+	docker run --rm -e E2B_LOCAL=true -p 49999:49999 -it $$(python template/build_docker.py | docker build -q ./template -f -) 
 
 kill-template-server:
 	docker kill $(shell docker ps --filter expose=49999 --format {{.ID}})

template/Dockerfile

@@ -1,45 +1,57 @@
 # Using custom sandbox with Code Interpreter SDK
 
-If you want to customize the Code Interprerter sandbox (e.g.: add a preinstalled package) you can do that by using a [custom sandbox template](https://e2b.dev/docs/sandbox-template).
-
+If you want to customize the Code Interpreter sandbox (e.g.: add a preinstalled package) you can do that by creating a [custom sandbox template](https://e2b.dev/docs/template/quickstart).
 
 ## Step-by-step guide
-1. Create custom sandbox by following [this guide](https://e2b.dev/docs/sandbox-template)
 
-2. Use prebuilt [E2B Code Interpreter image](https://hub.docker.com/r/e2bdev/code-interpreter) by replacing the `FROM` command in your `e2b.Dockerfile` with following
+1. Install E2B SDK
+
+```
+pip install e2b dotenv
+```
+
+2. Create a custom sandbox template:
+
+**template.py**
+
+```python
+from e2b import Template
+
+template = Template().from_template("code-interpreter-v1")
+```
+
+3. Create a build script:
 
-    ```Dockerfile
-    FROM e2bdev/code-interpreter:latest
-    ```
+**build.py**
 
-3. Copy [`start-up.sh`](./start-up.sh) to the same directory where's your `e2b.toml`
+```python
+from dotenv import load_dotenv
+from .template import template
+from e2b import Template, default_build_logger
 
-4. Run the following in the same directory where's your `e2b.toml`
-    ```sh
-    e2b template build -c "/root/.jupyter/start-up.sh"
-    ```
+load_dotenv()
 
-5. Use your custom sandbox with Code Interpreter SDK
+Template.build(
+    template,
+    alias="code-interpreter-custom",
+    cpu_count=2,
+    memory_mb=2048,
+    on_build_logs=default_build_logger(),
+)
+```
 
-   **Python**
-   ```python
-   from e2b_code_interpreter import Sandbox
-   sandbox = Sandbox.create(template="your-custom-sandbox-name")
-   execution = sandbox.run_code("print('hello')")
-   sandbox.kill()
+3. Build the template:
 
-   # Or you can use `with` which handles closing the sandbox for you
-   with Sandbox.create(template="your-custom-sandbox-name") as sandbox:
-       execution = sandbox.run_code("print('hello')")
-   ```
-   
+```
+python build.py
+```
 
-   **JavaScript/TypeScript**
+4. Use the custom template:
 
-   ```js
-   import {Sandbox} from '@e2b/code-interpreter'
+```python
+from e2b import Sandbox
 
-const sandbox = await Sandbox.create({template: 'your-custom-sandbox-name'})
-const execution = await sandbox.runCode('print("hello")')
-await sandbox.kill()
-   ```
+sbx = Sandbox.create(template="code-interpreter-custom")
+execution = sbx.run_code("print('Hello, World!')")
+print(execution.logs.stdout)
+```

template/README.md

@@ -0,0 +1,11 @@
+import os
+from e2b import Template, default_build_logger
+from template import make_template
+
+Template.build(
+    make_template(set_user_workdir=True),
+    alias=os.environ["E2B_TESTS_TEMPLATE"],
+    cpu_count=2,
+    memory_mb=2048,
+    on_build_logs=default_build_logger(),
+)

template/build_ci.py

@@ -0,0 +1,5 @@
+from template import make_template
+from e2b import Template
+
+tmp = make_template(kernels=["python", "javascript"])
+print(Template.to_dockerfile(tmp))

template/build_docker.py

@@ -0,0 +1,13 @@
+from dotenv import load_dotenv
+from e2b import Template, default_build_logger
+from template import make_template
+
+load_dotenv()
+
+Template.build(
+    make_template(set_user_workdir=True),
+    alias="code-interpreter-v1",
+    cpu_count=2,
+    memory_mb=2048,
+    on_build_logs=default_build_logger(),
+)