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

Uploaded Source

Built Distribution

docker-6.1.3-py3-none-any.whl (148.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docker-6.1.3.tar.gz
Algorithm Hash digest
SHA256 aa6d17830045ba5ef0168d5eaa34d37beeb113948c413affe1d5991fc11f9a20
MD5 c319e75054a226776f32797e56ec82da
BLAKE2b-256 f073f7c9a14e88e769f38cb7fb45aa88dfd795faa8e18aea11bababf6e068d5e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for docker-6.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aecd2277b8bf8e506e484f6ab7aec39abe0038e29fa4a6d3ba86c3fe01844ed9
MD5 64d526fc5bd5975913b64ade810fbe94
BLAKE2b-256 dbbe3032490fa33b36ddc8c4b1da3252c6f974e7133f1a50de00c6b85cca203a

See more details on using hashes here.

Supported by

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