tree: 40380845da7b076a3c2a3fbd9f5f98cd158b829f [path history] [tgz]
  1. .github/
  2. docker/
  3. docs/
  4. scripts/
  5. tests/
  6. .coveragerc
  7. .dockerignore
  8. .editorconfig
  9. .gitignore
  10. .readthedocs.yml
  11. appveyor.yml
  12. CONTRIBUTING.md
  13. Dockerfile
  14. Dockerfile-docs
  15. Dockerfile-py3
  16. docs-requirements.txt
  17. Jenkinsfile
  18. LICENSE
  19. MAINTAINERS
  20. Makefile
  21. MANIFEST.in
  22. pytest.ini
  23. README.md
  24. requirements.txt
  25. setup.cfg
  26. setup.py
  27. test-requirements.txt
  28. tox.ini
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.