Merge pull request #1343 from docker/2.0.0-release

2.0.0 release
tree: 392ebafeb561b4ed7aca9888279a15e5f92024e3
  1. docker/
  2. docs/
  3. scripts/
  4. tests/
  5. .coveragerc
  6. .dockerignore
  7. .editorconfig
  8. .gitignore
  9. .travis.yml
  10. CONTRIBUTING.md
  11. Dockerfile
  12. Dockerfile-docs
  13. Dockerfile-py3
  14. docs-requirements.txt
  15. LICENSE
  16. MAINTAINERS
  17. Makefile
  18. MANIFEST.in
  19. pytest.ini
  20. README.md
  21. requirements.txt
  22. setup.cfg
  23. setup.py
  24. test-requirements.txt
  25. tox.ini
  26. win32-requirements.txt
README.md

Docker SDK for Python

Build Status

Warning: This README is for the development version of the Docker SDK for Python, which is significantly different to the stable version. Documentation for the stable version is here.

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.