Merge pull request #1350 from docker/changelog-update

Changelog update
This commit is contained in:
Joffrey F 2016-12-12 16:55:04 -08:00 committed by GitHub
commit edd3045ef1
3 changed files with 120 additions and 5 deletions

View File

@ -2,10 +2,6 @@
[![Build Status](https://travis-ci.org/docker/docker-py.svg?branch=master)](https://travis-ci.org/docker/docker-py)
**Warning:** This README is for the development version of the Docker SDK for
Python, which is significantly different to the stable version.
[Documentation for the stable version is here.](https://docker-py.readthedocs.io/)
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

View File

@ -1,2 +1,2 @@
version = "2.0.0-dev"
version = "2.1.0-dev"
version_info = tuple([int(d) for d in version.split("-")[0].split(".")])

View File

@ -1,6 +1,125 @@
Change log
==========
2.0.0
-----
[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.
1.10.6
------
[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.
1.10.5
------
[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.
1.10.4
------
[List of PRs / issues for this release](https://github.com/docker/docker-py/milestone/24?closed=1)
### Bugfixes
* Fixed an issue where `RestartPolicy.condition_types.ON_FAILURE` would yield
an invalid value.
* Fixed an issue where the SSL connection adapter would receive an invalid
argument.
* Fixed an issue that caused the Client to fail to reach API endpoints when
the provided `base_url` had a trailing slash.
* Fixed a bug where some `environment` values in `create_container`
containing unicode characters would raise an encoding error.
* Fixed a number of issues tied with named pipe transport on Windows.
* Fixed a bug where inclusion patterns in `.dockerignore` would cause some
excluded files to appear in the build context on Windows.
### Miscellaneous
* Adjusted version requirements for the `requests` library.
* It is now possible to run the docker-py test suite on Windows.
1.10.3
------