commit | 264688e37c9496496807edfd305aea60b57e1adf | [log] [tgz] |
---|---|---|
author | Anca Iordache <aiordache@users.noreply.github.com> | Wed Sep 01 16:55:38 2021 |
committer | GitHub <noreply@github.com> | Wed Sep 01 16:55:38 2021 |
tree | 6a8a6166bf6c5f1b7ab4fd5de1137f3503fb6a6b | |
parent | d06db4d9e133d0f427a29d8abdfff44733697066 [diff] | |
parent | 2fa56879a2f978387d230db087003d79eb2762d0 [diff] |
Merge pull request #2878 from sina-rostami/master Improve containers documentation
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.