Image

Image

class Image(BaseModel)

Represents an image definition for a Daytona sandbox. Do not construct this class directly. Instead use one of its static factory methods, such as Image.base(), Image.debian_slim(), or Image.from_dockerfile().

Image.dockerfile

def dockerfile() -> str

Returns a generated Dockerfile for the image.

Image.pip_install

def pip_install(*packages: str | list[str],
                find_links: list[str] | None = None,
                index_url: str | None = None,
                extra_index_urls: list[str] | None = None,
                pre: bool = False,
                extra_options: str = "") -> "Image"

Adds commands to install packages using pip.

Arguments:

• *packages - The packages to install.
• find_links - list[str] | None: The find-links to use.
• index_url - str | None: The index URL to use.
• extra_index_urls - list[str] | None: The extra index URLs to use.
• pre - bool = False: Whether to install pre-release packages.
• extra_options - str = "": Additional options to pass to pip. Given string is passed directly to the pip install command.

Returns:

• Image - The image with the pip install commands added.

Example:

image = Image.debian_slim("3.12").pip_install("requests", "pandas")

Image.pip_install_from_requirements

def pip_install_from_requirements(requirements_txt: str,
                                  find_links: list[str] | None = None,
                                  index_url: str | None = None,
                                  extra_index_urls: list[str] | None = None,
                                  pre: bool = False,
                                  extra_options: str = "") -> "Image"

Installs dependencies from a requirements.txt file.

Arguments:

• requirements_txt - str: The path to the requirements.txt file.
• find_links - list[str] | None: The find-links to use.
• index_url - str | None: The index URL to use.
• extra_index_urls - list[str] | None: The extra index URLs to use.
• pre - bool = False: Whether to install pre-release packages.
• extra_options - str = "": Additional options to pass to pip.

Returns:

• Image - The image with the pip install commands added.

Example:

image = Image.debian_slim("3.12").pip_install_from_requirements("requirements.txt")

Image.pip_install_from_pyproject

def pip_install_from_pyproject(pyproject_toml: str,
                               optional_dependencies: list[str],
                               find_links: str | None = None,
                               index_url: str | None = None,
                               extra_index_url: str | None = None,
                               pre: bool = False,
                               extra_options: str = "") -> "Image"

Installs dependencies from a pyproject.toml file.

Arguments:

• pyproject_toml - str: The path to the pyproject.toml file.
• optional_dependencies - list[str] = []: The optional dependencies to install from the pyproject.toml file.
• find_links - str | None = None: The find-links to use.
• index_url - str | None = None: The index URL to use.
• extra_index_url - str | None = None: The extra index URL to use.
• pre - bool = False: Whether to install pre-release packages.
• extra_options - str = "": Additional options to pass to pip. Given string is passed directly to the pip install command.

Returns:

• Image - The image with the pip install commands added.

Example:

image = Image.debian_slim("3.12")                 .pip_install_from_pyproject("pyproject.toml", optional_dependencies=["dev"])

Image.add_local_file

def add_local_file(local_path: str | Path, remote_path: str) -> "Image"

Adds a local file to the image.

Arguments:

• local_path - str | Path: The path to the local file.
• remote_path - str: The path to the file in the image.

Returns:

• Image - The image with the local file added.

Example:

image = Image.debian_slim("3.12").add_local_file("package.json", "/home/daytona/package.json")

Image.add_local_dir

def add_local_dir(local_path: str | Path, remote_path: str) -> "Image"

Adds a local directory to the image.

Arguments:

• local_path - str | Path: The path to the local directory.
• remote_path - str: The path to the directory in the image.

Returns:

• Image - The image with the local directory added.

Example:

image = Image.debian_slim("3.12").add_local_dir("src", "/home/daytona/src")

Image.run_commands

def run_commands(*commands: str | list[str]) -> "Image"

Runs commands in the image.

Arguments:

• *commands - The commands to run.

Returns:

• Image - The image with the commands added.

Example:

image = Image.debian_slim("3.12").run_commands(
    'echo "Hello, world!"',
    ['bash', '-c', 'echo Hello, world, again!']
)

Image.env

def env(env_vars: dict[str, str]) -> "Image"

Sets environment variables in the image.

Arguments:

• env_vars - dict[str, str]: The environment variables to set.

Returns:

• Image - The image with the environment variables added.

Example:

image = Image.debian_slim("3.12").env({"PROJECT_ROOT": "/home/daytona"})

Image.workdir

def workdir(path: str | Path) -> "Image"

Sets the working directory in the image.

Arguments:

• path - str | Path: The path to the working directory.

Returns:

• Image - The image with the working directory added.

Example:

image = Image.debian_slim("3.12").workdir("/home/daytona")

Image.entrypoint

def entrypoint(entrypoint_commands: list[str]) -> "Image"

Sets the entrypoint for the image.

Arguments:

• entrypoint_commands - list[str]: The commands to set as the entrypoint.

Returns:

• Image - The image with the entrypoint added.

Example:

image = Image.debian_slim("3.12").entrypoint(["/bin/bash"])

Image.cmd

def cmd(cmd: list[str]) -> "Image"

Sets the default command for the image.

Arguments:

• cmd - list[str]: The commands to set as the default command.

Returns:

• Image - The image with the default command added.

Example:

image = Image.debian_slim("3.12").cmd(["/bin/bash"])

Image.dockerfile_commands

def dockerfile_commands(dockerfile_commands: list[str],
                        context_dir: Path | str | None = None) -> "Image"

Adds arbitrary Dockerfile-like commands to the image.

Arguments:

• *dockerfile_commands - The commands to add to the Dockerfile.
• context_dir - Path | str | None: The path to the context directory.

Returns:

• Image - The image with the Dockerfile commands added.

Example:

image = Image.debian_slim("3.12").dockerfile_commands(["RUN echo 'Hello, world!'"])

Image.from_dockerfile

@staticmethod
def from_dockerfile(path: str | Path) -> "Image"

Creates an Image from an existing Dockerfile.

Arguments:

• path - str | Path: The path to the Dockerfile.

Returns:

• Image - The image with the Dockerfile added.

Example:

image = Image.from_dockerfile("Dockerfile")

Image.base

@staticmethod
def base(image: str) -> "Image"

Creates an Image from an existing base image.

Arguments:

• image - str: The base image to use.

Returns:

• Image - The image with the base image added.

Example:

image = Image.base("python:3.12-slim-bookworm")

Image.debian_slim

@staticmethod
def debian_slim(
        python_version: SupportedPythonSeries | None = None) -> "Image"

Creates a Debian slim image based on the official Python Docker image.

Arguments:

• python_version - SupportedPythonSeries | None: The Python version to use.

Returns:

• Image - The image with the Debian slim image added.

Example:

image = Image.debian_slim("3.12")

Context

class Context(BaseModel)

Context for an image.

Attributes:

• source_path str - The path to the source file or directory.
• archive_path str | None - The path inside the archive file in object storage.