From fd976eeb2c0693cce8fdd923ac47422ad7a8409f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20B=C3=B6hm?= Date: Thu, 1 Aug 2024 21:31:52 +0200 Subject: [PATCH] docs: Clean up CHANGELOG --- CHANGELOG.md | 69 +++++++++++++++------------------------------------- 1 file changed, 19 insertions(+), 50 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46dc78e..b771f4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,13 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] +## Changed + +- Update FastAPI docs to use dependency injection (@odie5533 in #321) + ## [2.2.0] - 2024-07-02 ### Changed - Bump paho-mqtt to 2.1 (@empicano in #305) - Migrate to paho-mqtt callback v2 (@empicano in #313) -- Update FastAPI example in the documentation (@odie5533 in #321) ### Fixed @@ -209,11 +212,8 @@ Yanked. We recently renamed the project from asyncio-mqtt to aiomqtt. Problem is ### Fixed - Fix race condition in the "advanced example" in `README.md`. Contributed by [Steve Palmer (@steverpalmer)](https://github.com/steverpalmer) in [#93](https://github.com/sbtinstruments/asyncio-mqtt/pull/93) - - Make `password` keyword argument optional (as it always should have been). Contributed by [@Shikoruma](https://github.com/Shikoruma) in [#89](https://github.com/sbtinstruments/asyncio-mqtt/pull/89) - - Fix false postive type error from Pyright regarding `asynccontextmanager`. Contributed by [Shawn Wilsher (@sdwilsh)](https://github.com/sdwilsh) in [#87](https://github.com/sbtinstruments/asyncio-mqtt/pull/87) - - Fix type hints (mostly related to async_generator). Contributed by [@laundmo](https://github.com/laundmo) in [#86](https://github.com/sbtinstruments/asyncio-mqtt/pull/86) ## [0.11.0] - 2021-11-04 @@ -235,11 +235,8 @@ Yanked. We recently renamed the project from asyncio-mqtt to aiomqtt. Problem is ### Added - Add new parameter `socket_options` to `Client.__init__`. Contributed by [@xydan83](https://github.com/xydan83) in [#71](https://github.com/sbtinstruments/asyncio-mqtt/pull/71) - - Add new parameter `message_retry_set` to `Client.__init__`. Contributed by [@xydan83](https://github.com/xydan83) in [#69](https://github.com/sbtinstruments/asyncio-mqtt/pull/69) - - Export `ProtocolVersion` from the main module. Contributed by [André (@tropxy)](https://github.com/tropxy) in [#65](https://github.com/sbtinstruments/asyncio-mqtt/pull/65) (1/2) - - Add documentation about publishers, client arguments, etc. Contributed by [André (@tropxy)](https://github.com/tropxy) in [#65](https://github.com/sbtinstruments/asyncio-mqtt/pull/65) (2/2) ### Fixed @@ -251,7 +248,6 @@ Yanked. We recently renamed the project from asyncio-mqtt to aiomqtt. Problem is ### Fixed - Fix handling of MQTTv5 reason codes. Contributed by [Jakob Schlyter (@jschlyter)](https://github.com/jschlyter) in [#59](https://github.com/sbtinstruments/asyncio-mqtt/pull/59) - - Account for `-1` socket handles in the close callback. Contributed by [@wrobell](https://github.com/wrobell) in [#60](https://github.com/sbtinstruments/asyncio-mqtt/pull/60) ## [0.9.0] - 2021-05-03 @@ -259,63 +255,43 @@ Yanked. We recently renamed the project from asyncio-mqtt to aiomqtt. Problem is ### Added - Add type hints. Contributed by [Ellis Percival (@flyte)](https://github.com/flyte) in [#37](https://github.com/sbtinstruments/asyncio-mqtt/pull/37) - - Add the `keepalive`, `bind_address`, `bind_port`, `clean_start`, `properties` arguments. Contributed by [Marcin Jaworski (@yawor)](https://github.com/yawor) in [#56](https://github.com/sbtinstruments/asyncio-mqtt/pull/56) ### Fixed -- Fix Python 3.6 compatibility. Contributed by [(@fipwmaqzufheoxq92ebc)](https://github.com/fipwmaqzufheoxq92ebc) in [#57](https://github.com/sbtinstruments/asyncio-mqtt/pull/57). - Note that asyncio-mqtt officially targets Python 3.7. Compatibility with 3.6 is community-driven. - +- Fix Python 3.6 compatibility. Contributed by [(@fipwmaqzufheoxq92ebc)](https://github.com/fipwmaqzufheoxq92ebc) in [#57](https://github.com/sbtinstruments/asyncio-mqtt/pull/57). Note that asyncio-mqtt officially targets Python 3.7. Compatibility with 3.6 is community-driven. - Fix "Broken pipe" error. Contributed by [Gilbert (@gilbertsmink)](https://github.com/gilbertsmink) in [#55](https://github.com/sbtinstruments/asyncio-mqtt/pull/55) - - Fix socket check when you select the WebSocket transport. Contributed by [Robert Chmielowiec (@chmielowiec)](https://github.com/chmielowiec) in [#54](https://github.com/sbtinstruments/asyncio-mqtt/pull/54) - - Fix `TypeError` on invalid username and password combination - - Check that \_misc_task is not None before trying to cancel it. Contributed by [Ellis Percival (@flyte)](https://github.com/flyte) in [#41](https://github.com/sbtinstruments/asyncio-mqtt/pull/41) - - Fix exception in `on_socket_open`: Non-thread-safe operation invoked on an event loop other than the current one. Contributed by [Ellis Percival (@flyte)](https://github.com/flyte) in [#40](https://github.com/sbtinstruments/asyncio-mqtt/pull/40) ## [0.8.1] - 2021-02-23 ### Fixed -- Fix `AttributeError` when you use WebSockets. - Contributed by [Robert Chmielowiec (@chmielowiec)](https://github.com/chmielowiec) in [#36](https://github.com/sbtinstruments/asyncio-mqtt/pull/36) - -- Fix `asyncio.InvalidStateError` in the `_on_connect` callback. - Contributed by [Maxim Shmalovsky (@vitalalerter)](https://github.com/vitalalerter) in [#31](https://github.com/sbtinstruments/asyncio-mqtt/pull/31) - -- Fix "Future exception was never retrieved" on disconnect. - Contributed by [Martin Hjelmare (@martinhjelmare)](https://github.com/martinhjelmare) in [#25](https://github.com/sbtinstruments/asyncio-mqtt/pull/25) - -- Fix `connect` so it no longer blocks the event loop. - Contributed by [Øystein Haug Olsen (@oholsen)](https://github.com/oholsen) in [#23](https://github.com/sbtinstruments/asyncio-mqtt/pull/23) +- Fix `AttributeError` when you use WebSockets. Contributed by [Robert Chmielowiec (@chmielowiec)](https://github.com/chmielowiec) in [#36](https://github.com/sbtinstruments/asyncio-mqtt/pull/36) +- Fix `asyncio.InvalidStateError` in the `_on_connect` callback. Contributed by [Maxim Shmalovsky (@vitalalerter)](https://github.com/vitalalerter) in [#31](https://github.com/sbtinstruments/asyncio-mqtt/pull/31) +- Fix "Future exception was never retrieved" on disconnect. Contributed by [Martin Hjelmare (@martinhjelmare)](https://github.com/martinhjelmare) in [#25](https://github.com/sbtinstruments/asyncio-mqtt/pull/25) +- Fix `connect` so it no longer blocks the event loop. Contributed by [Øystein Haug Olsen (@oholsen)](https://github.com/oholsen) in [#23](https://github.com/sbtinstruments/asyncio-mqtt/pull/23) ## [0.8.0] - 2020-11-09 ### Added -- Add `transport` argument to `Client` - Contributed by [@opengs](https://github.com/opengs) in [#21](https://github.com/sbtinstruments/asyncio-mqtt/pull/21) -- Add `clean_session` argument to `Client` - Contributed by [@nadyka](https://github.com/madnadyka) in [#17](https://github.com/sbtinstruments/asyncio-mqtt/pull/17) +- Add `transport` argument to `Client`. Contributed by [@opengs](https://github.com/opengs) in [#21](https://github.com/sbtinstruments/asyncio-mqtt/pull/21) +- Add `clean_session` argument to `Client`. Contributed by [@nadyka](https://github.com/madnadyka) in [#17](https://github.com/sbtinstruments/asyncio-mqtt/pull/17) ## [0.7.0] - 2020-08-04 -I've tested the library for production use at SBT Instruments. -This uncovered a bunch of bugs and missing features that I've adressed -in this release. We are approaching a 1.0.0 release. Let me know -if you want something changed before that via the issue tracker on GitHub. +I've tested the library for production use at SBT Instruments. This uncovered a bunch of bugs and missing features that I've adressed in this release. We are approaching a 1.0.0 release. Let me know if you want something changed before that via the issue tracker on GitHub. ### Added - Add support for MQTTv5. - Add `will` keyword argument to `Client`. - Add `MqttConnectError` with specific error messages for connection failures. -- Add `Client.id` property that returns the client ID (or `None` if - the client ID was not specified during construction). +- Add `Client.id` property that returns the client ID (or `None` if the client ID was not specified during construction). ### Fixed @@ -324,25 +300,20 @@ if you want something changed before that via the issue tracker on GitHub. - Fix compatibility with `asyncqt`'s event loop. - Fix race condition in `Client.connect` that raised an `AttributeError`. - Fix "[asyncio] Future exception was never retrieved" debug message. -- Fix support for python 3.6. - Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#12](https://github.com/sbtinstruments/asyncio-mqtt/pull/12) +- Fix support for python 3.6. Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#12](https://github.com/sbtinstruments/asyncio-mqtt/pull/12) ## [0.6.0] - 2020-06-26 ### Changed -- No longer logs exception in `Client.__aexit__`. It's perfectly valid - to exit due to, e.g., `asyncio.CancelledError` so let's not treat it as an - error. +- No longer logs exception in `Client.__aexit__`. It's perfectly valid to exit due to, e.g., `asyncio.CancelledError` so let's not treat it as an error. ## [0.5.0] - 2020-06-08 ### Added -- Add support for python 3.6. - Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#7](https://github.com/sbtinstruments/asyncio-mqtt/pull/7) (1/2). -- Add `client_id` and `tls_context` keyword arguments to the `Client` constructor. - Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#7](https://github.com/sbtinstruments/asyncio-mqtt/pull/7) (2/2). +- Add support for python 3.6. Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#7](https://github.com/sbtinstruments/asyncio-mqtt/pull/7) (1/2). +- Add `client_id` and `tls_context` keyword arguments to the `Client` constructor. Contributed by [Derrick Lyndon Pallas (@pallas)](https://github.com/pallas) in [#7](https://github.com/sbtinstruments/asyncio-mqtt/pull/7) (2/2). - Add `timeout` keyword argument to both `Client.connect` and `Client.disconnect`. Default value of `10` seconds (like the other functions). ### Changed @@ -365,8 +336,7 @@ if you want something changed before that via the issue tracker on GitHub. ### Added -- Add `username` and `password` keyword arguments to the `Client` constructor. - Contributed by [@gluap](https://github.com/gluap) in [#1](https://github.com/sbtinstruments/asyncio-mqtt/pull/1). +- Add `username` and `password` keyword arguments to the `Client` constructor. Contributed by [@gluap](https://github.com/gluap) in [#1](https://github.com/sbtinstruments/asyncio-mqtt/pull/1). ### Fixed @@ -376,8 +346,7 @@ if you want something changed before that via the issue tracker on GitHub. ### Fixed -- Fix regression with the `Client._wait_for` helper method introduced in the latest - release. +- Fix regression with the `Client._wait_for` helper method introduced in the latest release. ## [0.2.0] - 2020-04-07