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

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

Uploaded Source

Built Distribution

docker-4.2.2-py2.py3-none-any.whl (144.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: docker-4.2.2.tar.gz
  • Upload date:
  • Size: 202.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for docker-4.2.2.tar.gz
Algorithm Hash digest
SHA256 26eebadce7e298f55b76a88c4f8802476c5eaddbdbe38dbc6cce8781c47c9b54
MD5 9028336105468b7869a91d50e76f88f9
BLAKE2b-256 d81925ddbe30edff87274afb2b364c653c7f7bbdd515337700377f1adf0834c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docker-4.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 144.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for docker-4.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03a46400c4080cb6f7aa997f881ddd84fef855499ece219d75fbdb53289c17ab
MD5 9a5719f849d7c9a1a2c5a3c510940eab
BLAKE2b-256 3c157a2f095a3b8b0fff9a0a5f56bd941e05fa958d4ca31105541001a5f7d3eb

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