Dagger Python SDK
A client package for running Dagger pipelines.
What is the Dagger Python SDK?
The Dagger Python SDK contains everything you need to develop CI/CD pipelines in Python, and run them on any OCI-compatible container runtime.
Requirements
- Python 3.10 or later
- Docker, or another OCI-compatible container runtime
A compatible version of the Dagger CLI is automatically downloaded and run by the SDK for you, although it’s possible to manage it manually.
Installation
From PyPI, using pip:
pip install dagger-io
You can also install via Conda, from the conda-forge channel:
conda install dagger-io
Example
Create a main.py file:
import sys
import anyio
import dagger
from dagger import dag
async def main(args: list[str]):
async with dagger.connection():
# build container with cowsay entrypoint
ctr = (
dag.container()
.from_("python:alpine")
.with_exec(["pip", "install", "cowsay"])
)
# run cowsay with requested message
result = await ctr.with_exec(["cowsay", *args]).stdout()
print(result)
anyio.run(main, sys.argv[1:])
Run with:
$ python main.py "Simple is better than complex"
_____________________________
| Simple is better than complex |
=============================
\
\
^__^
(oo)\_______
(__)\ )\/\
||----w |
|| ||
Note It may take a while for it to finish, especially on first run with cold cache.
If you need to debug, you can stream the logs from the engine with the log_output config:
config = dagger.Config(log_output=sys.stderr)
async with dagger.connection(config):
...
Learn more
Development
The SDK is managed with a Dagger module in ./dev. To see which tasks are
available run:
dagger call -m dev
Common tasks
Run pytest in supported Python versions:
dagger call -m dev test default
Check for linting violations:
dagger call -m dev lint
Re-format code following common styling conventions:
dagger call -m dev format export --path=.
Update pinned development dependencies (run from this directory, ./sdk/python, or adjust export path accordingly):
dagger call -m ../../toolchains/python-sdk-dev dev-container with-exec --args uv,lock,-U directory --path . export --path .
Update a single pinned development dependency (run from this directory, ./sdk/python, or adjust export path accordingly):
dagger call -m ../../toolchains/python-sdk-dev dev-container with-exec --args uv,lock,-P,<DEPNAME> directory --path . export --path .
Build and preview the reference documentation:
dagger call -m dev docs preview up
Add --help to any command to check all the available options.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dagger_io-0.21.9.tar.gz.
File metadata
- Download URL: dagger_io-0.21.9.tar.gz
- Upload date:
- Size: 124.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Wolfi","version":"20230201","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
42fb15d4db5bf2ecb305140f7cc80d931448204afa03ad5ef033568e3fe6e9bb
|
|
| MD5 |
e343ebcb82d02086dae75222e016ddef
|
|
| BLAKE2b-256 |
8e9ed689cc31e72b090d567517137114cdaf2e2c4bf39da5837834f5af89f147
|
File details
Details for the file dagger_io-0.21.9-py3-none-any.whl.
File metadata
- Download URL: dagger_io-0.21.9-py3-none-any.whl
- Upload date:
- Size: 112.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Wolfi","version":"20230201","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
977e00fad736b8b7cd44cf97977091f5f36bc358f8082b1cf45bfbc5c57cfff7
|
|
| MD5 |
1de7e040163c2230f9c56882c3ad7d0f
|
|
| BLAKE2b-256 |
0a7b586603482b61478dac61706615a78fb4264ea6402f4644ce4d6c4646eafe
|
