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_with_criu-0.1.dev3304.tar.gz (262.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docker_with_criu-0.1.dev3304-py3-none-any.whl (151.4 kB view details)

Uploaded Python 3

File details

Details for the file docker_with_criu-0.1.dev3304.tar.gz.

File metadata

  • Download URL: docker_with_criu-0.1.dev3304.tar.gz
  • Upload date:
  • Size: 262.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.0

File hashes

Hashes for docker_with_criu-0.1.dev3304.tar.gz
Algorithm Hash digest
SHA256 de57b8c9b5f37f63225bc4d43043c6282800e34186e45a23cb1f7f5bcefc6ba7
MD5 2860a8a5a9aaac6b97741ea60ac99e07
BLAKE2b-256 f6da068ce1d6273bbf390cffdc8fc3d548a737bd7dbf23e5a09f3879f7a2d176

See more details on using hashes here.

File details

Details for the file docker_with_criu-0.1.dev3304-py3-none-any.whl.

File metadata

File hashes

Hashes for docker_with_criu-0.1.dev3304-py3-none-any.whl
Algorithm Hash digest
SHA256 9ab08a6cc1115ea4063da7f42688b36b53c0230bcde8dd7a8d207b8c2f223580
MD5 cae652bb09674acbe76f3b56446bde62
BLAKE2b-256 f8094f0ed83534f37082ffa8ec655bf250d5dcfaa984b61d24d2dae628cb48f0

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