A Python library for the Docker Engine API
Go to file
Ben Firshman 1984f68730
Add new user-focused API
See #1086

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-11-22 17:05:43 +00:00
docker Add new user-focused API 2016-11-22 17:05:43 +00:00
docs Move contributing docs to CONTRIBUTING.md 2016-11-22 17:03:04 +00:00
scripts Update release script. Bump to rc2 2016-03-23 13:45:39 -07:00
tests Add new user-focused API 2016-11-22 17:05:43 +00: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 Basic release script 2016-03-22 17:56:30 -07:00
.travis.yml Drop support for Python 2.6 2016-11-22 17:03:03 +00:00
CONTRIBUTING.md Move contributing docs to CONTRIBUTING.md 2016-11-22 17:03:04 +00:00
Dockerfile Different requirements.txt in Dockerfile-py3 2016-03-29 17:36:10 -07:00
Dockerfile-docs Add make docs command for building docs 2016-09-05 19:23:04 +02:00
Dockerfile-py3 update docs to py3.5 2016-05-19 18:04:46 +01:00
LICENSE Fix licenses 2016-09-05 17:48:09 +02:00
MAINTAINERS update maintainers file for parsing 2015-12-09 15:37:37 +01:00
MANIFEST.in Add README.rst to MANIFEST 2016-03-23 13:14:25 -07:00
Makefile Add --rm to docker run in Makefile 2016-11-21 14:07:39 +00:00
README.md Add new user-focused API 2016-11-22 17:05:43 +00:00
docs-requirements.txt Add make docs command for building docs 2016-09-05 19:23:04 +02:00
mkdocs.yml Add new pages to mkdocs index 2016-08-19 17:02:33 -07: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 Drop support for Python 2.6 2016-11-22 17:03:03 +00: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 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.