Merge pull request '1.1.0' (#1) from dev into latest

Reviewed-on: #1

README.md

@@ -37,10 +37,9 @@ import asyncio
 from oxidetwitch.api import TwitchAPIClient
 
 async def main():
-    async with TwitchAPIClient(
+    async with TwitchClient(
         client_id="your_id",
         client_secret="your_client_secret",
-        redirect_uri="https://example.com",
         redis_url="redis://localhost:6379",
     ) as twitch:
         # Get user data (automatically cached if configured)
@@ -58,10 +57,11 @@ If you are polling 100+ streams, OxideTwitch spaces out the requests using the *
 
 ```python
 async def poll_streams(channels):
-    async with TwitchAPIClient(...) as twitch:
+    async with TwitchClient(...) as twitch:
         # These will be executed as fast as the rate limiter allows
-        tasks = [twitch.get_streams(..., user_login=name) for name in channels]
+        tasks = [twitch.get_stream(user_login=name) for name in channels]
         streams = await asyncio.gather(*tasks)
+        return [s for s in streams if s.is_live]
 
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oxidetwitch"
-version = "1.2.3"
+version = "1.1.0"
 description = "Client for Twitch API"
 readme = "README.md"
 authors = [{ name = "Miwory", email = "miwory.uwu@gmail.com" }]
@@ -99,3 +99,6 @@ ignore-one-line-docstrings = true
 quote-style = "single"
 indent-style = "space"
 docstring-code-format = true
+
+[tool.uv.sources]
+aiohttpx = { index = "Miwory" }

src/oxidetwitch/auth.py

@@ -16,7 +16,7 @@ class TwitchAuthClient(OxideHTTP):
         redis_url: str | None = None,
         proxy_url: str | None = None,
     ) -> None:
-        self.base_uri = 'https://id.twitch.tv/oauth2/'
+        self.base_uri = 'https://id.twitch.tv/oauth2'
         self.client_id = client_id
         self.client_secret = client_secret
         self.redirect_uri = redirect_uri
@@ -62,7 +62,7 @@ class TwitchAuthClient(OxideHTTP):
 
         match req.status_code:
             case st.OK:
-                return s.AppAccessToken.model_validate(await req.json())
+                return s.AppAccessToken.model_validate(req.json())
 
             case _:
                 raise s.InternalError(req.status_code, 'Internal Server Error')
@@ -81,7 +81,7 @@ class TwitchAuthClient(OxideHTTP):
 
         match req.status_code:
             case st.OK:
-                return s.UserAccessToken.model_validate(await req.json())
+                return s.UserAccessToken.model_validate(req.json())
 
             case st.BAD_REQUEST:
                 return None
@@ -99,7 +99,7 @@ class TwitchAuthClient(OxideHTTP):
 
         match req.status_code:
             case st.OK:
-                return s.AccessTokenValidation.model_validate(await req.json())
+                return s.AccessTokenValidation.model_validate(req.json())
 
             case st.UNAUTHORIZED:
                 return None
@@ -122,7 +122,7 @@ class TwitchAuthClient(OxideHTTP):
 
         match req.status_code:
             case st.OK:
-                return s.UserAccessToken.model_validate(await req.json())
+                return s.UserAccessToken.model_validate(req.json())
 
             case st.BAD_REQUEST:
                 return None

src/oxidetwitch/schema.py

@@ -33,14 +33,6 @@ class Pagination(BaseSchema):
     cursor: str
 
 
-class BasePaginated(BaseSchema):
-    pagination: Pagination | dict[Any, Any] | None = None
-
-
-class PaginatedSchema[T](BasePaginated):
-    data: list[T]
-
-
 class AppAccessToken(BaseSchema):
     access_token: str
     expires_in: int
@@ -108,8 +100,9 @@ class ExtensionAnalyticsData(BaseSchema):
     date_range: DateRange
 
 
-class ExtensionAnalytics(PaginatedSchema[ExtensionAnalyticsData]):
+class ExtensionAnalytics(BaseSchema):
     data: list[ExtensionAnalyticsData]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class GameAnalyticsData(BaseSchema):
@@ -119,8 +112,9 @@ class GameAnalyticsData(BaseSchema):
     date_range: DateRange
 
 
-class GameAnalytics(PaginatedSchema[GameAnalyticsData]):
+class GameAnalytics(BaseSchema):
     data: list[GameAnalyticsData]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class BitsLeaderboardData(BaseSchema):
@@ -219,8 +213,9 @@ class ExtensionTransactionsData(BaseSchema):
     product_data: ExtensionProductData
 
 
-class ExtensionTransactions(PaginatedSchema[ExtensionTransactionsData]):
+class ExtensionTransactions(BaseSchema):
     data: list[ExtensionTransactionsData]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class ContentClassificationLabel(TypedDict):
@@ -270,8 +265,9 @@ class FollowedChannel(BaseSchema):
     followed_at: datetime
 
 
-class FollowedChannels(PaginatedSchema[FollowedChannel]):
+class FollowedChannels(BaseSchema):
     data: list[FollowedChannel]
+    pagination: Pagination | dict[Any, Any] | None = None
     total: int
 
 
@@ -282,8 +278,9 @@ class ChannelFollower(BaseSchema):
     followed_at: datetime
 
 
-class ChannelFollowers(PaginatedSchema[ChannelFollower]):
+class ChannelFollowers(BaseSchema):
     data: list[ChannelFollower]
+    pagination: Pagination | dict[Any, Any] | None = None
     total: int
 
 
@@ -356,8 +353,9 @@ class CustomRewardRedemption(BaseSchema):
     reward: CustomRewardRedemptionReward
 
 
-class CustomRewardRedemptions(PaginatedSchema[CustomRewardRedemption]):
+class CustomRewardRedemptions(BaseSchema):
     data: list[CustomRewardRedemption]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class CharityCampaignCurrentAmount(BaseSchema):
@@ -404,8 +402,9 @@ class CharityDonation(BaseSchema):
     amount: CharityDonationAmount
 
 
-class CharityDonations(PaginatedSchema[CharityDonation]):
+class CharityDonations(BaseSchema):
     data: list[CharityDonation]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class ChattersData(BaseSchema):
@@ -414,8 +413,9 @@ class ChattersData(BaseSchema):
     user_name: str
 
 
-class Chatters(PaginatedSchema[ChattersData]):
+class Chatters(BaseSchema):
     data: list[ChattersData]
+    pagination: Pagination | dict[Any, Any] | None = None
     total: int
 
 
@@ -522,8 +522,8 @@ class SharedChatSession(BaseSchema):
     data: list[SharedChatSessionData]
 
 
-class UserEmotes(PaginatedSchema[ChannelEmote], ChannelEmotes):
-    pass
+class UserEmotes(ChannelEmotes):
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class MessageDropReason(BaseSchema):
@@ -572,8 +572,9 @@ class Clip(BaseSchema):
     is_featured: bool
 
 
-class Clips(PaginatedSchema[Clip]):
+class Clips(BaseSchema):
     data: list[Clip]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class ClipDownload(BaseSchema):
@@ -625,8 +626,9 @@ class ConduitShard(BaseSchema):
     transport: ConduitShardTransportWebhook | ConduitShardTransportWebsocket
 
 
-class ConduitShards(PaginatedSchema[ConduitShard]):
+class ConduitShards(BaseSchema):
     data: list[ConduitShard]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class UpdateConduitShardTransportWebhook(TypedDict):
@@ -686,8 +688,9 @@ class DropEntitlement(BaseSchema):
     last_updated: datetime
 
 
-class DropsEntitlements(PaginatedSchema[DropEntitlement]):
+class DropsEntitlements(BaseSchema):
     data: list[DropEntitlement]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class UpdateDropsEntitlementsData(BaseSchema):
@@ -720,8 +723,9 @@ class ExtensionLiveChannel(BaseSchema):
     title: str
 
 
-class ExtensionLiveChannels(PaginatedSchema[ExtensionLiveChannel]):
+class ExtensionLiveChannels(BaseSchema):
     data: list[ExtensionLiveChannel]
+    paginaiton: Pagination | dict[Any, Any] | None = None
 
 
 class ExtensionSecret(BaseSchema):
@@ -834,11 +838,12 @@ class ExtensionBitsProducts(BaseSchema):
     data: list[ExtensionBitsProduct]
 
 
-class EventsubBaseSubscriptions(PaginatedSchema[sub.Any]):
+class EventsubBaseSubscriptions(BaseSchema):
     data: list[sub.Any]
     total: int
     total_cost: int
     max_total_cost: int
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Game(BaseSchema):
@@ -848,8 +853,9 @@ class Game(BaseSchema):
     igdb_id: int | str
 
 
-class Games(PaginatedSchema[Game]):
+class Games(BaseSchema):
     data: list[Game]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class CreatorGoal(BaseSchema):
@@ -965,8 +971,9 @@ class BannedUser(BaseSchema):
     moderator_name: str
 
 
-class BannedUsers(PaginatedSchema[BannedUser]):
+class BannedUsers(BaseSchema):
     data: list[BannedUser]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class BanUserData(BaseSchema):
@@ -1001,8 +1008,9 @@ class UnbanRequest(BaseSchema):
     resolution_text: str | None
 
 
-class UnbanRequests(PaginatedSchema[UnbanRequest]):
+class UnbanRequests(BaseSchema):
     data: list[UnbanRequest]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class BlockedTerm(BaseSchema):
@@ -1015,8 +1023,9 @@ class BlockedTerm(BaseSchema):
     expires_at: datetime | None
 
 
-class BlockedTerms(PaginatedSchema[BlockedTerm]):
+class BlockedTerms(BaseSchema):
     data: list[BlockedTerm]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class ModeratedChannel(BaseSchema):
@@ -1025,8 +1034,9 @@ class ModeratedChannel(BaseSchema):
     broadcaster_name: str
 
 
-class ModeratedChannels(PaginatedSchema[ModeratedChannel]):
+class ModeratedChannels(BaseSchema):
     data: list[ModeratedChannel]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Moderator(BaseSchema):
@@ -1035,8 +1045,9 @@ class Moderator(BaseSchema):
     user_name: str
 
 
-class Moderators(PaginatedSchema[Moderator]):
+class Moderators(BaseSchema):
     data: list[Moderator]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class VIP(BaseSchema):
@@ -1045,8 +1056,9 @@ class VIP(BaseSchema):
     user_name: str
 
 
-class VIPs(PaginatedSchema[VIP]):
+class VIPs(BaseSchema):
     data: list[VIP]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class ShieldModeStatusData(BaseSchema):
@@ -1096,8 +1108,9 @@ class Poll(BaseSchema):
     ended_at: datetime | None
 
 
-class Polls(PaginatedSchema[Poll]):
+class Polls(BaseSchema):
     data: list[Poll]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class PredictionTopPredictor(BaseSchema):
@@ -1132,8 +1145,9 @@ class Prediction(BaseSchema):
     locked_at: datetime | None
 
 
-class Predictions(PaginatedSchema[Prediction]):
+class Predictions(BaseSchema):
     data: list[Prediction]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Raid(BaseSchema):
@@ -1173,8 +1187,9 @@ class Schedule(BaseSchema):
     segments: list[ScheduleSegment]
 
 
-class Schedules(PaginatedSchema[Schedule]):
+class Schedules(BaseSchema):
     data: list[Schedule]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Category(BaseSchema):
@@ -1183,8 +1198,9 @@ class Category(BaseSchema):
     box_art_url: str
 
 
-class Categories(PaginatedSchema[Category]):
+class Categories(BaseSchema):
     data: list[Category]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Channel(BaseSchema):
@@ -1201,8 +1217,9 @@ class Channel(BaseSchema):
     started_at: datetime | None
 
 
-class Channels(PaginatedSchema[Channel]):
+class Channels(BaseSchema):
     data: list[Channel]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class StreamKey(BaseSchema):
@@ -1231,8 +1248,9 @@ class Stream(BaseSchema):
     is_mature: bool
 
 
-class Streams(PaginatedSchema[Stream]):
+class Streams(BaseSchema):
     data: list[Stream]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class BaseStreamMarker(BaseSchema):
@@ -1262,8 +1280,9 @@ class StreamMarkersData(BaseSchema):
     videos: list[StreamMarkerVideo]
 
 
-class StreamMarkers(PaginatedSchema[StreamMarkersData]):
+class StreamMarkers(BaseSchema):
     data: list[StreamMarkersData]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class Subscription(BaseSchema):
@@ -1284,8 +1303,9 @@ class BroadcasterSubscription(Subscription):
     user_name: str
 
 
-class BroadcasterSubscriptions(PaginatedSchema[BroadcasterSubscription]):
+class BroadcasterSubscriptions(BaseSchema):
     data: list[BroadcasterSubscription]
+    pagination: Pagination | dict[Any, Any] | None = None
     total: int
     points: int
 
@@ -1371,8 +1391,9 @@ class UserBlock(BaseSchema):
     display_name: str
 
 
-class UserBlockList(PaginatedSchema[UserBlock]):
+class UserBlockList(BaseSchema):
     data: list[UserBlock]
+    pagination: Pagination | dict[Any, Any] | None = None
 
 
 class UserExtension(BaseSchema):
@@ -1459,8 +1480,9 @@ class Video(BaseSchema):
     muted_segments: list[VideoMutedSegment]
 
 
-class Videos(PaginatedSchema[Video]):
+class Videos(BaseSchema):
     data: list[Video]
+    pagination: Pagination | dict[Any, Any] | None
 
 
 class DeleteVideos(BaseSchema):