A Python library for the Docker Engine API.
Project description
Docker SDK for Python
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.
Installation
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]
Usage
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.
Project details
Release history Release notifications | RSS feed
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
Hashes for docker-4.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03a46400c4080cb6f7aa997f881ddd84fef855499ece219d75fbdb53289c17ab |
|
MD5 | 9a5719f849d7c9a1a2c5a3c510940eab |
|
BLAKE2-256 | 3c157a2f095a3b8b0fff9a0a5f56bd941e05fa958d4ca31105541001a5f7d3eb |