ossapi 5.1.2__tar.gz → 5.2.0__tar.gz

{ossapi-5.1.2 → ossapi-5.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ossapi
-Version: 5.1.2
-Summary: Complete python wrapper for osu! api v2 and v1.
+Version: 5.2.0
+Summary: The definitive python wrapper for the osu! api
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/tybug/ossapi
 Keywords: osu!,wrapper,api,python
@@ -16,6 +16,7 @@ Requires-Dist: osrparse~=6.0
 Requires-Dist: typing_utils
 Provides-Extra: async
 Requires-Dist: aiohttp; extra == "async"
+Dynamic: license-file
 
 # ossapi ([documentation](https://tybug.github.io/ossapi/)) [![PyPI version](https://badge.fury.io/py/ossapi.svg)](https://pypi.org/project/ossapi/)
 

{ossapi-5.1.2 → ossapi-5.2.0}/ossapi/__init__.py

@@ -3,7 +3,6 @@ import logging
 # we need to explicitly set a handler for the logging module to be happy
 handler = logging.StreamHandler()
 logging.getLogger("ossapi").addHandler(handler)
-from importlib import metadata
 
 from ossapi.ossapi import (
     OssapiV1,
@@ -145,7 +144,7 @@ from ossapi.ossapiv2_async import OssapiAsync
 from oauthlib.oauth2 import AccessDeniedError, TokenExpiredError
 from oauthlib.oauth2.rfc6749.errors import InsufficientScopeError
 
-__version__ = metadata.version(__package__)
+__version__ = "5.2.0"
 
 __all__ = [
     # OssapiV1

{ossapi-5.1.2 → ossapi-5.2.0}/ossapi/models.py

@@ -1520,7 +1520,7 @@ class RoomLeaderboardUserScore(RoomLeaderboardScore):
 
 class RoomLeaderboard(Model):
     leaderboard: List[RoomLeaderboardScore]
-    user_score: RoomLeaderboardUserScore
+    user_score: Optional[RoomLeaderboardUserScore]
 
 
 class Match(Model):
@@ -1596,3 +1596,13 @@ class DailyChallengeUserStats(Model):
 class NonLegacyMod(Model):
     acronym: str
     settings: Any
+
+
+class Tag(Model):
+    id: int
+    name: str
+    description: str
+
+
+class Tags(Model):
+    tags: List[Tag]

{ossapi-5.1.2 → ossapi-5.2.0}/ossapi/ossapiv2.py

@@ -37,6 +37,8 @@ from ossapi.models import (
     Score,
     BeatmapsetSearchResult,
     ModdingHistoryEventsBundle,
+    Tag,
+    Tags,
     User,
     Rankings,
     BeatmapScores,
@@ -2491,7 +2493,9 @@ class Ossapi:
         return self._get(Room, f"/rooms/{room_id}")
 
     @request(Scope.PUBLIC, requires_user=True, category="rooms")
-    def room_leaderboard(self, room_id: RoomIdT) -> RoomLeaderboard:
+    def room_leaderboard(
+        self, room_id: RoomIdT, limit: Optional[int] = None, page: Optional[int] = None
+    ) -> RoomLeaderboard:
         """
         Get the leaderboard of a room.
 
@@ -2499,13 +2503,20 @@ class Ossapi:
         ----------
         room_id
             The room to get the leaderboard of.
+        limit
+            Maximum number of room scores to return.
+        offset
+            Offset for pagination.
 
         Notes
         -----
         Implements the `Get Room Leaderboard
         <https://osu.ppy.sh/docs/index.html#roomsroomleaderboard>`__ endpoint.
         """
-        return self._get(RoomLeaderboard, f"/rooms/{room_id}/leaderboard")
+        params = {"limit": limit, "page": page}
+        return self._get(
+            RoomLeaderboard, f"/rooms/{room_id}/leaderboard", params=params
+        )
 
     @request(Scope.PUBLIC, requires_user=True, category="rooms")
     def rooms(
@@ -2721,6 +2732,22 @@ class Ossapi:
         spotlights = self._get(Spotlights, "/spotlights")
         return spotlights.spotlights
 
+    # /tags
+    # -----
+
+    @request(Scope.PUBLIC, category="tags")
+    def tags(self) -> List[Tag]:
+        """
+        Get beatmap tags.
+
+        Notes
+        -----
+        Implements the `Get Tags
+        <https://osu.ppy.sh/docs/index.html#get-apiv2tags>`__ endpoint.
+        """
+        tags = self._get(Tags, "/tags")
+        return tags.tags
+
     # /users
     # ------
 

{ossapi-5.1.2 → ossapi-5.2.0}/ossapi/ossapiv2_async.py

@@ -50,6 +50,8 @@ from ossapi.models import (
     Score,
     BeatmapsetSearchResult,
     ModdingHistoryEventsBundle,
+    Tag,
+    Tags,
     User,
     Rankings,
     BeatmapScores,
@@ -2829,6 +2831,22 @@ class OssapiAsync:
         spotlights = await self._get(Spotlights, "/spotlights")
         return spotlights.spotlights
 
+    # /tags
+    # -----
+
+    @request(Scope.PUBLIC, category="tags")
+    async def tags(self) -> List[Tag]:
+        """
+        Get beatmap tags.
+
+        Notes
+        -----
+        Implements the `Get Tags
+        <https://osu.ppy.sh/docs/index.html#get-apiv2tags>`__ endpoint.
+        """
+        tags = await self._get(Tags, "/tags")
+        return tags.tags
+
     # /users
     # ------
 

{ossapi-5.1.2 → ossapi-5.2.0}/ossapi.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ossapi
-Version: 5.1.2
-Summary: Complete python wrapper for osu! api v2 and v1.
+Version: 5.2.0
+Summary: The definitive python wrapper for the osu! api
 Author-email: Liam DeVoe <orionldevoe@gmail.com>
 Project-URL: Homepage, https://github.com/tybug/ossapi
 Keywords: osu!,wrapper,api,python
@@ -16,6 +16,7 @@ Requires-Dist: osrparse~=6.0
 Requires-Dist: typing_utils
 Provides-Extra: async
 Requires-Dist: aiohttp; extra == "async"
+Dynamic: license-file
 
 # ossapi ([documentation](https://tybug.github.io/ossapi/)) [![PyPI version](https://badge.fury.io/py/ossapi.svg)](https://pypi.org/project/ossapi/)
 

{ossapi-5.1.2 → ossapi-5.2.0}/pyproject.toml

@@ -1,7 +1,12 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
 [project]
 name = "ossapi"
-version = "5.1.2"
-description = "Complete python wrapper for osu! api v2 and v1."
+# see [tool.setuptools.dynamic]
+dynamic = ["version"]
+description = "The definitive python wrapper for the osu! api"
 readme = "README.md"
 keywords = ["osu!", "wrapper", "api", "python"]
 authors = [
@@ -24,3 +29,6 @@ async = ["aiohttp"]
 
 [project.urls]
 "Homepage" = "https://github.com/tybug/ossapi"
+
+[tool.setuptools.dynamic]
+version = {attr = "ossapi.__version__"}

{ossapi-5.1.2 → ossapi-5.2.0}/tests/test_endpoints.py

@@ -331,6 +331,11 @@ class TestScores(TestCase):
         api.scores("osu", cursor_string=scores.cursor_string)
 
 
+class TestTags(TestCase):
+    def test_deserialize(self):
+        api.tags()
+
+
 # ======================
 # api_full test cases
 # ======================
@@ -356,6 +361,8 @@ class TestRoomLeaderboard(TestCaseAuthorizationCode):
     def test_deserialize(self):
         # https://osu.ppy.sh/multiplayer/rooms/232594
         api_full.room_leaderboard(232594)
+        # https://osu.ppy.sh/multiplayer/rooms/1222586 (daily challenge)
+        api_full.room_leaderboard(1222586, page=10)
 
 
 class TestRooms(TestCaseAuthorizationCode):