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.2.1.tar.gz (147.9 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.2.1-py2.py3-none-any.whl (107.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.2.1.tar.gz
Algorithm Hash digest
SHA256 a67de803a8b3a9ef5adb9ce881feb74ec33d373a4f6d6cbb1a26cad03e809ae2
MD5 cda77100e935cb8e49564f16b1ab3fcc
BLAKE2b-256 d572ccccbe05d976a7815ff7ac9e3c84c568e2a0d90eb97b3ff6a2ef861a041b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ef534ee4d79791539afb975e4634e3361c868e733a2b9c1f041605a9a1bbf9f5
MD5 745a3107e023c80f76921b60adf9f096
BLAKE2b-256 d9afa02ebab0c9791f66addb7e460dc3085240c4ec2c8f33c146fddc18156968

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