A Python library for the Docker Engine API
Go to file
adrianliaw 2a6926b5ab Use collection's get method inside ImageCollection's list method
Signed-off-by: Adrian Liaw <adrianliaw2000@gmail.com>
2017-08-17 13:38:40 -07:00
docker Use collection's get method inside ImageCollection's list method 2017-08-17 13:38:40 -07:00
docs Added wait to the Container class documentation. 2017-08-17 13:38:40 -07:00
scripts Update release script. Bump to rc2 2016-03-23 13:45:39 -07:00
tests Handle untyped ContainerSpec dict in _check_api_features 2017-08-17 13:38:40 -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 Temporarily - do not run py33 tests on travis 2017-08-17 13:38:40 -07: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 Return generator for output of load_image endpoint 2017-08-17 13:38:40 -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 Require "requests[security]" if the `[tls]` option is selected, which also installs: 2017-08-17 13:38:40 -07:00
appveyor.yml Upgrade tox and virtualenv in appveyor to make sure we have the latest pip. 2017-08-17 13:38:40 -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 If we're pinning exact versions of things for requirements.txt, pin 2017-08-17 13:38:40 -07:00
setup.cfg Add License to PyPi metadata 2017-03-17 13:39:55 -04:00
setup.py If we're pinning exact versions of things for requirements.txt, pin 2017-08-17 13:38:40 -07: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

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.