A Python library for the Docker Engine API
Go to file
Sebastiaan van Stijn 5064995bc4
tests/integration: update some tests for updated error-messages
I was in the process of cleaning up some error-messages, and it looks like
the docker-py tests were depending on strings that will be removed;

    =================================== FAILURES ===================================
    _____________ CreateContainerTest.test_create_with_restart_policy ______________
    tests/integration/api_container_test.py:126: in test_create_with_restart_policy
        assert 'You cannot remove ' in err
    E   AssertionError: assert 'You cannot remove ' in 'cannot remove container d11580f6078108691096ec8a23404a6bda9ad1d1b2bafe88b17d127a67728833: container is restarting: stop the container before removing or force remove'
    ____________________ ErrorsTest.test_api_error_parses_json _____________________
    tests/integration/errors_test.py:13: in test_api_error_parses_json
        assert 'You cannot remove a running container' in explanation
    E   AssertionError: assert 'You cannot remove a running container' in 'cannot remove container 4b90ce2e907dd0f99d0f561619b803e7a2a31809ced366c537874dd13f8a47ec: container is running: stop the container before removing or force remove'

This updates the tests to match on a string that will be present in both the
old and new error-messages, but added a "lower()", so that matching will be
done case-insensitive (Go errors generally should be lowercase).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-14 14:52:58 +02:00
.github ci: add support for Python 3.11 (#3064) 2022-11-15 08:10:56 -05:00
docker fix: eventlet compatibility (#3132) 2023-06-01 10:19:01 -04:00
docs fix user_guides/multiplex.rst (#3130) 2023-06-06 14:28:15 -04:00
scripts use python3.6+ constructs 2021-07-05 18:30:07 -04:00
tests tests/integration: update some tests for updated error-messages 2023-08-14 14:52:58 +02: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 Rename non-URL occurrences of docker-py to "Docker SDK for Python" 2016-12-12 13:28:49 -08: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 ci: run SSH integration tests (#3012) 2022-07-27 16:25:27 -04:00
README.md deps: upgrade & remove unnecessary dependencies (#3014) 2022-07-28 08:32:00 -04:00
docs-requirements.txt docs: fix markdown rendering (#3020) 2022-07-28 16:38:57 -04:00
pyproject.toml ci: add workflow for releases (#3018) 2022-07-30 12:14:27 -04: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 deps: upgrade websocket-client to latest (#3022) 2022-07-29 11:09:47 -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 ci: add support for Python 3.11 (#3064) 2022-11-15 08:10:56 -05:00
test-requirements.txt build(deps): Bump setuptools from 63.2.0 to 65.5.1 (#3082) 2023-01-10 17:25:12 -05:00
tox.ini ci: add support for Python 3.11 (#3064) 2022-11-15 08:10:56 -05: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.