yutipy 2.2.15__py3-none-any.whl → 2.3.0__py3-none-any.whl

yutipy/__init__.py

@@ -5,6 +5,7 @@ from yutipy import (
     kkbox,
     lastfm,
     logger,
+    lrclib,
     musicyt,
     spotify,
     yutipy_music,
@@ -17,6 +18,7 @@ __all__ = [
     "kkbox",
     "lastfm",
     "logger",
+    "lrclib",
     "musicyt",
     "spotify",
     "yutipy_music",

yutipy/base_clients.py

@@ -384,6 +384,11 @@ class BaseAuthClient:
                 "refresh_token": self._refresh_token,
             }
 
+        if not data:
+            raise AuthenticationException(
+                "Either `authorization_code` or `refresh_token` must be provided to get access token."
+            )
+
         try:
             logger.info(
                 f"Authenticating with {self.SERVICE_NAME} API using Authorization Code grant type."
@@ -404,6 +409,17 @@ class BaseAuthClient:
 
     def _refresh_access_token(self):
         """Refreshes the token if it has expired."""
+        try:
+            self.load_token_after_init()
+        except NotImplementedError as e:
+            logger.warning(e)
+
+        if not self._access_token or not self._refresh_token:
+            logger.warning(
+                "No access token or refresh token found. You must authenticate to obtain a new token."
+            )
+            return
+
         try:
             if time() - self._token_requested_at >= self._token_expires_in:
                 token_info = self._get_access_token(refresh_token=self._refresh_token)

yutipy/deezer.py

@@ -9,6 +9,7 @@ from yutipy.exceptions import DeezerException, InvalidValueException
 from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
+from yutipy.lrclib import LrcLib
 
 
 class Deezer:
@@ -95,7 +96,7 @@ class Deezer:
                 return None
 
             try:
-                logger.debug(f"Parsing response JSON.")
+                logger.debug("Parsing response JSON.")
                 result = response.json()["data"]
             except (IndexError, KeyError, ValueError) as e:
                 logger.warning(f"Invalid response structure from Deezer: {e}")
@@ -159,7 +160,7 @@ class Deezer:
             return None
 
         try:
-            logger.debug(f"Parsing Response JSON.")
+            logger.debug("Parsing Response JSON.")
             result = response.json()
         except ValueError as e:
             logger.warning(f"Invalid response received from Deezer: {e}")
@@ -303,6 +304,13 @@ class Deezer:
             music_info.release_date = album_info.get("release_date")
             music_info.genre = album_info.get("genre")
 
+        with LrcLib() as lrc_lib:
+            lyrics = lrc_lib.get_lyrics(
+                artist=music_info.artists, song=music_info.title
+            )
+        if lyrics:
+            music_info.lyrics = lyrics.get("plainLyrics")
+
         return music_info
 
 

yutipy/itunes.py

@@ -10,6 +10,7 @@ from yutipy.exceptions import InvalidValueException, ItunesException
 from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, guess_album_type, is_valid_string, separate_artists
+from yutipy.lrclib import LrcLib
 
 
 class Itunes:
@@ -95,7 +96,7 @@ class Itunes:
                 return None
 
             try:
-                logger.debug(f"Parsing response JSON.")
+                logger.debug("Parsing response JSON.")
                 result = response.json()["results"]
             except (IndexError, KeyError, ValueError) as e:
                 logger.warning(f"Invalid response structure from iTunes: {e}")
@@ -151,7 +152,7 @@ class Itunes:
             release_date = self._format_release_date(result["releaseDate"])
             artists = separate_artists(result["artistName"])
 
-            return MusicInfo(
+            music_info = MusicInfo(
                 album_art=result["artworkUrl100"],
                 album_title=album_title,
                 album_type=album_type.lower(),
@@ -168,6 +169,14 @@ class Itunes:
                 url=result.get("trackViewUrl", result["collectionViewUrl"]),
             )
 
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=music_info.artists, song=music_info.title
+                )
+            if lyrics:
+                music_info.lyrics = lyrics.get("plainLyrics")
+
+            return music_info
         return None
 
     def _extract_album_info(self, result: dict) -> tuple:

yutipy/kkbox.py

@@ -13,6 +13,7 @@ from yutipy.exceptions import InvalidValueException, KKBoxException
 from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
+from yutipy.lrclib import LrcLib
 
 load_dotenv()
 
@@ -256,7 +257,7 @@ class KKBox(BaseClient):
         )
 
         if matching_artists:
-            return MusicInfo(
+            music_info = MusicInfo(
                 album_art=track.get("album", {}).get("images", [])[2]["url"],
                 album_title=track.get("album", {}).get("name"),
                 album_type=None,
@@ -273,6 +274,13 @@ class KKBox(BaseClient):
                 url=track.get("url"),
             )
 
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=music_info.artists, song=music_info.title
+                )
+            if lyrics:
+                music_info.lyrics = lyrics.get("plainLyrics")
+            return music_info
         return None
 
     def _find_album(self, song: str, artist: str, album: dict) -> Optional[MusicInfo]:

yutipy/lrclib.py

@@ -0,0 +1,168 @@
+__all__ = ["LrcLib"]
+
+from importlib.metadata import PackageNotFoundError, version
+from typing import Optional
+
+import requests
+
+from yutipy.exceptions import InvalidValueException
+from yutipy.logger import logger
+from yutipy.utils import are_strings_similar, is_valid_string
+
+
+class LrcLib:
+    """
+    A class to interact with the `LRCLIB <lrclib.net>`_ API for fetching lyrics.
+    """
+
+    def __init__(
+        self,
+        app_name: str = "yutipy",
+        app_version: str = None,
+        app_url: str = "https://github.com/CheapNightbot/yutipy",
+    ) -> None:
+        """Initializes the LrcLib with the API URL and application details.
+
+        Parameters
+        ----------
+        app_name : str
+            The name of the application.
+        app_version : str, optional
+            The version of the application.
+        app_url : str, optional
+            The URL of the application.
+
+        Notes
+        -----
+        These are used to set the User-Agent header for requests made to the API as suggested by the API documentation of `LRCLIB <lrclib.net>`_.
+        """
+        self.api_url = "https://lrclib.net/api"
+        self.app_name = app_name
+        self.app_url = app_url
+        if not app_version:
+            try:
+                self.app_version = f"v{version('yutipy')}"
+            except PackageNotFoundError:
+                self.app_version = "N/A"
+        else:
+            self.app_version = app_version
+
+        self._is_session_closed = False
+        self.__session = requests.Session()
+        self.__session.headers.update(
+            {"User-Agent": f"{self.app_name} {self.app_version} ({self.app_url})"}
+        )
+        self._translation_session = requests.Session()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.close_session()
+
+    def close_session(self):
+        """
+        Closes the session if it is not already closed.
+        """
+        if not self._is_session_closed:
+            self.__session.close()
+            self._translation_session.close()
+            self._is_session_closed = True
+
+    @property
+    def is_session_closed(self) -> bool:
+        return self._is_session_closed
+
+    def get_lyrics(
+        self,
+        artist: str,
+        song: str,
+        album: str = None,
+        normalize_non_english: bool = True,
+    ) -> Optional[dict]:
+        """
+        Fetches lyrics for a given artist and song.
+
+        Parameters
+        ----------
+        artist : str
+            The name of the artist.
+        song : str
+            The title of the song.
+        album : str, optional
+            The title of the album.
+        normalize_non_english : bool, optional
+            Whether to normalize non-English characters for comparison (default is True).
+
+        Returns
+        -------
+        Optional[dict]
+            The lyrics information if found, otherwise None.
+        """
+
+        if not is_valid_string(artist) or not is_valid_string(song):
+            raise InvalidValueException(
+                "Artist and song names must be valid strings and can't be empty."
+            )
+
+        endpoint = f"{self.api_url}/search"
+        query = f"?artist_name={artist}&track_name={song}"
+        query += f"&album_name={album}" if album else ""
+        query_url = endpoint + query
+
+        try:
+            logger.info(
+                f"Fetching lyrics for artist: {artist}, song: {song}, album: {album}"
+            )
+            response = self.__session.get(query_url, timeout=30)
+            logger.debug(f"Response status code: {response.status_code}")
+            response.raise_for_status()
+        except requests.RequestException as e:
+            logger.warning(f"Unexpected error while fetching lyrics: {e}")
+            return
+
+        results = response.json()
+
+        for result in results:
+            if are_strings_similar(
+                result.get("trackName"),
+                song,
+                use_translation=normalize_non_english,
+                translation_session=self._translation_session,
+            ) and are_strings_similar(
+                result.get("artistName"),
+                artist,
+                use_translation=normalize_non_english,
+                translation_session=self._translation_session,
+            ):
+                if album:
+                    if not are_strings_similar(
+                        result.get("albumName"),
+                        album,
+                        use_translation=normalize_non_english,
+                        translation_session=self._translation_session,
+                    ):
+                        continue
+                return result
+        return None
+
+
+if __name__ == "__main__":
+    import logging
+
+    from yutipy.logger import enable_logging
+
+    enable_logging(level=logging.DEBUG)
+
+    with LrcLib() as lyric_lib:
+        artist_name = input("Artist Name: ").strip()
+        song_title = input("Song Title: ").strip()
+        lyrics = lyric_lib.get_lyrics(artist_name, song_title)
+        print(f"\nLyrics for '{song_title}' by {artist_name}:\n{'-' * 40}\n")
+
+        if lyrics:
+            print(lyrics.get("plainLyrics"))
+        else:
+            print(
+                "It seems that the lyrics were not found! You might have to guess them..."
+            )

yutipy/musicyt.py

@@ -14,6 +14,7 @@ from yutipy.exceptions import (
 from yutipy.logger import logger
 from yutipy.models import MusicInfo
 from yutipy.utils.helpers import are_strings_similar, is_valid_string
+from yutipy.lrclib import LrcLib
 
 
 class MusicYT:
@@ -224,12 +225,13 @@ class MusicYT:
 
         try:
             lyrics = self.ytmusic.get_lyrics(lyrics_id.get("lyrics"))
+            lyrics = lyrics.get("lyrics")
         except exceptions.YTMusicUserError:
-            lyrics = {}
+            lyrics = None
 
         album_art = result.get("thumbnails", [{}])[-1].get("url", None)
 
-        return MusicInfo(
+        music_info = MusicInfo(
             album_art=album_art,
             album_title=None,
             album_type="single",
@@ -237,7 +239,7 @@ class MusicYT:
             genre=None,
             id=video_id,
             isrc=None,
-            lyrics=lyrics.get("lyrics"),
+            lyrics=lyrics,
             release_date=release_date,
             tempo=None,
             title=title,
@@ -246,6 +248,16 @@ class MusicYT:
             url=song_url,
         )
 
+        if not music_info.lyrics:
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=music_info.artists, song=music_info.title
+                )
+            if lyrics:
+                music_info.lyrics = lyrics.get("plainLyrics")
+
+        return music_info
+
     def _get_album(self, result: dict) -> MusicInfo:
         """
         Return album info as a `MusicInfo` object.

yutipy/spotify.py

@@ -22,6 +22,7 @@ from yutipy.utils.helpers import (
     is_valid_string,
     separate_artists,
 )
+from yutipy.lrclib import LrcLib
 
 load_dotenv()
 
@@ -135,7 +136,7 @@ class Spotify(BaseClient):
                 )
                 response.raise_for_status()
             except requests.RequestException as e:
-                logger.warning(f"Failed to search for music: {response.json()}")
+                logger.warning(f"Failed to search for music: {e}")
                 return None
 
             artist_ids = artist_ids if artist_ids else self._get_artists_ids(artist)
@@ -199,9 +200,7 @@ class Spotify(BaseClient):
             )
             response.raise_for_status()
         except requests.RequestException as e:
-            raise logger.warning(
-                f"Failed to search music with ISRC/UPC: {response.json()}"
-            )
+            raise logger.warning(f"Failed to search music with ISRC/UPC: {e}")
             return None
 
         artist_ids = self._get_artists_ids(artist)
@@ -328,7 +327,7 @@ class Spotify(BaseClient):
         ]
 
         if matching_artists:
-            return MusicInfo(
+            music_info = MusicInfo(
                 album_art=track["album"]["images"][0]["url"],
                 album_title=track["album"]["name"],
                 album_type=track["album"]["album_type"],
@@ -345,6 +344,13 @@ class Spotify(BaseClient):
                 url=track["external_urls"]["spotify"],
             )
 
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=music_info.artists, song=music_info.title
+                )
+            if lyrics:
+                music_info.lyrics = lyrics.get("plainLyrics")
+            return music_info
         return None
 
     def _find_album(
@@ -571,7 +577,7 @@ class SpotifyAuth(BaseAuthClient):
             )
             # Spotify returns timestamp in milliseconds, so convert milliseconds to seconds:
             timestamp = response_json.get("timestamp") / 1000.0
-            return UserPlaying(
+            user_playing = UserPlaying(
                 album_art=result.get("album", {}).get("images", [])[0].get("url"),
                 album_title=result.get("album", {}).get("name"),
                 album_type=(
@@ -594,6 +600,13 @@ class SpotifyAuth(BaseAuthClient):
                 url=result.get("external_urls", {}).get("spotify"),
             )
 
+            with LrcLib() as lrc_lib:
+                lyrics = lrc_lib.get_lyrics(
+                    artist=user_playing.artists, song=user_playing.title
+                )
+            if lyrics:
+                user_playing.lyrics = lyrics.get("plainLyrics")
+            return user_playing
         return None
 
 

yutipy/yutipy_music.py

@@ -23,10 +23,10 @@ class YutipyMusic:
     """
 
     def __init__(
-    self,
-    custom_kkbox_class = KKBox,
-    custom_spotify_class = Spotify,
-) -> None:
+        self,
+        custom_kkbox_class=KKBox,
+        custom_spotify_class=Spotify,
+    ) -> None:
         """
         Initializes the YutipyMusic class.
 
@@ -201,11 +201,13 @@ if __name__ == "__main__":
     import logging
     from yutipy.logger import enable_logging
 
+    from dataclasses import asdict
+
     enable_logging(level=logging.DEBUG)
     yutipy_music = YutipyMusic()
 
     artist_name = input("Artist Name: ")
     song_name = input("Song Name: ")
 
-    pprint(yutipy_music.search(artist_name, song_name))
+    pprint(asdict(yutipy_music.search(artist_name, song_name)))
     yutipy_music.close_sessions()

{yutipy-2.2.15.dist-info → yutipy-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.2.15
+Version: 2.3.0
 Summary: A simple Python package to interact with various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -57,6 +57,9 @@ Dynamic: license-file
 </a>
 </p>
 
+> **Looking for an easy-to-use API or GUI to search for music, instead of using the CLI or building your own integration?**
+> Check out [yutify](https://yutify.cheapnightbot.me) — it’s powered by yutipy!
+
 A _**simple**_ Python package to interact with various music platforms APIs.
 
 ## Table of Contents

yutipy-2.3.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+yutipy/__init__.py,sha256=DjHnnzikF6QIvCVqpelYUGQalYjovs6hSf6vbfPnEqM,320
+yutipy/base_clients.py,sha256=CLRCB69ZMdviluCfTU10bcwG8N3N1adpgWdYcSQonY4,22222
+yutipy/deezer.py,sha256=SYzC_XDOwub-pCtF_j_cgTveeHynAg71GtDwnRjQw6I,10726
+yutipy/exceptions.py,sha256=zz0XyyZr5xRcmRyw3hdTGaVRcwRn_RSYZdmwmuO0sEM,1379
+yutipy/itunes.py,sha256=vVPK-KeOVXLMI69lRxUN12iUpfKjDINLkXlH21UsvIs,7718
+yutipy/kkbox.py,sha256=IBEEkKh5nkmPSXB3sUnV1BWz53BBJWJUMvyu-o2knBw,11827
+yutipy/lastfm.py,sha256=hOFQOZdf51Gp2m02b4NjKRmQ9yQZ9Yas6MaM78c-oCg,5970
+yutipy/logger.py,sha256=GyLBlfQZ6pLNJ5MbyQSvcD_PkxmFdX41DPq5aeG1z68,1316
+yutipy/lrclib.py,sha256=RxB7g4L-4cikg8Wpjlj2UyC4L_Qhwb_vO_Et0XpqoOk,5329
+yutipy/models.py,sha256=45M-bNHusaAan_Ta_E9DyvsWujsT-ivbJqIfy2-i3R8,2343
+yutipy/musicyt.py,sha256=ApTddFWBMX6gnSY-WbEGHrEMk3AsCfNa7AtbVUuj1z0,9858
+yutipy/spotify.py,sha256=o4vSSrMzTK1Oe800vhFh1RLoylXOB-0DGV5QnhH5feM,23183
+yutipy/yutipy_music.py,sha256=uIN1zeu0aJGEOcQcfFQ88I2kkhFgK8gzrGmWeFPTWNY,7328
+yutipy/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+yutipy/cli/config.py,sha256=e5RIq6RxVxxzx30nKVMa06gwyQ258s7U0WA1xvJuR_0,4543
+yutipy/cli/search.py,sha256=8SQw0bjRzRqAg-FuVz9aWjB2KBZqmCf38SyKAQ3rx5E,3025
+yutipy/utils/__init__.py,sha256=AZaqvs6AJwnqwJuodbGnHu702WSUqc8plVC16SppOcU,239
+yutipy/utils/helpers.py,sha256=-iH0bx_sxW3Y3jjl6eTbY6QOBoG5t4obRcp7GGyw3ro,7476
+yutipy-2.3.0.dist-info/licenses/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
+yutipy-2.3.0.dist-info/METADATA,sha256=VLzLHljOSZ-XF61eVmUFyQml_DHNdy20WNJEVYV1BL8,6577
+yutipy-2.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+yutipy-2.3.0.dist-info/entry_points.txt,sha256=BrgmanaPjQqKQ3Ip76JLcsPgGANtrBSURf5CNIxl1HA,106
+yutipy-2.3.0.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
+yutipy-2.3.0.dist-info/RECORD,,

yutipy-2.2.15.dist-info/RECORD

@@ -1,23 +0,0 @@
-yutipy/__init__.py,sha256=Zrw3cr_6khXp1IgQdZxGcUM9A64GYgPs-6rlqSukW5Q,294
-yutipy/base_clients.py,sha256=FHCyCUQ-qE2Jo5JH-DZCxupoZTlb5ADs8XKDbHDVHwA,21687
-yutipy/deezer.py,sha256=ZI1C5gam8NiNznyyagn5r0Potpg25MXja8UXg-9i9ug,10463
-yutipy/exceptions.py,sha256=zz0XyyZr5xRcmRyw3hdTGaVRcwRn_RSYZdmwmuO0sEM,1379
-yutipy/itunes.py,sha256=dOkz7RqUCIaGggrNWOyxJebrv0f-mF1s9VOG2PVuFbY,7394
-yutipy/kkbox.py,sha256=Pfx-ZgAI9F1cbxjr7MCsMi-QulNt67t60L7y9lNmo5g,11503
-yutipy/lastfm.py,sha256=hOFQOZdf51Gp2m02b4NjKRmQ9yQZ9Yas6MaM78c-oCg,5970
-yutipy/logger.py,sha256=GyLBlfQZ6pLNJ5MbyQSvcD_PkxmFdX41DPq5aeG1z68,1316
-yutipy/models.py,sha256=45M-bNHusaAan_Ta_E9DyvsWujsT-ivbJqIfy2-i3R8,2343
-yutipy/musicyt.py,sha256=n3yaH9qyGlsW2HKPAmqYQNGzhuDH4s5Gh0R5v4JPoeg,9472
-yutipy/spotify.py,sha256=RQvzP62-bIXCLhMocRNFgst0xwDliFLYxU8nzdeWxRo,22616
-yutipy/yutipy_music.py,sha256=MNNh2WT-7GTAykAabLF6p4-0uXiIIbuogswmb-_QqtQ,7272
-yutipy/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yutipy/cli/config.py,sha256=e5RIq6RxVxxzx30nKVMa06gwyQ258s7U0WA1xvJuR_0,4543
-yutipy/cli/search.py,sha256=8SQw0bjRzRqAg-FuVz9aWjB2KBZqmCf38SyKAQ3rx5E,3025
-yutipy/utils/__init__.py,sha256=AZaqvs6AJwnqwJuodbGnHu702WSUqc8plVC16SppOcU,239
-yutipy/utils/helpers.py,sha256=-iH0bx_sxW3Y3jjl6eTbY6QOBoG5t4obRcp7GGyw3ro,7476
-yutipy-2.2.15.dist-info/licenses/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
-yutipy-2.2.15.dist-info/METADATA,sha256=jUEpFLxQnWbxKn4FVOFNF4hs2avjkoVRQhemNHNYl_4,6369
-yutipy-2.2.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-yutipy-2.2.15.dist-info/entry_points.txt,sha256=BrgmanaPjQqKQ3Ip76JLcsPgGANtrBSURf5CNIxl1HA,106
-yutipy-2.2.15.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
-yutipy-2.2.15.dist-info/RECORD,,