Skip to main content

A Python library for the Docker Engine API.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docker-2.7.0.tar.gz (166.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docker-2.7.0-py2.py3-none-any.whl (119.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file docker-2.7.0.tar.gz.

File metadata

  • Download URL: docker-2.7.0.tar.gz
  • Upload date:
  • Size: 166.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for docker-2.7.0.tar.gz
Algorithm Hash digest
SHA256 144248308e8ea31c4863c6d74e1b55daf97cc190b61d0fe7b7313ab920d6a76c
MD5 994e82eaa070c45797c82547f94fc0b6
BLAKE2b-256 eee6f0b3ca4d0f973751a012734c84339468d30895f60077c08cdbe215c841f7

See more details on using hashes here.

File details

Details for the file docker-2.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for docker-2.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c1d4e37b1ea03b2b6efdd0379640f6ea372fefe56efa65d4d17c34c6b9d54558
MD5 56bcd1525c97595df0ef7cb29b077f56
BLAKE2b-256 6b0174d61c7de9fb99cebbbfab62ee5c88a9b23e8b1c25a57eded5fc22e87bd2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page