Python Other
shin- Merge pull request #2081 from docker/2078-credhelpers-support
Add credHelpers support to set_auth_headers in build
Latest commit 64a1d8c Jul 19, 2018
Permalink
Failed to load latest commit information.
docker Add credHelpers support to set_auth_headers in build Jul 19, 2018
docs Bump 3.4.0 Jun 18, 2018
scripts Generate test engines list dynamically Mar 29, 2018
tests Merge pull request #2063 from mtszb/master Jun 29, 2018
.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
.travis.yml Update deps for 3.3 & 3.7 support Jul 19, 2018
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 Use networks instead of legacy links for test setup Apr 26, 2018
LICENSE Fix licenses Sep 5, 2016
MAINTAINERS Update MAINTAINERS file Mar 29, 2018
MANIFEST.in Add create_plugin implementation Feb 10, 2017
Makefile Use networks instead of legacy links for test setup Mar 20, 2018
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 Update deps for 3.3 & 3.7 support Jul 19, 2018
setup.cfg Add License to PyPi metadata Mar 17, 2017
setup.py Update deps for 3.3 & 3.7 support Jul 19, 2018
test-requirements.txt Update deps for 3.3 & 3.7 support Jul 19, 2018
tox.ini Update deps for 3.3 & 3.7 support Jul 19, 2018
win32-requirements.txt Fix appveyor tests Jan 26, 2018

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.