Skip to content

Commit

Permalink
Added new dependency for resolving stereo channels and sample rate fr…
Browse files Browse the repository at this point in the history
…om audio files. Added setters for rate and channel to expose them incase the meta data is incorrect.
  • Loading branch information
sockheadrps committed Jun 18, 2024
2 parents 7bb21c2 + 62ff356 commit 1f12f4a
Show file tree
Hide file tree
Showing 42 changed files with 2,988 additions and 221 deletions.
18 changes: 0 additions & 18 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ jobs:
id: latest_version
uses: abatilo/[email protected]
with:
owner: TwitchIO
owner: PythonistaGuild
repo: TwitchIO

- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: '3.9'
python-version: '3.11'

- name: Install dependencies
run: |
Expand Down
15 changes: 15 additions & 0 deletions .github/workflows/signoff.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: validate-signoff
on:
pull_request:
types:
- opened
- edited

jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: PR Description Check
uses: pythonistaguild/[email protected]
with:
content: "[x] I have read and agree to the [Developer Certificate of Origin]"
1 change: 0 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ python:
path: .
extra_requirements:
- docs
system_packages: true
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
.. image:: https://img.shields.io/pypi/dm/twitchio?color=black
:target: https://pypi.org/project/twitchio
:alt: PyPI - Downloads


TwitchIO is an asynchronous Python wrapper around the Twitch API and IRC, with a powerful command extension for creating Twitch Chat Bots. TwitchIO covers almost all of the new Twitch API and features support for commands, PubSub, Webhooks, and EventSub.

Expand Down Expand Up @@ -104,7 +104,7 @@ Thank you to all those who contribute and help TwitchIO grow.

Special thanks to:

`SnowyLuma <https://github.com/SnowyLuma>`_
`LostLuma (Lilly) <https://github.com/LostLuma>`_

`Harmon <https://github.com/Harmon758>`_

Expand Down
124 changes: 119 additions & 5 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,121 @@
:orphan:

Master

2.10.0
=======
- TwitchIO
- Bug fixes
- fix: :func:`~twitchio.PartialUser.fetch_markers` was passing list of one element from payload, now just passes element

- ext.commands
- Changes
- Added which alias failed to load in the error raised by :func:`~twitchio.ext.commands.Context.add_command`

- ext.eventsub
- Additions
- Added :method:`Twitchio.ext.eventsub.EventSubClient.subscribe_channel_unban_request_create <EventSubClient.subscribe_channel_unban_request_create>` /
:method:`Twitchio.ext.eventsub.EventSubWSClient.subscribe_channel_unban_request_create <EventSubWSClient.subscribe_channel_unban_request_create>`
- Added :method:`Twitchio.ext.eventsub.EventSubClient.subscribe_channel_unban_request_resolve <EventSubClient.subscribe_channel_unban_request_resolve>` /
:method:`Twitchio.ext.eventsub.EventSubWSClient.subscribe_channel_unban_request_resolve <EventSubWSClient.subscribe_channel_unban_request_resolve>`
- ext.sounds
- Additions
- Added TinyTag as a dependency to support retrieving audio metadata using TinyTag in `ext.sounds.__init__.py`.
- added :method:`Twitchio.ext.sounds.rate setter.
- added :method:`Twitchio.ext.sounds.channels setter.
2.9.2
=======
- TwitchIO
- Changes:
- :func:`~twitchio.PartialUser.fetch_moderated_channels` returns "broadcaster_login" api field instead of "broadcaster_name"

- Bug fixes
- fix: :func:`~twitchio.PartialUser.fetch_moderated_channels` used ``user_`` prefix from payload, now uses ``broadcaster_`` instead

- ext.commands
- Bug fixes
- Fixed return type of :func:`~twitchio.ext.commands.Context.get_user` to PartialChatter / Chatter from PartialUser / User.


2.9.1
=======
- ext.eventsub
- Bug fixes
- fix: Special-cased a restart when a specific known bad frame is received.


2.9.0
=======
- TwitchIO
- Additions
- Added :class:`~twitchio.AdSchedule` and :class:`~twitchio.Emote`
- Added the new ad-related methods for :class:`~twitchio.PartialUser`:
- :func:`~twitchio.PartialUser.fetch_ad_schedule`
- :func:`~twitchio.PartialUser.snooze_ad`
- Added new method :func:`~twitchio.PartialUser.fetch_user_emotes` to :class:`~twitchio.PartialUser`
- Added :func:`~twitchio.PartialUser.fetch_moderated_channels` to :class:`~twitchio.PartialUser`

- Bug fixes
- Fixed ``event_token_expired`` not applying to the current request.

- ext.eventsub
- Bug fixes
- Fixed a crash where a Future could be None, causing unintentional errors.
- Special-cased a restart when a specific known bad frame is received.


2.8.2
======
- ext.commands
- Bug fixes
- Fixed an issue where built-in converters would raise an internal ``TypeError``.

2.8.1
======
- ext.commands
- Bug fixes
- Fixed an issue where ``CommandNotFound`` couldn't be processed from ``get_context``.

2.8.0
======
- TwitchIO
- Additions
- Added the new follower / followed endpoints for :class:`~twitchio.PartialUser`:
- :func:`~twitchio.PartialUser.fetch_channel_followers`
- :func:`~twitchio.PartialUser.fetch_channel_following`
- :func:`~twitchio.PartialUser.fetch_channel_follower_count`
- :func:`~twitchio.PartialUser.fetch_channel_following_count`
- The deprecated methods have had warnings added in the docs.
- New models for the new methods have been added:
- :class:`~twitchio.ChannelFollowerEvent`
- :class:`~twitchio.ChannelFollowingEvent`
- New optional ``is_featured`` query parameter for :func:`~twitchio.PartialUser.fetch_clips`
- New attribute :attr:`~twitchio.Clip.is_featured` for :class:`~twitchio.Clip`

- Bug fixes
- Fix IndexError when getting prefix when empty message is sent in a reply.

- ext.eventsub
- Bug fixes
- Fix websocket reconnection event.
- Fix another websocket reconnect issue where it tried to decode nonexistent headers.

- ext.commands
- Additions
- Added support for the following typing constructs in command signatures:
- ``Union[A, B]`` / ``A | B``
- ``Optional[T]`` / ``T | None``
- ``Annotated[T, converter]`` (accessible through the ``typing_extensions`` module on older python versions)

- Docs
- Added walkthrough for ext.commands

2.7.0
======
- TwitchIO
- Additions
- Added :func:`~twitchio.PartialUser.fetch_charity_campaigns` with :class:`~twitchio.CharityCampaign` and :class:`~twitchio.CharityValues`.
- Added :func:`~twitchio.Client.fetch_global_chat_badges`
- Added User method :func:`~twitchio.PartialUser.fetch_chat_badges`
- Added repr for :class:`~twitchio.SearchUser`
Expand All @@ -16,18 +128,20 @@ Master
- Added :func:`~twitchio.Client.fetch_content_classification_labels` along with :class:`~twitchio.ContentClassificationLabel`
- Added :attr:`~twitchio.ChannelInfo.content_classification_labels` and :attr:`~twitchio.ChannelInfo.is_branded_content` to :class:`~twitchio.ChannelInfo`
- Added new parameters to :func:`~twitchio.PartialUser.modify_stream` for ``is_branded_content`` and ``content_classification_labels``

- Bug fixes
- Fix :func:`~twitchio.Client.search_categories` due to :attr:`~twitchio.Game.igdb_id` being added to :class:`~twitchio.Game`
- Made Chatter :attr:`~twitchio.Chatter.id` property public
- :func:`~twitchio.Client.event_token_expired` will now be called correctly when response is ``401 Invalid OAuth token``
- Fix reconnect loop when Twitch sends a RECONNECT via IRC websocket
- Fix :func:`~twitchio.CustomReward.edit` so it now can enable the reward

- Other Changes
- Updated the HTTPException to provide useful information when an error is raised.

- ext.sounds
- Bug fixes
- Added setters for Sounds.rate and Sounds.channels properties
- ext.eventsub
- Added websocket support via :class:`~twitchio.ext.eventsub.EventSubWSClient`.
- Added support for charity donation events.

- Other
- [speed] extra
Expand Down
9 changes: 4 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@

on_rtd = os.environ.get("READTHEDOCS") == "True"
project = "TwitchIO"
copyright = "2022, TwitchIO"
author = "TwitchIO"
copyright = "2024, TwitchIO"
author = "PythonistaGuild"

# The full version, including alpha/beta/rc tags
release = ''
Expand All @@ -46,7 +46,8 @@
"sphinxcontrib.asyncio",
"sphinx.ext.intersphinx",
"attributetable",
"sphinxext.opengraph"
"sphinxext.opengraph",
"sphinx.ext.napoleon"
]

# OpenGraph Meta Tags
Expand Down Expand Up @@ -93,8 +94,6 @@
html_js_files = ["js/custom.js"]


extensions.append("sphinx.ext.napoleon")

napoleon_use_rtype = False
napoleon_google_docstring = False
napoleon_numpy_docstring = True
Expand Down
Loading

0 comments on commit 1f12f4a

Please sign in to comment.