Python Other
Latest commit 8cb5b52 Oct 17, 2017 @janLo janLo committed with shin- Fix simple documentation copy/paste error.
Signed-off-by: Jan Losinski <[email protected]>
Permalink
Failed to load latest commit information.
docker Fix simple documentation copy/paste error. Oct 17, 2017
docs Changelog typo Aug 17, 2017
scripts Update release script. Bump to rc2 Mar 23, 2016
tests Remove superfluous version validation Oct 2, 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 Temporarily - do not run py33 tests on travis Aug 17, 2017
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 Bump 2.5.0 Aug 17, 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 Use unambiguous advertise-addr when initializing a swarm Aug 31, 2017
README.md Require "requests[security]" if the `[tls]` option is selected, which… Aug 17, 2017
appveyor.yml Upgrade tox and virtualenv in appveyor to make sure we have the lates… Aug 17, 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 If we're pinning exact versions of things for requirements.txt, pin Aug 17, 2017
setup.cfg Add License to PyPi metadata Mar 17, 2017
setup.py If we're pinning exact versions of things for requirements.txt, pin Aug 17, 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

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.