A Python library for the Docker Engine API
Go to file
Aarni Koskela cc76c9c20d Fix B082 (no explicit stacklevel for warnings)
Signed-off-by: Aarni Koskela <akx@iki.fi>
2023-08-15 13:36:53 +03:00
.github Switch linting from flake8 to ruff 2023-08-15 13:36:53 +03:00
docker Fix B082 (no explicit stacklevel for warnings) 2023-08-15 13:36:53 +03:00
docs Clean up unnecessary noqa comments 2023-08-15 13:36:53 +03:00
scripts use python3.6+ constructs 2021-07-05 18:30:07 -04:00
tests Fix B005 (probably an actual bug too) 2023-08-15 13:36:53 +03:00
.coveragerc Add coverage 2014-07-11 16:13:00 +02:00
.dockerignore Makes docs builds faster and ensures proper ownership 2017-04-15 15:46:52 +02:00
.editorconfig ci: add workflow for releases (#3018) 2022-07-30 12:14:27 -04:00
.gitignore ci: add workflow for releases (#3018) 2022-07-30 12:14:27 -04:00
.readthedocs.yml docs: install package in ReadTheDocs build (#3032) 2022-08-18 17:03:32 -04:00
CONTRIBUTING.md Switch linting from flake8 to ruff 2023-08-15 13:36:53 +03:00
Dockerfile ci: use latest stable syntax for Dockerfiles (#3035) 2022-08-19 15:09:12 -04:00
Dockerfile-docs ci: use latest stable syntax for Dockerfiles (#3035) 2022-08-19 15:09:12 -04:00
Jenkinsfile deps: test on Python 3.10 by default (#3010) 2022-07-27 14:44:36 -04:00
LICENSE Fix licenses 2016-09-05 17:48:09 +02:00
MAINTAINERS Update maintainers 2021-04-06 16:01:16 +02:00
MANIFEST.in Make dockerpycreds part of the SDK under docker.credentials 2019-04-30 23:37:55 -07:00
Makefile Switch linting from flake8 to ruff 2023-08-15 13:36:53 +03:00
README.md README: fix link for CI status badge 2023-08-14 14:58:34 +02:00
docs-requirements.txt docs: fix markdown rendering (#3020) 2022-07-28 16:38:57 -04:00
pyproject.toml Enable Ruff B rules and autofix 2023-08-15 13:36:53 +03:00
pytest.ini pytest: update to v4.2.1 - use xunit2 for compatibility with Jenkins 2019-08-11 02:13:30 +02:00
requirements.txt build(deps): Bump requests from 2.28.1 to 2.31.0 (#3136) 2023-08-14 15:08:38 -04:00
setup.cfg Universal wheels are for code expected to work on both Python 2 and 3 2021-10-11 23:06:12 +03:00
setup.py Enable Ruff C rules and autofix 2023-08-15 13:36:53 +03:00
test-requirements.txt Switch linting from flake8 to ruff 2023-08-15 13:36:53 +03:00
tox.ini Switch linting from flake8 to ruff 2023-08-15 13:36:53 +03:00

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.