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.5.1.tar.gz (155.1 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.5.1-py2.py3-none-any.whl (111.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.5.1.tar.gz
Algorithm Hash digest
SHA256 b876e6909d8d2360e0540364c3a952a62847137f4674f2439320ede16d6db880
MD5 7d917152976df075e6e90ee853df641f
BLAKE2b-256 ea80f32e70f338055922eb996b05ee41b14acde925216f4e7bba16788a377763

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7b587fa841218b0f27e41d1f1ec61398bd0a8a0cc364f3ab3c08290fa8d59e71
MD5 50409ad5c719c1af8126ff3789efb969
BLAKE2b-256 b84cfb6c7d26ecfb6ea9e24d940edec4c67c2b9fc7c95c72435dfa4a5a0c6085

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