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

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.

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

Uploaded Source

Built Distribution

docker-2.3.0-py2.py3-none-any.whl (108.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.3.0.tar.gz
Algorithm Hash digest
SHA256 b0e3f353a3df3eedfbbcaf48235117263479b893edfa0cf6d8d056cca5edde1c
MD5 03916d8cb98f567f1f33ab532d87bd72
BLAKE2b-256 e4e97281d8cc44f3fb2befb13d6d32db30c2bb4b8136e4435459849d70b1ead4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9caa025d11df761c4c8fccc3d87a06a7915846713ac4ee6d4d97db1b5a6dd56b
MD5 061c0aae1c1e1d5bf09520f7e3c3b110
BLAKE2b-256 bca0cee9d982ec14fbe78891cfcafb9e417685ad6293d68747f855543c9f9cda

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page