Upgrade Notes ⚠️

• Removed SSL version (ssl_version) and explicit hostname check (assert_hostname) options (#3185)
  • assert_hostname has not been used since Python 3.6 and was removed in 3.12
  • Python 3.7+ supports TLSv1.3 by default
• Websocket support is no longer included by default (#3123)
  • Use pip install docker[websockets] to include websocket-client dependency
  • By default, docker-py hijacks the TCP connection and does not use Websockets
  • Websocket client is only required to use attach_socket(container, ws=True)
• Python 3.7 no longer supported (reached end-of-life June 2023) (#3187)

Features ✨

• Python 3.12 support (#3185)
• Full networking_config support for containers.create() (#3121)
  • Replaces network_driver_opt (added in 6.1.0)
• Add health() property to container that returns status (e.g. unhealthy) (#3147)
• Add pause option to container.commit() (#3159)
• Add support for bind mount propagation (e.g. rshared, private) (#3164)

Bugfixes 🐛

• Consistently return docker.errors.NotFound on 404 responses (#3156)

Miscellaneous 🔧

• Upgraded urllib3 version in requirements.txt (used for development/tests) (#3183)
• Documentation typo fixes & formatting improvements (#3130)
• Fixed integration test compatibility for newer Moby engine versions (#3165, #3166, #3145, #3169, #3170)
• Switch to ruff for linting (#3126)

Full Changelog

• fix user_guides/multiplex.rst by @Longin-Yu in https://github.com/docker/docker-py/pull/3130
• tests/integration: fix flake8 failures (E721 do not compare types), and fix Dockerfile for debian "bookworm" by @thaJeztah in https://github.com/docker/docker-py/pull/3166
• tests/integration: update some tests for updated error-messages by @thaJeztah in https://github.com/docker/docker-py/pull/3165
• README: fix link for CI status badge by @thaJeztah in https://github.com/docker/docker-py/pull/3167
• fix: use response.text to get string rather than bytes by @mndeveci in https://github.com/docker/docker-py/pull/3156
• feat: add pause option to commit api by @VincentLeeMax in https://github.com/docker/docker-py/pull/3159
• build(deps): Bump requests from 2.28.1 to 2.31.0 by @dependabot in https://github.com/docker/docker-py/pull/3136
• test: remove APT_MIRROR from Dockerfile by @thaJeztah in https://github.com/docker/docker-py/pull/3145
• Switch linting to ruff, use f-strings, fix lint errors and possible bugs by @akx in https://github.com/docker/docker-py/pull/3126
• integration: Fix bad subnet declaration by @akerouanton in https://github.com/docker/docker-py/pull/3169
• integration: Remove test_create_check_duplicate by @akerouanton in https://github.com/docker/docker-py/pull/3170
• Support all Network.connect parameters in client.containers.run and client.containers.create by @Skazza94 in https://github.com/docker/docker-py/pull/3121
• feat: move websocket-client to extra dependency by @akx in https://github.com/docker/docker-py/pull/3123
• Add health property to Containers model by @TurnrDev in https://github.com/docker/docker-py/pull/3147
• build(deps): Bump urllib3 from 1.26.11 to 1.26.18 by @dependabot in https://github.com/docker/docker-py/pull/3183
• breaking: Python 3.12 compatibility & remove custom SSL adapter by @milas in https://github.com/docker/docker-py/pull/3185
• chore: add changelog for 7.0.0 by @milas in https://github.com/docker/docker-py/pull/3186
• chore: remove support for Python 3.7 by @milas in https://github.com/docker/docker-py/pull/3187
• chore: update MAINTAINERS and remove CODEOWNERS by @milas in https://github.com/docker/docker-py/pull/3188

New Contributors

• @Longin-Yu made their first contribution in https://github.com/docker/docker-py/pull/3130
• @mndeveci made their first contribution in https://github.com/docker/docker-py/pull/3156
• @VincentLeeMax made their first contribution in https://github.com/docker/docker-py/pull/3159
• @akerouanton made their first contribution in https://github.com/docker/docker-py/pull/3169
• @TurnrDev made their first contribution in https://github.com/docker/docker-py/pull/3147

Full Changelog: https://github.com/docker/docker-py/compare/6.1.3...7.0.0b1

List of PRs / issues for this release

Features

• Add cap_add and cap_drop parameters to service create and ContainerSpec
• Add templating parameter to config create

Bugfixes

• Fix getting a read timeout for logs/attach with a tty and slow output

Miscellaneous

• Fix documentation examples

List of PRs / issues for this release

Bugfixes

• Fix disable_buffering regression

List of PRs / issues for this release

Bugfixes

• Bring back support for ssh identity file
• Cleanup remaining python-2 dependencies
• Fix image save example in docs

Miscellaneous

• Bump urllib3 to 1.26.5
• Bump requests to 2.26.0

List of PRs / issues for this release

Breaking changes

• Remove support for Python 2.7
• Make Python 3.6 the minimum version supported

Features

• Add limit parameter to image search endpoint

Bugfixes

• Fix KeyError exception on secret create
• Verify TLS keys loaded from docker contexts
• Update PORT_SPEC regex to allow square brackets for IPv6 addresses
• Fix containers and images documentation examples

Warning

This is the last release with support for Python 2.7 and 3.5

List of PRs / issues for this release

Bugfixes

• Remove LD_LIBRARY_PATH and SSL_CERT_FILE environment variables when shelling out to the ssh client

List of PRs / issues for this release

Features

• Add support for docker.types.Placement.MaxReplicas

Bugfixes

• Fix SSH port parsing when shelling out to the ssh client

List of PRs / issues for this release

Bugfixes

• Fix SSH connection bug where the hostname was incorrectly trimmed and the error was hidden
• Fix docs example

Miscellaneous

• Add Python3.8 and 3.9 in setup.py classifier list

List of PRs / issues for this release

Bugfixes

• Avoid setting unsupported parameter for subprocess.Popen on Windows

List of PRs / issues for this release

Features

• Add an alternative SSH connection to the paramiko one, based on shelling out to the SSh client. Similar to the behaviour of Docker cli
• Default image tag to latest on pull

Bugfixes

• Fix plugin model upgrade
• Fix examples URL in ulimits

Miscellaneous

• Improve exception messages for server and client errors
• Bump cryptography from 2.3 to 3.2

List of PRs / issues for this release

Miscellaneous

• Set default API version to auto
• Fix conversion to bytes for float
• Support OpenSSH identityfile option

Changelog

Features

• Add DeviceRequest type to expose host resources such as GPUs
• Add support for DriverOpts in EndpointConfig
• Disable compression by default when using container.get_archive method

Miscellaneous

• Update default API version to v1.39
• Update test engine version to 19.03.12

4.2.2

List of PRs / issues for this release

Bugfixes

• Fix context load for non-docker endpoints

List of PRs / issues for this release

Features

• Add option on when to use tls on Context constructor
• Make context orchestrator field optional

List of PRs / issues for this release

Bugfixes

• Fix win32pipe.WaitNamedPipe throw exception in Windows containers
• Use Hostname, Username, Port and ProxyCommand settings from .ssh/config when on SSH
• Set host key policy for ssh transport to paramiko.WarningPolicy()
• Set logging level of paramiko to warn

Features

• Add support for docker contexts through docker.ContextAPI

List of PRs / issues for this release

Bugfixes

• Correct INDEX_URL logic in build.py _set_auth_headers
• Fix for empty auth keys in config.json

Features

• Add NetworkAttachmentConfig for service create/update

Miscellaneous

• Bump pytest to 4.3.1
• Adjust --platform tests for changes in docker engine
• Update credentials-helpers to v0.6.3

List of PRs / issues for this release

Bugfixes

• Unified the way HealthCheck is created/configured

Miscellaneous

• Bumped version of websocket-client

List of PRs / issues for this release

Bugfixes

• Fixed an obsolete import in the credentials subpackage that caused import errors in
  Python 3.7

Miscellaneous

• Docs building has been repaired

List of PRs / issues for this release

Breaking changes

• Support for Python 3.3 and Python 3.4 has been dropped
• APIClient.update_service, APIClient.init_swarm, and
  DockerClient.swarm.init now return a dict from the API's response body
• In APIClient.build and DockerClient.images.build, the use_config_proxy
  parameter now defaults to True
• init_path is no longer a valid parameter for HostConfig

Features

• It is now possible to provide SCTP ports for port mappings
• ContainerSpecs now support the init parameter
• DockerClient.swarm.init and APIClient.init_swarm now support the
  data_path_addr parameter
• APIClient.update_swarm and DockerClient.swarm.update now support the
  rotate_manager_unlock_key parameter
• APIClient.update_service returns the API's response body as a dict
• APIClient.init_swarm, and DockerClient.swarm.init now return the API's
  response body as a dict

Bugfixes

• Fixed PlacementPreference instances to produce a valid API type
• Fixed a bug where not setting a value for buildargs in build could cause
  the library to attempt accessing attributes of a None value
• Fixed a bug where setting the volume_driver parameter in
  DockerClient.containers.create would result in an error
• APIClient.inspect_distribution now correctly sets the authentication
  headers on the request, allowing it to be used with private repositories
  This change also applies to DockerClient.get_registry_data

List of PRs / issues for this release

Bugfixes

• Fix base_url to keep TCP protocol on utils.py by letting the responsability of changing the
  protocol to parse_host afterwards, letting base_url with the original value.
• XFAIL test_attach_stream_and_cancel on TLS