7.0.0b3
feat: accept all / filters / keep_storage in prune_builds (#3192)

Added in API v1.39.

---------

Signed-off-by: Emran Batmanghelich <emran.bm@gmail.com>
1 file changed
tree: 9a69fc2c066939d3002dfd78a3b11b30c079e306
  1. .github/
  2. docker/
  3. docs/
  4. scripts/
  5. tests/
  6. .coveragerc
  7. .dockerignore
  8. .editorconfig
  9. .gitignore
  10. .readthedocs.yml
  11. CONTRIBUTING.md
  12. Dockerfile
  13. Dockerfile-docs
  14. docs-requirements.txt
  15. LICENSE
  16. MAINTAINERS
  17. Makefile
  18. MANIFEST.in
  19. pyproject.toml
  20. pytest.ini
  21. README.md
  22. requirements.txt
  23. setup.cfg
  24. setup.py
  25. test-requirements.txt
  26. tox.ini
README.md

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.