Documentation

Template

class Template(TemplateBase)

Synchronous template builder for E2B sandboxes.

build

@staticmethod
def build(template: TemplateClass,
          name: Optional[str] = None,
          *,
          alias: Optional[str] = None,
          tags: Optional[List[str]] = None,
          cpu_count: int = 2,
          memory_mb: int = 1024,
          skip_cache: bool = False,
          on_build_logs: Optional[Callable[[LogEntry], None]] = None,
          **opts: Unpack[ApiParams]) -> BuildInfo

Build and deploy a template to E2B infrastructure. Arguments:

template: The template to build
name: Template name in ‘name’ or ‘name:tag’ format
alias: (Deprecated) Alias name for the template. Use name instead.
tags: Optional additional tags to assign to the template
cpu_count: Number of CPUs allocated to the sandbox
memory_mb: Amount of memory in MB allocated to the sandbox
skip_cache: If True, forces a complete rebuild ignoring cache
on_build_logs: Callback function to receive build logs during the build process Example

from e2b import Template

template = (
    Template()
    .from_python_image('3')
    .copy('requirements.txt', '/home/user/')
    .run_cmd('pip install -r /home/user/requirements.txt')
)

Template.build(template, 'my-python-env:v1.0')

Template.build(template, 'my-python-env', tags=['v1.1.0', 'stable'])

build_in_background

@staticmethod
def build_in_background(template: TemplateClass,
                        name: Optional[str] = None,
                        *,
                        alias: Optional[str] = None,
                        tags: Optional[List[str]] = None,
                        cpu_count: int = 2,
                        memory_mb: int = 1024,
                        skip_cache: bool = False,
                        on_build_logs: Optional[Callable[[LogEntry],
                                                         None]] = None,
                        **opts: Unpack[ApiParams]) -> BuildInfo

Build and deploy a template to E2B infrastructure without waiting for completion. Arguments:

template: The template to build
name: Template name in ‘name’ or ‘name:tag’ format
alias: (Deprecated) Alias name for the template. Use name instead.
tags: Optional additional tags to assign to the template
cpu_count: Number of CPUs allocated to the sandbox
memory_mb: Amount of memory in MB allocated to the sandbox
skip_cache: If True, forces a complete rebuild ignoring cache

Returns: BuildInfo containing the template ID and build ID Example

from e2b import Template

template = (
    Template()
    .from_python_image('3')
    .run_cmd('echo "test"')
    .set_start_cmd('echo "Hello"', 'sleep 1')
)

build_info = Template.build_in_background(template, 'my-python-env:v1.0')

build_info = Template.build_in_background(template, 'my-python-env', tags=['v1.1.0', 'stable'])

get_build_status

@staticmethod
def get_build_status(build_info: BuildInfo,
                     logs_offset: int = 0,
                     **opts: Unpack[ApiParams])

Get the status of a build. Arguments:

build_info: Build identifiers returned from build_in_background
logs_offset: Offset for fetching logs

Returns: TemplateBuild containing the build status and logs Example

from e2b import Template

build_info = Template.build_in_background(template, alias='my-template')
status = Template.get_build_status(build_info, logs_offset=0)

exists

@staticmethod
def exists(name: str, **opts: Unpack[ApiParams]) -> bool

Check if a template with the given name exists. Arguments:

name: Template name to check

Returns: True if the name exists, False otherwise Example

from e2b import Template

exists = Template.exists('my-python-env')
if exists:
    print('Template exists!')

alias_exists

@staticmethod
def alias_exists(alias: str, **opts: Unpack[ApiParams]) -> bool

Check if a template with the given alias exists. Deprecated Use exists instead. Arguments:

alias: Template alias to check

Returns: True if the alias exists, False otherwise Example

from e2b import Template

exists = Template.alias_exists('my-python-env')
if exists:
    print('Template exists!')

assign_tags

@staticmethod
def assign_tags(target_name: str, tags: Union[str, List[str]],
                **opts: Unpack[ApiParams]) -> TemplateTagInfo

Assign tag(s) to an existing template build. Arguments:

target_name: Template name in ‘name:tag’ format (the source build to tag from)
tags: Tag or tags to assign

Returns: TemplateTagInfo with build_id and assigned tags Example

from e2b import Template

result = Template.assign_tags('my-template:v1.0', 'production')

result = Template.assign_tags('my-template:v1.0', ['production', 'stable'])

remove_tags

@staticmethod
def remove_tags(name: str, tags: Union[str, List[str]],
                **opts: Unpack[ApiParams]) -> None

Remove tag(s) from a template. Arguments:

name: Template name
tags: Tag or tags to remove Example

from e2b import Template

Template.remove_tags('my-template', 'production')

Template.remove_tags('my-template', ['production', 'stable'])

check_alias_exists

def check_alias_exists(client: AuthenticatedClient, alias: str) -> bool

Check if a template with the given alias exists. Arguments:

client - Authenticated API client
alias - Template alias to check

Returns: True if the alias exists, False otherwise

assign_tags

def assign_tags(client: AuthenticatedClient, target_name: str,
                tags: List[str]) -> TemplateTagInfo

Assign tag(s) to an existing template build. Arguments:

client - Authenticated API client
target_name - Template name in ‘name:tag’ format (the source build to tag from)
tags - Tags to assign

Returns: TemplateTagInfo with build_id and assigned tags

remove_tags

def remove_tags(client: AuthenticatedClient, name: str,
                tags: List[str]) -> None

Remove tag(s) from a template. Arguments:

client - Authenticated API client
name - Template name
tags - List of tags to remove

​Template

​build

​build_in_background

​get_build_status

​exists

​alias_exists

​assign_tags

​remove_tags

​check_alias_exists

​assign_tags

​remove_tags

Template

build

build_in_background

get_build_status

exists

alias_exists

assign_tags

remove_tags

check_alias_exists

assign_tags

remove_tags