A Python library for the Docker Engine API
Go to file
Joffrey F 62e223208f Reference new methods in docs
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-01-30 18:54:18 -08:00
docker Reference new methods in docs 2017-01-30 18:54:18 -08:00
docs Reference new methods in docs 2017-01-30 18:54:18 -08:00
scripts Update release script. Bump to rc2 2016-03-23 13:45:39 -07:00
tests Add prune_networks method 2017-01-30 18:54:18 -08:00
.coveragerc Add coverage 2014-07-11 16:13:00 +02:00
.dockerignore Update mkdocs.yml to reference new Machine page. 2016-03-22 17:22:28 -07: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 Start to rename docker-py to docker-sdk-python 2016-11-28 16:45:59 +00: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 Add stop_timeout to create_container 2017-01-27 16:00:18 -08: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 README.rst to MANIFEST 2016-03-23 13:14:25 -07:00
Makefile Allow configuring API version for integration test with env var 2017-01-25 16:52:26 -08:00
README.md case PyPI correctly 2017-01-13 10:00:41 +00: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 Bump version + Update Changelog 2016-09-09 16:55:10 -07:00
setup.py Prevent issues when installing docker and docker-py in the same environment 2017-01-18 16:26:22 -08:00
test-requirements.txt support Python 3.5 2016-05-19 17:59:34 +01:00
tox.ini Drop support for Python 2.6 2016-11-22 17:03:03 +00: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.