Skip to main content

A Python library for the Docker Engine API.

Project description

Docker SDK for Python

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

Older versions (< 6.0) required installing docker[tls] for SSL/TLS support. This is no longer necessary and is a no-op, but is supported for backwards compatibility.

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-6.0.1.tar.gz (257.9 kB view details)

Uploaded Source

Built Distribution

docker-6.0.1-py3-none-any.whl (147.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docker-6.0.1.tar.gz
  • Upload date:
  • Size: 257.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for docker-6.0.1.tar.gz
Algorithm Hash digest
SHA256 896c4282e5c7af5c45e8b683b0b0c33932974fe6e50fc6906a0a83616ab3da97
MD5 8e85e23ed30a3d07129e197d35e56eb4
BLAKE2b-256 79266609b51ecb418e12d1534d00b888ce7e108f38b47dc6cd589598d5c6aaa2

See more details on using hashes here.

File details

Details for the file docker-6.0.1-py3-none-any.whl.

File metadata

  • Download URL: docker-6.0.1-py3-none-any.whl
  • Upload date:
  • Size: 147.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for docker-6.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dbcb3bd2fa80dca0788ed908218bf43972772009b881ed1e20dfc29a65e49782
MD5 a75b6ecb13b0f7ea7444ceabea7fc4a6
BLAKE2b-256 d5b3a5e41798a6d4b92880998e0d9e6980e57c5d039f7f7144f87627a6b19084

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page