A Python library for the Docker Engine API
Go to file
Joffrey F 2e67cd1cc7 Improve socket_detached test helper to support future versions of the daemon
Signed-off-by: Joffrey F <joffrey@docker.com>
2019-05-01 00:35:12 -07:00
docker Merge pull request #2309 from thaJeztah/remove_init_path_create 2019-04-30 23:37:06 -07:00
docs Bump 3.7.1 2019-03-20 11:56:24 +01:00
scripts Fix versions.py to include release stage 2019-04-30 23:16:09 -07:00
tests Improve socket_detached test helper to support future versions of the daemon 2019-05-01 00:35:12 -07:00
.coveragerc Add coverage 2014-07-11 16:13:00 +02:00
.dockerignore Makes docs builds faster and ensures proper ownership 2017-04-15 15:46:52 +02:00
.editorconfig Add EditorConfig to the repo. 2015-10-22 14:06:45 +00:00
.gitignore Add new Sphinx documentation 2016-11-22 17:05:43 +00:00
.travis.yml Update deps for 3.3 & 3.7 support 2018-07-18 19:21:54 -07:00
CONTRIBUTING.md Rename non-URL occurrences of docker-py to "Docker SDK for Python" 2016-12-12 13:28:49 -08:00
Dockerfile Merge pull request #1315 from bfirsh/rename-docker-py-to-docker-sdk-python 2016-12-02 15:20:34 -08:00
Dockerfile-docs Makes docs builds faster and ensures proper ownership 2017-04-15 15:46:52 +02:00
Dockerfile-py3 Add Python 3.6 testing 2018-01-22 18:08:01 -08:00
Jenkinsfile Remove use_config_proxy from exec. Add use_config_proxy docs to DockerClient 2019-01-09 14:45:13 -08:00
LICENSE Fix licenses 2016-09-05 17:48:09 +02:00
MAINTAINERS Update MAINTAINERS file 2018-03-29 16:25:14 -07:00
MANIFEST.in Add create_plugin implementation 2017-02-09 17:58:05 -08:00
Makefile Use networks instead of legacy links for test setup 2018-03-20 10:14:09 +01:00
README.md Require "requests[security]" if the `[tls]` option is selected, which also installs: 2017-08-17 13:38:40 -07:00
appveyor.yml Add Python 3.6 testing 2018-01-22 18:08:01 -08:00
docs-requirements.txt Add new Sphinx documentation 2016-11-22 17:05:43 +00:00
pytest.ini Re-enable stdout/stderr capturing in tests 2016-01-25 11:43:23 +00:00
requirements.txt Terminate support for Python 3.3 (EOL in 2018) 2019-03-16 09:41:38 -07:00
setup.cfg Add License to PyPi metadata 2017-03-17 13:39:55 -04:00
setup.py Terminate support for Python 3.3 (EOL in 2018) 2019-03-16 09:41:38 -07:00
test-requirements.txt Terminate support for Python 3.3 (EOL in 2018) 2019-03-16 09:41:38 -07:00
tox.ini Update deps for 3.3 & 3.7 support 2018-07-18 19:21:54 -07:00
win32-requirements.txt Fix appveyor tests 2018-01-26 13:44:31 -08:00

README.md

Docker SDK for Python

Build Status

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.