From 3a325deecd47209a47cef883c9eca8204229c057 Mon Sep 17 00:00:00 2001 From: Teekeks Date: Sat, 14 Jan 2023 00:35:55 +0100 Subject: [PATCH] bumped version to 3.4.0 and added changelog --- docs/_static/switcher.json | 2 +- docs/changelog.rst | 62 ++++++++++++++++++++++++++++++++++++++ twitchAPI/__init__.py | 4 +-- 3 files changed, 65 insertions(+), 3 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index 867d03e..6a41a54 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -5,7 +5,7 @@ "url": "https://pytwitchapi.readthedocs.io/en/latest/" }, { - "name": "3.3.0 (stable)", + "name": "3.4.0 (stable)", "version": "stable", "url": "https://pytwitchapi.readthedocs.io/en/stable/" }, diff --git a/docs/changelog.rst b/docs/changelog.rst index c741702..79c9b42 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,6 +3,68 @@ Changelog ========= +**************** +Version 3.4.0 +**************** + +Twitch +------ + +- Added the following new Endpoints: + + - "Update Shield Mode Status" :const:`~twitchAPI.twitch.Twitch.update_shield_mode_status()` + - "Get Shield Mode Status" :const:`~twitchAPI.twitch.Twitch.get_shield_mode_status()` + +- Added the new :code:`tags` Field to the following Endpoints: + + - "Get Streams" :const:`~twitchAPI.twitch.Twitch.get_streams()` + - "Get Followed Streams" :const:`~twitchAPI.twitch.Twitch.get_followed_streams()` + - "Search Channels" :const:`~twitchAPI.twitch.Twitch.search_channels()` + - "Get Channel Information" :const:`~twitchAPI.twitch.Twitch.get_channel_information()` + - "Modify Channel Information" :const:`~twitchAPI.twitch.Twitch.modify_channel_information()` + +- Improved documentation + +EventSub +-------- + +- Added the following new Topics: + + - "Shield Mode End" :const:`~twitchAPI.eventsub.EventSub.listen_channel_shield_mode_end()` + - "Shield Mode Begin" :const:`~twitchAPI.eventsub.EventSub.listen_channel_shield_mode_begin()` + +- Improved type hints of :code:`listen_` functions +- Added check if given callback is a coroutine to :code:`listen_` functions + +PubSub +------ + +- Fixed AttributeError when reconnecting + +Chat +---- + +- Expanded documentation on Events and Commands +- Fixed room cache being randomly destroyed over time +- Improved message handling performance drastically for high volume chat bots +- Fixed AttributeError when reconnecting +- :const:`~twitchAPI.chat.Chat.join_room()` now times out when it was unable to join a room instead of being infinitly stuck +- :const:`~twitchAPI.chat.Chat.join_room()` now returns a list of channels it was unable to join +- Added :const:`~twitchAPI.chat.Chat.join_timeout` +- Added :const:`~twitchAPI.chat.Chat.unregister_command()` +- Added :const:`~twitchAPI.chat.Chat.unregister_event()` +- Added the following new Events: + + - :const:`~twitchAPI.types.ChatEvent.USER_LEFT` - Triggered when a user leaves a chat channel + - :const:`~twitchAPI.types.ChatEvent.CHAT_CLEARED` - Triggered when a user was timed out, banned or theri messages where deleted + - :const:`~twitchAPI.types.ChatEvent.WHISPER` - Triggered when a user sends a whisper message to the bot + +OAuth +----- + +- fixed :const:`~twitchAPI.oauth.UserAuthenticator.authenticate()` getting stuck when :code:`user_token` is provided (thanks `@Tempystral `_!) + + **************** Version 3.3.0 **************** diff --git a/twitchAPI/__init__.py b/twitchAPI/__init__.py index 05f924f..ec55a8d 100644 --- a/twitchAPI/__init__.py +++ b/twitchAPI/__init__.py @@ -4,6 +4,6 @@ from .oauth import UserAuthenticator from .chat import Chat -VERSION = (3, 3, 0) +VERSION = (3, 4, 0) -__version__ = '3.3.0' +__version__ = '3.4.0'