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

If you are intending to connect to a docker host via TLS, add docker[tls] to your requirements instead, or install with pip:

pip install docker[tls]

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:latest", "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.6.0.tar.gz (162.7 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.6.0-py2.py3-none-any.whl (118.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-2.6.0.tar.gz
Algorithm Hash digest
SHA256 1af9eea09f26a919597a40f674a926f3cfee0893ade4a5e7117ee7f3148c1c83
MD5 00a9e37d2101d8b231da959041ce6acd
BLAKE2b-256 a74661992cbb40996e4395f1ecaee98e229bb6f4afa4d1f35eacd37937841021

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docker-2.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7bef11b83260a11944fe8123f9a1f0b5a731b28e8d0e698d215259e7621a1a91
MD5 14b5b8b46d5f717e39f95bce2b65cd75
BLAKE2b-256 fb9821b77f629767a7851e17d1770c25dcde53c73f6a912a017b7a5f43b1e845

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