Docker

ℹ️ Upgrade Notes (6.1.x)
- Errors are no longer returned during client initialization if the credential helper cannot be found. A warning will be emitted instead, and an error is returned if the credential helper is used.

🐛 Bugfixes
- Fix `containers.stats()` hanging with `stream=True`
- Correct return type in docs for `containers.diff()` method

What's Changed
* api: update return type of `diff` method by john-b-yang in https://github.com/docker/docker-py/pull/3115
* Fix container.stats infinite blocking on stream mode by RazCrimson in https://github.com/docker/docker-py/pull/3120

New Contributors
* john-b-yang made their first contribution in https://github.com/docker/docker-py/pull/3115
* RazCrimson made their first contribution in https://github.com/docker/docker-py/pull/3120

**Full Changelog**: https://github.com/docker/docker-py/compare/6.1.0...6.1.1

ℹ️ Upgrade Notes
- Errors are no longer returned during client initialization if the credential helper cannot be found. A warning will be emitted instead, and an error is returned if the credential helper is used.

✨ Features
- Python 3.11 support
- Use `poll()` instead of `select()` on non-Windows platforms
- New API fields
- `network_driver_opt` on container run / create
- `one-shot` on container stats
- `status` on services list

🐛 Bugfixes
- Support for requests 2.29.0+ and urllib3 2.x
- Do not strip characters from volume names
- Fix connection leak on `container.exec_*` operations
- Fix errors closing named pipes on Windows

What's Changed
* Add support for Python 3.11 by hugovk in https://github.com/docker/docker-py/pull/3064
* Avoid stripping characters in volume names by loicleyendecker in https://github.com/docker/docker-py/pull/3073
* docs: fix wrong command syntax in code annotation by serieznyi in https://github.com/docker/docker-py/pull/3081
* build(deps): Bump setuptools from 63.2.0 to 65.5.1 by dependabot in https://github.com/docker/docker-py/pull/3082
* fix(store): warn on init instead of throw by nomagick in https://github.com/docker/docker-py/pull/3080
* exec: fix file handle leak with container.exec_* APIs by Lekensteyn in https://github.com/docker/docker-py/pull/2320
* Add `network_driver_opt` to client.containers run and create by Skazza94 in https://github.com/docker/docker-py/pull/3083
* Add `one-shot` to container API `stats` by aroxby-wayscript in https://github.com/docker/docker-py/pull/3089
* Add `status` parameter to services list API by lorinbucher in https://github.com/docker/docker-py/pull/3093
* socket: fix for errors on pipe close in Windows by milas in https://github.com/docker/docker-py/pull/3099
* put_archive: note the data may also be a stream by akx in https://github.com/docker/docker-py/pull/2478
* Use poll() instead of select(), unless Windows. by I-question-this in https://github.com/docker/docker-py/pull/2865
* Make compatible with requests 2.29.0 and urllib3 2.0 by felixfontein in https://github.com/docker/docker-py/pull/3116

New Contributors
* loicleyendecker made their first contribution in https://github.com/docker/docker-py/pull/3073
* serieznyi made their first contribution in https://github.com/docker/docker-py/pull/3081
* nomagick made their first contribution in https://github.com/docker/docker-py/pull/3080
* Lekensteyn made their first contribution in https://github.com/docker/docker-py/pull/2320
* aroxby-wayscript made their first contribution in https://github.com/docker/docker-py/pull/3089
* lorinbucher made their first contribution in https://github.com/docker/docker-py/pull/3093
* akx made their first contribution in https://github.com/docker/docker-py/pull/2478
* I-question-this made their first contribution in https://github.com/docker/docker-py/pull/2865

**Full Changelog**: https://github.com/docker/docker-py/compare/6.0.1...6.1.0

⚠️ Notice
This version is not compatible with `requests` 2.29+ or `urllib3` 2.x.
Either add `requests < 2.29` and `urllib3 < 2` to your requirements or upgrade to to the [latest `docker-py` release](https://github.com/docker/docker-py/releases/latest).

🐛 Bugfixes
* Fix for `The pipe has been ended` errors on Windows (3056)
* Support floats for timestamps in Docker logs (`since` / `until`) (3031)

What's Changed
* docs: install package in ReadTheDocs build by milas in https://github.com/docker/docker-py/pull/3032
* Use latest stable syntax for Dockerfiles by thaJeztah in https://github.com/docker/docker-py/pull/3035
* feat: add support for floats to docker logs params since / until sinc… by ArchiMoebius in https://github.com/docker/docker-py/pull/3031
* Change prune test to use anonymous volumes by cpuguy83 in https://github.com/docker/docker-py/pull/3051
* socket: handle npipe close by nicks in https://github.com/docker/docker-py/pull/3056

New Contributors
* ArchiMoebius made their first contribution in https://github.com/docker/docker-py/pull/3031
* nicks made their first contribution in https://github.com/docker/docker-py/pull/3056

**Full Changelog**: https://github.com/docker/docker-py/compare/6.0.0...6.0.1

ℹ️ Upgrade Notes
- Minimum supported Python version is 3.7+
- When installing with pip, the `docker[tls]` extra is deprecated and a no-op,
use `docker` for same functionality (TLS support is always available now)
- Native Python SSH client (used by default / `use_ssh_client=False`) will now
reject unknown host keys with `paramiko.ssh_exception.SSHException`
- Short IDs are now 12 characters instead of 10 characters (same as Docker CLI)
- Version metadata is now exposed as `__version__`

✨ Features
- Python 3.10 support
- Automatically negotiate most secure TLS version
- Add `platform` (e.g. `linux/amd64`, `darwin/arm64`) to container create & run
- Add support for `GlobalJob` and `ReplicatedJobs` for Swarm
- Add `remove()` method on `Image`
- Add `force` param to `disable()` on `Plugin`

🐛 Bugfixes
- Fix install issues on Windows related to `pywin32`
- Do not accept unknown SSH host keys in native Python SSH mode
- Use 12 character short IDs for consistency with Docker CLI
- Ignore trailing whitespace in `.dockerignore` files
- Fix IPv6 host parsing when explicit port specified
- Fix `ProxyCommand` option for SSH connections
- Do not spawn extra subshell when launching external SSH client
- Improve exception semantics to preserve context
- Documentation improvements (formatting, examples, typos, missing params)

🔧 Miscellaneous
- Upgrade dependencies in `requirements.txt` to latest versions
- Remove extraneous transitive dependencies
- Eliminate usages of deprecated functions/methods
- Test suite reliability improvements
- GitHub Actions workflows for linting, unit tests, integration tests, and
publishing releases

Changelog
* Update changelog for 5.0.3 by aiordache in https://github.com/docker/docker-py/pull/2897
* Add support for Python 3.10 by hugovk in https://github.com/docker/docker-py/pull/2898
* Bump paramiko from 2.8.0 to 2.10.1 by dependabot in https://github.com/docker/docker-py/pull/2974
* deps: upgrade pywin32 & relax version constraint by milas in https://github.com/docker/docker-py/pull/3004
* ci: remove Python 3.6 and add 3.11 pre-releases by milas in https://github.com/docker/docker-py/pull/3005
* utils: fix IPv6 address w/ port parsing by milas in https://github.com/docker/docker-py/pull/3006
* test_create_with_device_cgroup_rules: don't check devices.list by thaJeztah in https://github.com/docker/docker-py/pull/2940
* Fix exception semantics in _raise_for_status by kmaork in https://github.com/docker/docker-py/pull/2954
* tls: use auto-negotiated highest version by milas in https://github.com/docker/docker-py/pull/3007
* sshcon: remove use of self.ssh_conf by glicht in https://github.com/docker/docker-py/pull/2993
* Use `packaging` instead of `distutils` for `Version` by FrancescoCasalegno in https://github.com/docker/docker-py/pull/2931
* test: fix a couple flaky/broken tests by milas in https://github.com/docker/docker-py/pull/3008
* ci: add flake8 job by milas in https://github.com/docker/docker-py/pull/3009
* Fixes and improvements by kinday in https://github.com/docker/docker-py/pull/2947
* deps: test on Python 3.10 by default by milas in https://github.com/docker/docker-py/pull/3010
* deps: remove backports.ssl_match_hostname by milas in https://github.com/docker/docker-py/pull/3011
* Fix: fix CVE-2020-28243 by errorcode7 in https://github.com/docker/docker-py/pull/2910
* Fix for CWE-295: Improper Certificate Validation by avnes in https://github.com/docker/docker-py/pull/2932
* Set daemon attribute instead of using setDaemon method that was deprecated in Python 3.10 by tirkarthi in https://github.com/docker/docker-py/pull/2823
* Remove unnecessary pass statements by vilhelmprytz in https://github.com/docker/docker-py/pull/2541
* ci: run SSH integration tests by milas in https://github.com/docker/docker-py/pull/3012
* docs: fix simple typo, containe -> container by timgates42 in https://github.com/docker/docker-py/pull/3015
* ci: bump version to 6.0.0-dev by milas in https://github.com/docker/docker-py/pull/3013
* deps: upgrade & remove unnecessary dependencies by milas in https://github.com/docker/docker-py/pull/3014
* lint: fix line length violation by milas in https://github.com/docker/docker-py/pull/3017
* docs: fix markdown rendering by milas in https://github.com/docker/docker-py/pull/3020
* Return 12 character short_ids by benfasoli in https://github.com/docker/docker-py/pull/2862
* api: preserve cause when re-raising error by milas in https://github.com/docker/docker-py/pull/3023
* deps: upgrade websocket-client to latest by milas in https://github.com/docker/docker-py/pull/3022
* Add platform parameter for create_container() by felixfontein in https://github.com/docker/docker-py/pull/2927
* Support cgroupns option in containers.run/containers.create by david0 in https://github.com/docker/docker-py/pull/2930
* Prevent pip cache in Docker image to save image size by PeterDaveHello in https://github.com/docker/docker-py/pull/2828
* Update: allow "force" parameter in plugin.disable() by till in https://github.com/docker/docker-py/pull/2843
* Fix: Issue 2832 Allowing Rollback Config Arg for Services by ercildoune in https://github.com/docker/docker-py/pull/2917
* model: add remove() to Image by milas in https://github.com/docker/docker-py/pull/3026
* fix(dockerignore): trim trailing whitespace by kalioz in https://github.com/docker/docker-py/pull/2733
* Fix TLS server check example to actually verify by scop in https://github.com/docker/docker-py/pull/2574
* Clarify TLSConfig verify parameter docs by scop in https://github.com/docker/docker-py/pull/2573
* Add healthcheck doc for container.run by JanoschDeurer in https://github.com/docker/docker-py/pull/2595
* Fix image save example by hristog in https://github.com/docker/docker-py/pull/2570
* Changed a few words to be more clear by InnovativeInventor in https://github.com/docker/docker-py/pull/2489
* docs: fix RollbackConfig/Order values by milas in https://github.com/docker/docker-py/pull/3027
* ci: add workflow for releases by milas in https://github.com/docker/docker-py/pull/3018
* remove duplicate 'on' in comment by thomasgassmann in https://github.com/docker/docker-py/pull/2370
* Add `gzip` documentation to `BuildApiMixin` by SauravMaheshkar in https://github.com/docker/docker-py/pull/2929
* Use `preexec_func` always by q0w in https://github.com/docker/docker-py/pull/2920
* Remove docker.credentials.utils.find_executable by n1ngu in https://github.com/docker/docker-py/pull/3028
* Support `global-job` and `replicated-job` modes in Docker Swarm by kinday in https://github.com/docker/docker-py/pull/3016
* docs: add changelog for 6.0.0 by milas in https://github.com/docker/docker-py/pull/3019
* Add sysctl support for docker swarm services by Aadenei in https://github.com/docker/docker-py/pull/3029
* Connect with mac address by YuviGold in https://github.com/docker/docker-py/pull/2481
* docs/css: remove hyphens in literals by jrabbit in https://github.com/docker/docker-py/pull/2452
* Add swarm support for DataPathPort by dexteradeus in https://github.com/docker/docker-py/pull/2987
* test: add additional tests for cgroupns option by milas in https://github.com/docker/docker-py/pull/3024

New Contributors
* hugovk made their first contribution in https://github.com/docker/docker-py/pull/2898
* milas made their first contribution in https://github.com/docker/docker-py/pull/3004
* kmaork made their first contribution in https://github.com/docker/docker-py/pull/2954
* glicht made their first contribution in https://github.com/docker/docker-py/pull/2993
* FrancescoCasalegno made their first contribution in https://github.com/docker/docker-py/pull/2931
* kinday made their first contribution in https://github.com/docker/docker-py/pull/2947
* errorcode7 made their first contribution in https://github.com/docker/docker-py/pull/2910
* avnes made their first contribution in https://github.com/docker/docker-py/pull/2932
* tirkarthi made their first contribution in https://github.com/docker/docker-py/pull/2823
* vilhelmprytz made their first contribution in https://github.com/docker/docker-py/pull/2541
* timgates42 made their first contribution in https://github.com/docker/docker-py/pull/3015
* benfasoli made their first contribution in https://github.com/docker/docker-py/pull/2862
* felixfontein made their first contribution in https://github.com/docker/docker-py/pull/2927
* david0 made their first contribution in https://github.com/docker/docker-py/pull/2930
* PeterDaveHello made their first contribution in https://github.com/docker/docker-py/pull/2828
* till made their first contribution in https://github.com/docker/docker-py/pull/2843
* ercildoune made their first contribution in https://github.com/docker/docker-py/pull/2917
* kalioz made their first contribution in https://github.com/docker/docker-py/pull/2733
* JanoschDeurer made their first contribution in https://github.com/docker/docker-py/pull/2595
* hristog made their first contribution in https://github.com/docker/docker-py/pull/2570
* InnovativeInventor made their first contribution in https://github.com/docker/docker-py/pull/2489
* thomasgassmann made their first contribution in https://github.com/docker/docker-py/pull/2370
* SauravMaheshkar made their first contribution in https://github.com/docker/docker-py/pull/2929
* q0w made their first contribution in https://github.com/docker/docker-py/pull/2920
* n1ngu made their first contribution in https://github.com/docker/docker-py/pull/3028
* Aadenei made their first contribution in https://github.com/docker/docker-py/pull/3029
* jrabbit made their first contribution in https://github.com/docker/docker-py/pull/2452
* dexteradeus made their first contribution in https://github.com/docker/docker-py/pull/2987

**Full Changelog**: https://github.com/docker/docker-py/compare/5.0.3...6.0.0

What's Changed
* remove duplicate 'on' in comment by thomasgassmann in https://github.com/docker/docker-py/pull/2370
* Add `gzip` documentation to `BuildApiMixin` by SauravMaheshkar in https://github.com/docker/docker-py/pull/2929
* Use `preexec_func` always by q0w in https://github.com/docker/docker-py/pull/2920
* Remove docker.credentials.utils.find_executable by n1ngu in https://github.com/docker/docker-py/pull/3028
* Support `global-job` and `replicated-job` modes in Docker Swarm by kinday in https://github.com/docker/docker-py/pull/3016
* docs: add changelog for 6.0.0 by milas in https://github.com/docker/docker-py/pull/3019

New Contributors
* thomasgassmann made their first contribution in https://github.com/docker/docker-py/pull/2370
* SauravMaheshkar made their first contribution in https://github.com/docker/docker-py/pull/2929
* q0w made their first contribution in https://github.com/docker/docker-py/pull/2920
* n1ngu made their first contribution in https://github.com/docker/docker-py/pull/3028

**Full Changelog**: https://github.com/docker/docker-py/compare/6.0.0b1...6.0.0b2

What's Changed
* Update changelog for 5.0.3 by aiordache in https://github.com/docker/docker-py/pull/2897
* Add support for Python 3.10 by hugovk in https://github.com/docker/docker-py/pull/2898
* Bump paramiko from 2.8.0 to 2.10.1 by dependabot in https://github.com/docker/docker-py/pull/2974
* deps: upgrade pywin32 & relax version constraint by milas in https://github.com/docker/docker-py/pull/3004
* ci: remove Python 3.6 and add 3.11 pre-releases by milas in https://github.com/docker/docker-py/pull/3005
* utils: fix IPv6 address w/ port parsing by milas in https://github.com/docker/docker-py/pull/3006
* test_create_with_device_cgroup_rules: don't check devices.list by thaJeztah in https://github.com/docker/docker-py/pull/2940
* Fix exception semantics in _raise_for_status by kmaork in https://github.com/docker/docker-py/pull/2954
* tls: use auto-negotiated highest version by milas in https://github.com/docker/docker-py/pull/3007
* sshcon: remove use of self.ssh_conf by glicht in https://github.com/docker/docker-py/pull/2993
* Use `packaging` instead of `distutils` for `Version` by FrancescoCasalegno in https://github.com/docker/docker-py/pull/2931
* test: fix a couple flaky/broken tests by milas in https://github.com/docker/docker-py/pull/3008
* ci: add flake8 job by milas in https://github.com/docker/docker-py/pull/3009
* Fixes and improvements by kinday in https://github.com/docker/docker-py/pull/2947
* deps: test on Python 3.10 by default by milas in https://github.com/docker/docker-py/pull/3010
* deps: remove backports.ssl_match_hostname by milas in https://github.com/docker/docker-py/pull/3011
* Fix: fix CVE-2020-28243 by errorcode7 in https://github.com/docker/docker-py/pull/2910
* Fix for CWE-295: Improper Certificate Validation by avnes in https://github.com/docker/docker-py/pull/2932
* Set daemon attribute instead of using setDaemon method that was deprecated in Python 3.10 by tirkarthi in https://github.com/docker/docker-py/pull/2823
* Remove unnecessary pass statements by vilhelmprytz in https://github.com/docker/docker-py/pull/2541
* ci: run SSH integration tests by milas in https://github.com/docker/docker-py/pull/3012
* docs: fix simple typo, containe -> container by timgates42 in https://github.com/docker/docker-py/pull/3015
* ci: bump version to 6.0.0-dev by milas in https://github.com/docker/docker-py/pull/3013
* deps: upgrade & remove unnecessary dependencies by milas in https://github.com/docker/docker-py/pull/3014
* lint: fix line length violation by milas in https://github.com/docker/docker-py/pull/3017
* docs: fix markdown rendering by milas in https://github.com/docker/docker-py/pull/3020
* Return 12 character short_ids by benfasoli in https://github.com/docker/docker-py/pull/2862
* api: preserve cause when re-raising error by milas in https://github.com/docker/docker-py/pull/3023
* deps: upgrade websocket-client to latest by milas in https://github.com/docker/docker-py/pull/3022
* Add platform parameter for create_container() by felixfontein in https://github.com/docker/docker-py/pull/2927
* Support cgroupns option in containers.run/containers.create by david0 in https://github.com/docker/docker-py/pull/2930
* Prevent pip cache in Docker image to save image size by PeterDaveHello in https://github.com/docker/docker-py/pull/2828
* Update: allow "force" parameter in plugin.disable() by till in https://github.com/docker/docker-py/pull/2843
* Fix: Issue 2832 Allowing Rollback Config Arg for Services by ercildoune in https://github.com/docker/docker-py/pull/2917
* model: add remove() to Image by milas in https://github.com/docker/docker-py/pull/3026
* fix(dockerignore): trim trailing whitespace by kalioz in https://github.com/docker/docker-py/pull/2733
* Fix TLS server check example to actually verify by scop in https://github.com/docker/docker-py/pull/2574
* Clarify TLSConfig verify parameter docs by scop in https://github.com/docker/docker-py/pull/2573
* Add healthcheck doc for container.run by JanoschDeurer in https://github.com/docker/docker-py/pull/2595
* Fix image save example by hristog in https://github.com/docker/docker-py/pull/2570
* Changed a few words to be more clear by InnovativeInventor in https://github.com/docker/docker-py/pull/2489
* docs: fix RollbackConfig/Order values by milas in https://github.com/docker/docker-py/pull/3027
* ci: add workflow for releases by milas in https://github.com/docker/docker-py/pull/3018

New Contributors
* hugovk made their first contribution in https://github.com/docker/docker-py/pull/2898
* milas made their first contribution in https://github.com/docker/docker-py/pull/3004
* kmaork made their first contribution in https://github.com/docker/docker-py/pull/2954
* glicht made their first contribution in https://github.com/docker/docker-py/pull/2993
* FrancescoCasalegno made their first contribution in https://github.com/docker/docker-py/pull/2931
* kinday made their first contribution in https://github.com/docker/docker-py/pull/2947
* errorcode7 made their first contribution in https://github.com/docker/docker-py/pull/2910
* avnes made their first contribution in https://github.com/docker/docker-py/pull/2932
* tirkarthi made their first contribution in https://github.com/docker/docker-py/pull/2823
* vilhelmprytz made their first contribution in https://github.com/docker/docker-py/pull/2541
* timgates42 made their first contribution in https://github.com/docker/docker-py/pull/3015
* benfasoli made their first contribution in https://github.com/docker/docker-py/pull/2862
* felixfontein made their first contribution in https://github.com/docker/docker-py/pull/2927
* david0 made their first contribution in https://github.com/docker/docker-py/pull/2930
* PeterDaveHello made their first contribution in https://github.com/docker/docker-py/pull/2828
* till made their first contribution in https://github.com/docker/docker-py/pull/2843
* ercildoune made their first contribution in https://github.com/docker/docker-py/pull/2917
* kalioz made their first contribution in https://github.com/docker/docker-py/pull/2733
* JanoschDeurer made their first contribution in https://github.com/docker/docker-py/pull/2595
* hristog made their first contribution in https://github.com/docker/docker-py/pull/2570
* InnovativeInventor made their first contribution in https://github.com/docker/docker-py/pull/2489

**Full Changelog**: https://github.com/docker/docker-py/compare/5.0.3...6.0.0b1