A Python library for the Docker Engine API
Go to file
Joffrey F 15030cb680 Merge pull request #1661 from shin-/1622-service-tty
Add support for ContainerSpec.TTY
2017-06-22 16:39:35 -07:00
docker Merge pull request #1661 from shin-/1622-service-tty 2017-06-22 16:39:35 -07:00
docs Fix test cases for ``runtime`` config 2017-06-07 10:47:27 +05:30
scripts Update release script. Bump to rc2 2016-03-23 13:45:39 -07:00
tests Merge pull request #1661 from shin-/1622-service-tty 2017-06-22 16:39:35 -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 Drop support for Python 2.6 2016-11-22 17:03:03 +00: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 Merge pull request #1315 from bfirsh/rename-docker-py-to-docker-sdk-python 2016-12-02 15:20:34 -08:00
Jenkinsfile Adjust tests and add newest engine version to Jenkinsfile 2017-05-09 17:18:46 -07:00
LICENSE Fix licenses 2016-09-05 17:48:09 +02:00
MAINTAINERS Rename non-URL occurrences of docker-py to "Docker SDK for Python" 2016-12-12 13:28:49 -08:00
MANIFEST.in Add create_plugin implementation 2017-02-09 17:58:05 -08:00
Makefile Adjust tests and add newest engine version to Jenkinsfile 2017-05-09 17:18:46 -07:00
README.md case PyPI correctly 2017-01-13 10:00:41 +00:00
appveyor.yml Fix test issues 2017-03-29 15:39:48 -07: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 Support requests versions from 2.11.1 onwards 2016-10-03 18:46:28 +03:00
setup.cfg Add License to PyPi metadata 2017-03-17 13:39:55 -04:00
setup.py excludes requests 2.18.0 from compatible versions 2017-06-14 14:44:56 -04:00
test-requirements.txt support Python 3.5 2016-05-19 17:59:34 +01:00
tox.ini Fix test issues 2017-03-29 15:39:48 -07:00
win32-requirements.txt pypiwin32 added to requirements 2016-06-02 17:59:50 -07: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

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.