commit | 2bb08b3985fbde794a75fbf321872c9c4d84abf9 | [log] [tgz] |
---|---|---|
author | Christopher Crone <christopher.crone@docker.com> | Thu Oct 03 13:44:27 2019 |
committer | Christopher Crone <christopher.crone@docker.com> | Thu Oct 03 13:49:27 2019 |
tree | ff32ad6d9b7ade893eafc55e9f7fc48be8588a1f | |
parent | 88219c682c9ba673a03197191233cb3a7c69167d [diff] |
Bump 4.1.0 Signed-off-by: Christopher Crone <christopher.crone@docker.com>
A Python library for the Docker Engine API. It lets you do anything the docker
command does, but from within Python apps – run containers, manage containers, manage Swarms, etc.
The latest stable version is available on PyPI. Either add docker
to your requirements.txt
file or install with pip:
pip install docker
If you are intending to connect to a docker host via TLS, add docker[tls]
to your requirements instead, or install with pip:
pip install docker[tls]
Connect to Docker using the default socket or the configuration in your environment:
import docker client = docker.from_env()
You can run containers:
>>> client.containers.run("ubuntu:latest", "echo hello world") 'hello world\n'
You can run containers in the background:
>>> client.containers.run("bfirsh/reticulate-splines", detach=True) <Container '45e6d2de7c54'>
You can manage containers:
>>> client.containers.list() [<Container '45e6d2de7c54'>, <Container 'db18e4f20eaa'>, ...] >>> container = client.containers.get('45e6d2de7c54') >>> container.attrs['Config']['Image'] "bfirsh/reticulate-splines" >>> container.logs() "Reticulating spline 1...\n" >>> container.stop()
You can stream logs:
>>> for line in container.logs(stream=True): ... print line.strip() Reticulating spline 2... Reticulating spline 3... ...
You can manage images:
>>> client.images.pull('nginx') <Image 'nginx'> >>> client.images.list() [<Image 'ubuntu'>, <Image 'nginx'>, ...]
Read the full documentation to see everything you can do.