Skip to content

A Python library for the Docker Engine API

License

Notifications You must be signed in to change notification settings

python-canux/docker-py

Repository files navigation

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:

importdockerclient=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:

>>>forlineincontainer.logs(stream=True): ... printline.strip() Reticulatingspline2... Reticulatingspline3... ...

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.

About

A Python library for the Docker Engine API

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python99.4%
  • Other0.6%