Dagger Python SDK

A client package for running Dagger pipelines.

Tip

New to Dagger? Learn how it works and start using it.

Reference

• Connection
  • Config
  • Connection
  • Experimental
    • connection()
    • closing()
    • connect()
• Client
  • BuildArg
    • BuildArg.name
    • BuildArg.value
  • CacheID
  • CacheSharingMode
    • CacheSharingMode.LOCKED
    • CacheSharingMode.PRIVATE
    • CacheSharingMode.SHARED
  • CacheVolume
    • CacheVolume.id()
  • Client
    • Client.cache_volume()
    • Client.check_version_compatibility()
    • Client.container()
    • Client.default_platform()
    • Client.directory()
    • Client.file()
    • Client.git()
    • Client.host()
    • Client.http()
    • Client.pipeline()
    • Client.project()
    • Client.project_command()
    • Client.secret()
    • Client.set_secret()
    • Client.socket()
    • Client.with_()
  • Container
    • Container.build()
    • Container.default_args()
    • Container.directory()
    • Container.endpoint()
    • Container.entrypoint()
    • Container.env_variable()
    • Container.env_variables()
    • Container.export()
    • Container.exposed_ports()
    • Container.file()
    • Container.from_()
    • Container.hostname()
    • Container.id()
    • Container.image_ref()
    • Container.import_()
    • Container.label()
    • Container.labels()
    • Container.mounts()
    • Container.pipeline()
    • Container.platform()
    • Container.publish()
    • Container.rootfs()
    • Container.stderr()
    • Container.stdout()
    • Container.sync()
    • Container.user()
    • Container.with_()
    • Container.with_default_args()
    • Container.with_directory()
    • Container.with_entrypoint()
    • Container.with_env_variable()
    • Container.with_exec()
    • Container.with_exposed_port()
    • Container.with_file()
    • Container.with_focus()
    • Container.with_label()
    • Container.with_mounted_cache()
    • Container.with_mounted_directory()
    • Container.with_mounted_file()
    • Container.with_mounted_secret()
    • Container.with_mounted_temp()
    • Container.with_new_file()
    • Container.with_registry_auth()
    • Container.with_rootfs()
    • Container.with_secret_variable()
    • Container.with_service_binding()
    • Container.with_unix_socket()
    • Container.with_user()
    • Container.with_workdir()
    • Container.without_env_variable()
    • Container.without_exposed_port()
    • Container.without_focus()
    • Container.without_label()
    • Container.without_mount()
    • Container.without_registry_auth()
    • Container.without_unix_socket()
    • Container.workdir()
  • ContainerID
  • Directory
    • Directory.diff()
    • Directory.directory()
    • Directory.docker_build()
    • Directory.entries()
    • Directory.export()
    • Directory.file()
    • Directory.id()
    • Directory.pipeline()
    • Directory.sync()
    • Directory.with_()
    • Directory.with_directory()
    • Directory.with_file()
    • Directory.with_new_directory()
    • Directory.with_new_file()
    • Directory.with_timestamps()
    • Directory.without_directory()
    • Directory.without_file()
  • DirectoryID
  • EnvVariable
    • EnvVariable.name()
    • EnvVariable.value()
  • File
    • File.contents()
    • File.export()
    • File.id()
    • File.size()
    • File.sync()
    • File.with_()
    • File.with_timestamps()
  • FileID
  • GitRef
    • GitRef.tree()
  • GitRepository
    • GitRepository.branch()
    • GitRepository.commit()
    • GitRepository.tag()
  • Host
    • Host.directory()
    • Host.file()
    • Host.set_secret_file()
    • Host.unix_socket()
  • ImageLayerCompression
    • ImageLayerCompression.EStarGZ
    • ImageLayerCompression.Gzip
    • ImageLayerCompression.Uncompressed
    • ImageLayerCompression.Zstd
  • ImageMediaTypes
    • ImageMediaTypes.DockerMediaTypes
    • ImageMediaTypes.OCIMediaTypes
  • Label
    • Label.name()
    • Label.value()
  • NetworkProtocol
    • NetworkProtocol.TCP
    • NetworkProtocol.UDP
  • PipelineLabel
    • PipelineLabel.name
    • PipelineLabel.value
  • Platform
  • Port
    • Port.description()
    • Port.port()
    • Port.protocol()
  • Project
    • Project.commands()
    • Project.id()
    • Project.load()
    • Project.name()
    • Project.with_()
  • ProjectCommand
    • ProjectCommand.description()
    • ProjectCommand.flags()
    • ProjectCommand.id()
    • ProjectCommand.name()
    • ProjectCommand.result_type()
    • ProjectCommand.subcommands()
  • ProjectCommandFlag
    • ProjectCommandFlag.description()
    • ProjectCommandFlag.name()
  • ProjectCommandID
  • ProjectID
  • Secret
    • Secret.id()
    • Secret.plaintext()
  • SecretID
  • Socket
    • Socket.id()
  • SocketID
  • default_client()
• Exceptions
  • DaggerError
  • Client execution
    • QueryError
      • QueryError.debug_query()
    • ExecError
      • ExecError.command
      • ExecError.message
      • ExecError.exit_code
      • ExecError.stdout
      • ExecError.stderr
      • ExecError.__str__()
  • Client connection
    • ClientError
    • ClientConnectionError
    • TransportError
    • ExecuteTimeoutError
    • InvalidQueryError
  • Engine provisioning
    • ProvisionError
    • DownloadError
    • SessionError
  • Warnings
    • VersionMismatch

Project links

• PyPI Project

• Conda Package

• Documentation

• Source code

• Release Notes

Indices and tables

• Index

• Module Index

• Search Page