The Wayback Machine - https://web.archive.org/web/20190602192932/https://github.com/docker/docker-py
Skip to content
A Python library for the Docker Engine API
Branch: master
Clone or download
shin- Merge pull request #2353 from mildlyincompetent/improve-healthcheck
Handle `str` in setter for test on HealthCheck
Latest commit 0f36893 May 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker Clean up healtcheck.py docs May 31, 2019
docs Changelog 4.0.1 May 19, 2019
scripts Fix versions.py to include release stage May 1, 2019
tests Xfail test_attach_stream_and_cancel on TLS May 19, 2019
.coveragerc Add coverage Jul 11, 2014
.dockerignore Makes docs builds faster and ensures proper ownership Apr 15, 2017
.editorconfig Add EditorConfig to the repo. Oct 22, 2015
.gitignore Add new Sphinx documentation Nov 22, 2016
.readthedocs.yml Add readthedocs config May 19, 2019
.travis.yml Stop supporting EOL Python 3.4 May 2, 2019
CONTRIBUTING.md Rename non-URL occurrences of docker-py to "Docker SDK for Python" Dec 12, 2016
Dockerfile Merge pull request #1315 from bfirsh/rename-docker-py-to-docker-sdk-p… Dec 2, 2016
Dockerfile-docs Makes docs builds faster and ensures proper ownership Apr 15, 2017
Dockerfile-py3 Add Python 3.6 testing Jan 23, 2018
Jenkinsfile New Jenkinsfile build instructions May 1, 2019
LICENSE Fix licenses Sep 5, 2016
MAINTAINERS Update MAINTAINERS file Mar 29, 2018
MANIFEST.in Make dockerpycreds part of the SDK under docker.credentials May 1, 2019
Makefile Merge pull request #2328 from docker/modernize_test_deps May 1, 2019
README.md Require "requests[security]" if the `[tls]` option is selected, which… Aug 17, 2017
appveyor.yml Add Python 3.6 testing Jan 23, 2018
docs-requirements.txt Add new Sphinx documentation Nov 22, 2016
pytest.ini Re-enable stdout/stderr capturing in tests Jan 25, 2016
requirements.txt Bump urllib3 -> 1.24.3 May 15, 2019
setup.cfg Add License to PyPi metadata Mar 17, 2017
setup.py Stop supporting EOL Python 3.4 May 2, 2019
test-requirements.txt Stop supporting EOL Python 3.4 May 2, 2019
tox.ini Stop supporting EOL Python 3.4 May 2, 2019

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.

You can’t perform that action at this time.