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.4.2.tar.gz (152.6 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.4.2-py2.py3-none-any.whl (110.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.4.2.tar.gz
Algorithm Hash digest
SHA256 216ffa6daaecf55895f2207ebff84e48e554fe95826de6d95fa60081e8347486
MD5 df46a59fbc383dc99fb031ec823d5638
BLAKE2b-256 a27e8d02472884a78dcb2ae0c5f5fe7783801670d8835402820bb9f156c0acc0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0b7371986c79ccbcba5f1c0117f2245ccf6805a02c87b57ba9bae5754a48d700
MD5 406a8d5997e57e789eb661b3889a9ce5
BLAKE2b-256 04ea894fc514543c267f5e09707df1daf10e743adc4976f8715f2b1f44b074ae

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