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.0.tar.gz (152.4 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.0-py2.py3-none-any.whl (109.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.4.0.tar.gz
Algorithm Hash digest
SHA256 931eb9538e285f5eac984764b1f931cdb587e4602b9a160b8d1a11ad835591b9
MD5 3e348073b58e192167b651ae83f9f236
BLAKE2b-256 10b8d6a12321faaffd340535de58ebeac676d8f3fda46929e61fcfb43d9f7322

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1512a30aef31c732f34985adebf1a502fd97d4a861f18bd08ab00474825ebbff
MD5 9aae9dc42a95837f9aa887770cfd34c5
BLAKE2b-256 fbfe27d6266242a010dd6f864a1fda0c906e31101e102d709a1ac66e3a485fe3

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