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.6.1.tar.gz (162.7 kB view details)

Uploaded Source

Built Distribution

docker-2.6.1-py2.py3-none-any.whl (117.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.6.1.tar.gz
Algorithm Hash digest
SHA256 6f417527b3cfd7ba1f5be5fb1d9a2500706b5968f66773131d81c18e19b7a325
MD5 be4c90ee936ad0af4c45532616bf8b52
BLAKE2b-256 20733bb05004dcc734182d57a1c8a802732e05788678a71bfa12348a614d5d73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 11589e3a7742f900978b4d3e3a6910542ea44cc65de82835dc5f25fcdedc2c23
MD5 c31728b845913c83df42bb73dcb85976
BLAKE2b-256 e65a75a0ea7bba76f95c3a8bd5c47050945dd38376cea89700959ffc7cce1b22

See more details on using hashes here.

Supported by

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