Python Other
Latest commit 7880c5a May 16, 2017 @shin- shin- dev version
Signed-off-by: Joffrey F <[email protected]>
Permalink
Failed to load latest commit information.
docker dev version May 17, 2017
docs Bump 2.3.0 May 16, 2017
scripts Update release script. Bump to rc2 Mar 23, 2016
tests Merge pull request #1605 from allencloud/update-test-status-code-from… May 15, 2017
.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 Drop support for Python 2.6 Nov 22, 2016
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 Merge pull request #1315 from bfirsh/rename-docker-py-to-docker-sdk-p… Dec 2, 2016
Jenkinsfile Adjust tests and add newest engine version to Jenkinsfile May 10, 2017
LICENSE Fix licenses Sep 5, 2016
MAINTAINERS Rename non-URL occurrences of docker-py to "Docker SDK for Python" Dec 12, 2016
MANIFEST.in Add create_plugin implementation Feb 10, 2017
Makefile Adjust tests and add newest engine version to Jenkinsfile May 10, 2017
README.md case PyPI correctly Jan 13, 2017
appveyor.yml Fix test issues Mar 29, 2017
docs-requirements.txt Add new Sphinx documentation Nov 22, 2016
pytest.ini Re-enable stdout/stderr capturing in tests Jan 25, 2016
requirements.txt Support requests versions from 2.11.1 onwards Oct 3, 2016
setup.cfg Add License to PyPi metadata Mar 17, 2017
setup.py Prevent issues when installing docker and docker-py in the same envir… Jan 19, 2017
test-requirements.txt support Python 3.5 May 19, 2016
tox.ini Fix test issues Mar 29, 2017
win32-requirements.txt pypiwin32 added to requirements Jun 3, 2016

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

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", "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.