deezer-python 5.11.1__py3-none-any.whl → 6.0.0__py3-none-any.whl

deezer/__init__.py

@@ -15,7 +15,7 @@ from deezer.resources import (
     User,
 )
 
-__version__ = "5.11.1"
+__version__ = "6.0.0"
 __all__ = [
     "Album",
     "Artist",

deezer/client.py

@@ -565,9 +565,12 @@ class Client:
         Create a playlist on the user's account
 
         :param playlist_name: the name of the playlist.
-        :return: ID of the new playlist.
+        :return: the ID of the playlist that was created
         """
-        return self.request("POST", "user/me/playlists", title=playlist_name).id
+        result = self.request("POST", "user/me/playlists", title=playlist_name)
+        # Note: the REST API call returns a dict with just the "id" key in it,
+        # so we return that instead of the full Playlist object
+        return result.id
 
     def delete_playlist(self, playlist_id) -> bool:
         """

deezer/resources/resource.py

@@ -71,6 +71,32 @@ class Resource:
             **kwargs,
         )
 
+    def post_relation(self, relation, **kwargs):
+        """
+        Generic method to make a POST request to a relation from any resource.
+
+        This is not meant to be used directly by a client, it's more
+        a helper method for the child objects.
+        """
+        return self.client.request(
+            "POST",
+            f"{self.type}/{self.id}/{relation}",
+            **kwargs,
+        )
+
+    def delete_relation(self, relation, **kwargs):
+        """
+        Generic method to make a DELETE request to a relation from any resource.
+
+        This is not meant to be used directly by a client, it's more
+        a helper method for the child objects.
+        """
+        return self.client.request(
+            "DELETE",
+            f"{self.type}/{self.id}/{relation}",
+            **kwargs,
+        )
+
     def get_paginated_list(
         self,
         relation: str,

deezer/resources/user.py

@@ -4,6 +4,7 @@ import datetime as dt
 from typing import TYPE_CHECKING
 
 from ..dates import parse_date
+from ..utils import get_id
 from .resource import Resource
 
 if TYPE_CHECKING:
@@ -56,6 +57,24 @@ class User(Resource):
         """
         return self.get_paginated_list("albums", **kwargs)
 
+    def add_album(self, album: Album | int):
+        """
+        Add an album to user's favorite albums.
+
+        :param album: an :class:`~deezer.Album` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.post_relation("albums", album_id=get_id(album))
+
+    def remove_album(self, album: Album | int):
+        """
+        Remove an album from user's favorite albums.
+
+        :param album: an :class:`~deezer.Album` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.delete_relation("albums", album_id=get_id(album))
+
     def get_tracks(self, **kwargs) -> PaginatedList[Track]:
         """
         Get user's favorite tracks.
@@ -65,6 +84,24 @@ class User(Resource):
         """
         return self.get_paginated_list("tracks", **kwargs)
 
+    def add_track(self, track: Track | int):
+        """
+        Add a track to user's favorite tracks.
+
+        :param track: a :class:`~deezer.Track` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.post_relation("tracks", track_id=get_id(track))
+
+    def remove_track(self, track: Track | int):
+        """
+        Remove a track from user's favorite tracks.
+
+        :param track: a :class:`~deezer.Track` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.delete_relation("tracks", track_id=get_id(track))
+
     def get_artists(self, **kwargs) -> PaginatedList[Artist]:
         """
         Get user's favorite artists.
@@ -74,6 +111,24 @@ class User(Resource):
         """
         return self.get_paginated_list("artists", **kwargs)
 
+    def add_artist(self, artist: Artist | int):
+        """
+        Add an artist to user's favorite artists.
+
+        :param artist: an :class:`~deezer.Artist` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.post_relation("artists", artist_id=get_id(artist))
+
+    def remove_artist(self, artist: Artist | int):
+        """
+        Remove an artist from user's favorite artists.
+
+        :param artist: an :class:`~deezer.Artist` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.delete_relation("artists", artist_id=get_id(artist))
+
     def get_followers(self, **kwargs) -> PaginatedList[User]:
         """
         Get user's followers.
@@ -92,6 +147,24 @@ class User(Resource):
         """
         return self.get_paginated_list("followings", **kwargs)
 
+    def follow(self, user: User | int):
+        """
+        Follow a user.
+
+        :param user: a :class:`~deezer.User` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.post_relation("followings", user_id=get_id(user))
+
+    def unfollow(self, user: User | int):
+        """
+        Unfollow a user.
+
+        :param user: a :class:`~deezer.User` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.delete_relation("followings", user_id=get_id(user))
+
     def get_playlists(self, **kwargs) -> PaginatedList[Playlist]:
         """
         Get user's public playlists.
@@ -100,3 +173,33 @@ class User(Resource):
                   of :class:`Playlist <deezer.Playlist>` instances
         """
         return self.get_paginated_list("playlists", **kwargs)
+
+    def add_playlist(self, playlist: Playlist | int):
+        """
+        Add a playlist to user's public playlists.
+
+        :param playlist: a :class:`~deezer.Playlist` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.post_relation("playlists", playlist_id=get_id(playlist))
+
+    def remove_playlist(self, playlist: Playlist | int):
+        """
+        Remove a playlist from user's public playlists.
+
+        :param playlist: a :class:`~deezer.Playlist` instance or its ID
+        :returns: a boolean that tells if the operation was successful
+        """
+        return self.delete_relation("playlists", playlist_id=get_id(playlist))
+
+    def create_playlist(self, title: str) -> int:
+        """
+        Create a playlist.
+
+        :param title: the title of the playlist
+        :returns: the ID of the playlist that was created
+        """
+        result = self.post_relation("playlists", title=title)
+        # Note: the REST API call returns a dict with just the "id" key in it,
+        # so we return that instead of the full Playlist object
+        return result.id

deezer/utils.py

@@ -9,9 +9,13 @@ if TYPE_CHECKING:
 def gen_ids(item_list: Iterable[int | Resource]) -> Generator[int, None, None]:
     """Get IDs for an iterable of `int` or `Resources`."""
     for item in item_list:
-        if isinstance(item, int):
-            yield item
-        elif hasattr(item, "id"):
-            yield item.id
-        else:
-            raise NotImplementedError(f"Unknown type for {item}")
+        yield get_id(item)
+
+
+def get_id(item: int | Resource) -> int:
+    """Get ID for an `int` or `Resource`."""
+    if isinstance(item, int):
+        return item
+    if hasattr(item, "id"):
+        return item.id
+    raise NotImplementedError(f"Unknown type for {item}")

{deezer_python-5.11.1.dist-info → deezer_python-6.0.0.dist-info}/METADATA

@@ -1,20 +1,19 @@
 Metadata-Version: 2.1
 Name: deezer-python
-Version: 5.11.1
+Version: 6.0.0
 Summary: A friendly wrapper library for the Deezer API
 Home-page: https://github.com/browniebroke/deezer-python
 License: MIT
 Keywords: deezer,sdk,client,requests
 Author: Bruno Alla
 Author-email: alla.brunoo@gmail.com
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10

{deezer_python-5.11.1.dist-info → deezer_python-6.0.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-deezer/__init__.py,sha256=bfLgYevHxkDzF_M0plFBSOC-0kitvjvLOkT9yclXCog,557
-deezer/client.py,sha256=U_VV3ykiN653BbqN7PV2Bl6Aq_bHFQQ0EBbKwK82KEA,24657
+deezer/__init__.py,sha256=0NeTLMTWBprgN9H2xa0pe89alLo8Y9PHixGg7TYDjwc,556
+deezer/client.py,sha256=AgFYYDqe3An7momBuR0JqgkZ-c3JPuRWeO72EWUJQ1k,24840
 deezer/dates.py,sha256=BG8Aj6s0ctiQYmeKXowhNzb9--AeDxpWG82w3gA03NE,530
 deezer/exceptions.py,sha256=gsSYTKfKH8BbLJxptPEZC6yfr4baTQ9_kohIogc_HRo,1864
 deezer/pagination.py,sha256=OWLv_eUHQeLeROVPK9i7GmooUzEQ3nNuP2ID0kv8l9Q,3745
@@ -13,11 +13,11 @@ deezer/resources/genre.py,sha256=CDWyNyFT3fXQM7jPkz3UtGr8gNtVn9430h11Jl0ZwAc,135
 deezer/resources/playlist.py,sha256=8pAMmqUG4S9QLZOX5OrEoj4qA8pggDQBVxbG-DNxqgk,3325
 deezer/resources/podcast.py,sha256=lipRKhlFSXry97l_0xZJHfIxVeOh6VVdL9LhDIHyZbc,914
 deezer/resources/radio.py,sha256=moOdlSJABqCcluInvgbHSwIzSIhDvBQaVyDGdgeVr_0,805
-deezer/resources/resource.py,sha256=CL4Eli42IIHe6eHvm6YbgvK4wB8AagRZrvwVz0uqZHo,4006
+deezer/resources/resource.py,sha256=cuPXzvcXrsrHTj-UD3c5drhkjRwQ4Dkghik2icwDPGw,4826
 deezer/resources/track.py,sha256=e3DPTsYWq5yNCjMRQhGTrFQHfQUe3xn0mEVYbpL3O_0,1546
-deezer/resources/user.py,sha256=PCaD22lYY2Uqj_j-hnuNRcCRyyP2KZuqQlD--5NwFU0,2984
-deezer/utils.py,sha256=MBdLO5tCk0ahisdHstT5sq7VUHQ3dQAZRykAEzdmgPI,506
-deezer_python-5.11.1.dist-info/LICENSE.txt,sha256=lGqKEubFaPBoiJVRoHOxg1LYlte1e5kLoq6zWUSRQzQ,1054
-deezer_python-5.11.1.dist-info/METADATA,sha256=b0k0bEjhXzLRfMZ4dfkZrDvdXGLWbLvc7f3XjTBb6BM,14648
-deezer_python-5.11.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-deezer_python-5.11.1.dist-info/RECORD,,
+deezer/resources/user.py,sha256=6-46PX80xEgtCY2FecwzzgbvYu1aL1WShFXcCOaVGlU,6752
+deezer/utils.py,sha256=Z4QA5Ud5KPiGGv5buTdUidixmkEF9UhwCoYZiGXE-cE,583
+deezer_python-6.0.0.dist-info/LICENSE.txt,sha256=lGqKEubFaPBoiJVRoHOxg1LYlte1e5kLoq6zWUSRQzQ,1054
+deezer_python-6.0.0.dist-info/METADATA,sha256=EIaKci6RJMjIl4tG0-5vEvMxdWTB6wV626XZPM3Ao5o,14597
+deezer_python-6.0.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+deezer_python-6.0.0.dist-info/RECORD,,

{deezer_python-5.11.1.dist-info → deezer_python-6.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.2
+Generator: poetry-core 1.6.1
 Root-Is-Purelib: true
 Tag: py3-none-any