Docker

-----

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/27?closed=1)

Features

* Added the following pruning methods:
* In `APIClient`: `prune_containers`, `prune_images`, `prune_networks`,
`prune_volumes`
* In `DockerClient`: `containers.prune`, `images.prune`, `networks.prune`,
`volumes.prune`
* Added support for the plugins API:
* In `APIClient`: `configure_plugin`, `create_plugin`, `disable_plugin`,
`enable_plugin`, `inspect_plugin`, `pull_plugin`, `plugins`,
`plugin_privileges`, `push_plugin`, `remove_plugin`
* In `DockerClient`: `plugins.create`, `plugins.get`, `plugins.install`,
`plugins.list`, and the `Plugin` model.
* Added support for the secrets API:
* In `APIClient`: `create_secret`, `inspect_secret`, `remove_secret`,
`secrets`
* In `DockerClient`: `secret.create`, `secret.get`, `secret.list` and
the `Secret` model.
* Added `secrets` parameter to `ContainerSpec`. Each item in the `secrets`
list must be a `docker.types.SecretReference` instance.
* Added support for `cache_from` in `APIClient.build` and
`DockerClient.images.build`.
* Added support for `auto_remove` and `storage_opt` in
`APIClient.create_host_config` and `DockerClient.containers.run`
* Added support for `stop_timeout` in `APIClient.create_container` and
`DockerClient.containers.run`
* Added support for the `force` parameter in `APIClient.remove_volume` and
`Volume.remove`
* Added support for `max_failure_ratio` and `monitor` in `UpdateConfig`
* Added support for `force_update` in `TaskTemplate`
* Made `name` parameter optional in `APIClient.create_volume` and
`DockerClient.volumes.create`

Bugfixes

* Fixed a bug where building from a directory containing socket-type files
would raise an unexpected `AttributeError`.
* Fixed an issue that was preventing the `DockerClient.swarm.init` method to
take into account arguments passed to it.
* `Image.tag` now correctly returns a boolean value upon completion.
* Fixed several issues related to passing `volumes` in
`DockerClient.containers.run`
* Fixed an issue where `DockerClient.image.build` wouldn't return an `Image`
object even when the build was successful

-----

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/29?closed=1)

Bugfixes

* Installation of the package now fails if the `docker-py` package is
installed in order to prevent obscure naming conflicts when both
packages co-exist.
* Added missing `filters` parameter to `APIClient.networks`.
* Resource objects generated by the `DockerClient` are now hashable.
* Fixed a bug where retrieving untagged images using `DockerClient`
would raise a `TypeError` exception.
* `mode` parameter in `create_service` is now properly converted to
a valid data type for the Engine API. Use `ServiceMode` for advanced
configurations.
* Fixed a bug where the decoded `APIClient.events` stream would sometimes raise
an exception when a container is stopped or restarted.

-----

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/28?closed=1)

Bugfixes

* Fixed a bug where forward slashes in some .dockerignore patterns weren't
being parsed correctly on Windows
* Fixed a bug where `Mount.parse_mount_string` would never set the read_only
parameter on the resulting `Mount`.
* Fixed a bug where `Mount.parse_mount_string` would incorrectly mark host
binds as being of `volume` type.

-----

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/22?closed=1)

Breaking changes

* Dropped support for Python 2.6
* `docker.Client` has been renamed to `docker.APIClient`
* `docker.from_env` now creates a `DockerClient` instance instead of an
`APIClient` instance.
* Removed HostConfig parameters from `APIClient.start`
* The minimum supported API version is now 1.21 (Engine version 1.9.0+)
* The name of the `pip` package is now `docker` (was: `docker-py`). New
versions of this library will only be published as `docker` from now on.
* `docker.ssladapter` is now `docker.transport.ssladapter`
* The package structure has been flattened in certain cases, which may affect
import for `docker.auth` and `docker.utils.ports`
* `docker.utils.types` has been moved to `docker.types`
* `create_host_config`, `create_ipam_pool` and `create_ipam_config` have been
removed from `docker.utils`. They have been replaced by the following classes
in `docker.types`: `HostConfig`, `IPAMPool` and `IPAMCOnfig`.

Features

* Added a high-level, user-focused API as `docker.DockerClient`. See the
README and documentation for more information.
* Implemented `update_node` method in `APIClient`.
* Implemented `remove_node` method in `APIClient`.
* Added support for `restart_policy` in `update_container`.
* Added support for `labels` and `shmsize` in `build`.
* Added support for `attachable` in `create_network`
* Added support for `healthcheck` in `create_container`.
* Added support for `isolation` in `HostConfig`.
* Expanded support for `pid_mode` in `HostConfig` (now supports arbitrary
values for API version >= 1.24).
* Added support for `options` in `IPAMConfig`
* Added a `HealthCheck` class to `docker.types` to be used in
`create_container`.
* Added an `EndpointSpec` class to `docker.types` to be used in
`create_service` and `update_service`.


Bugfixes

* Fixed a bug where auth information would not be properly passed to the engine
during a `build` if the client used a credentials store.
* Fixed an issue with some exclusion patterns in `build`.
* Fixed an issue where context files were bundled with the wrong permissions
when calling `build` on Windows.
* Fixed an issue where auth info would not be retrieved from its default location
on Windows.
* Fixed an issue where lists of `networks` in `create_service` and
`update_service` wouldn't be properly converted for the engine.
* Fixed an issue where `endpoint_config` in `create_service` and
`update_service` would be ignored.
* `endpoint_config` in `create_service` and `update_service` has been
deprecated in favor of `endpoint_spec`
* Fixed a bug where `constraints` in a `TaskTemplate` object wouldn't be
properly converted for the engine.
* Fixed an issue where providing a dictionary for `env` in `ContainerSpec`
would provoke an `APIError` when sent to the engine.
* Fixed a bug where providing an `env_file` containing empty lines in
`create_container`would raise an exception.
* Fixed a bug where `detach` was being ignored by `exec_start`.

Documentation

* Documentation for classes and methods is now included alongside the code as
docstrings.

------

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/26?closed=1)

Bugfixes

* Fixed an issue where setting a `NpipeSocket` instance to blocking mode would
put it in non-blocking mode and vice-versa.

------

[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/25?closed=1)

Bugfixes

* Fixed an issue where concurrent attempts to access to a named pipe by the
client would sometimes cause recoverable exceptions to be raised.