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

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.4.1.tar.gz
Algorithm Hash digest
SHA256 e33e7b08cc0549383ba2f430268b91ae59ad92d57fd075bd64a37788e3bf00a6
MD5 8ace4c521ee625d33ee4679508f25dc0
BLAKE2b-256 cb5ed943679c247d863d58cc0c291e339e2ca23bfe2e4a15801d777d7adb073f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b3227bfbb8e41c4335b007efee8ee2241ff44332c89e605dca71556ace089441
MD5 ca76608c217ef28125bf7b054f3afe04
BLAKE2b-256 8f5c997d791ecb6f37874a8c4bfae94372513c2b46ac1389080dd33a71f809bc

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