yutipy 2.1.1__py3-none-any.whl → 2.2.1__py3-none-any.whl

yutipy/__init__.py

@@ -3,6 +3,7 @@ from yutipy import (
     exceptions,
     itunes,
     kkbox,
+    lastfm,
     logger,
     musicyt,
     spotify,
@@ -14,6 +15,7 @@ __all__ = [
     "exceptions",
     "itunes",
     "kkbox",
+    "lastfm",
     "logger",
     "musicyt",
     "spotify",

yutipy/cli/config.py

@@ -1,5 +1,6 @@
 import os
 import webbrowser
+
 from dotenv import load_dotenv, set_key
 
 
@@ -12,45 +13,80 @@ def run_config_wizard():
     env_file = ".env"
     load_dotenv(env_file)
 
-    # List of required environment variables and their instructions
-    required_vars = {
-        "SPOTIFY_CLIENT_ID": {
-            "description": "Spotify Client ID",
-            "url": "https://developer.spotify.com/dashboard",
-            "instructions": """
+    # List of available services and their required environment variables
+    services = {
+        "Spotify": {
+            "SPOTIFY_CLIENT_ID": {
+                "description": "Spotify Client ID",
+                "url": "https://developer.spotify.com/dashboard",
+                "instructions": """
 1. Go to your Spotify Developer Dashboard: https://developer.spotify.com/dashboard
 2. Create a new app and fill in the required details.
 3. Copy the "Client ID" and "Client Secret" from the app's settings.
 4. Paste them here when prompted.
-            """,
-        },
-        "SPOTIFY_CLIENT_SECRET": {
-            "description": "Spotify Client Secret",
-            "url": "https://developer.spotify.com/dashboard",
-            "instructions": "See the steps above for Spotify Client ID.",
+                """,
+            },
+            "SPOTIFY_CLIENT_SECRET": {
+                "description": "Spotify Client Secret",
+                "url": "https://developer.spotify.com/dashboard",
+                "instructions": "See the steps above for Spotify Client ID.",
+            },
         },
-        "KKBOX_CLIENT_ID": {
-            "description": "KKBox Client ID",
-            "url": "https://developer.kkbox.com/",
-            "instructions": """
+        "KKBox": {
+            "KKBOX_CLIENT_ID": {
+                "description": "KKBox Client ID",
+                "url": "https://developer.kkbox.com/",
+                "instructions": """
 1. Go to the KKBOX Developer Portal: https://developer.kkbox.com/
 2. Log in and create a new application.
 3. Copy the "Client ID" and "Client Secret" from the app's settings.
 4. Paste them here when prompted.
-            """,
+                """,
+            },
+            "KKBOX_CLIENT_SECRET": {
+                "description": "KKBox Client Secret",
+                "url": "https://developer.kkbox.com/",
+                "instructions": "See the steps above for KKBox Client ID.",
+            },
         },
-        "KKBOX_CLIENT_SECRET": {
-            "description": "KKBox Client Secret",
-            "url": "https://developer.kkbox.com/",
-            "instructions": "See the steps above for KKBox Client ID.",
+        "Last.fm": {
+            "LASTFM_API_KEY": {
+                "description": "Last.fm API Key",
+                "url": "https://www.last.fm/api/account/create",
+                "instructions": """
+1. Go to the Last.fm API account creation page: https://www.last.fm/api/account/create
+2. Log in with your Last.fm account.
+3. Create a new application and fill in the required details.
+4. Copy the "API Key" from the application settings.
+5. Paste it here when prompted.
+                """,
+            },
         },
     }
 
+    # Display available services
+    print("Available services:")
+    for i, service in enumerate(services.keys(), start=1):
+        print(f"{i}. {service}")
+
+    # Prompt the user to select a service
+    choice = input("\nEnter the number of the service you want to configure: ").strip()
+    try:
+        service_name = list(services.keys())[int(choice) - 1]
+    except (IndexError, ValueError):
+        print("Invalid choice. Exiting configuration wizard.")
+        return
+
+    print(f"\nYou selected: {service_name}")
+
+    # Get the selected service's variables
+    selected_service = services[service_name]
+
     # Track whether the browser has already been opened for a service
     browser_opened = set()
 
-    # Prompt the user for each variable
-    for var, details in required_vars.items():
+    # Prompt the user for each variable in the selected service
+    for var, details in selected_service.items():
         current_value = os.getenv(var)
         if current_value:
             print(f"{details['description']} is already set.")

yutipy/exceptions.py

@@ -39,7 +39,11 @@ class ItunesException(YutipyException):
 
 
 class KKBoxException(YutipyException):
-    """Exception raised for erros related to the KKBOX Open API."""
+    """Exception raised for errors related to the KKBOX Open API."""
+
+
+class LastFmException(YutipyException):
+    """Exception raised for errors related to the LastFm API."""
 
 
 class MusicYTException(YutipyException):

yutipy/lastfm.py

@@ -0,0 +1,127 @@
+__all__ = ["LastFm", "LastFmException"]
+
+import os
+from dataclasses import asdict
+from pprint import pprint
+from typing import Optional
+
+import requests
+from dotenv import load_dotenv
+
+from yutipy.exceptions import LastFmException
+from yutipy.logger import logger
+from yutipy.models import UserPlaying
+from yutipy.utils.helpers import separate_artists
+
+load_dotenv()
+
+LASTFM_API_KEY = os.getenv("LASTFM_API_KEY")
+
+
+class LastFm:
+    """
+    A class to interact with the Last.fm API for fetching user music data.
+
+    This class reads the ``LASTFM_API_KEY`` from environment variables or the ``.env`` file by default.
+    Alternatively, you can manually provide this values when creating an object.
+    """
+
+    def __init__(self, api_key: str = None):
+        """
+        Initializes the LastFm class.
+
+        Args:
+            lastfm_api_key (str, optional): The Last.fm API key. If not provided,
+                it will be fetched from the environment variable `LASTFM_API_KEY`.
+
+        Parameters
+        ----------
+        lastfm_api_key : str, optional
+            The Lastfm API Key (<https://www.last.fm/api>). Defaults to ``LASTFM_API_KEY`` from environment variable or the ``.env`` file.
+
+        Raises:
+            LastFmException: If the API key is not provided or found in the environment.
+        """
+        self.api_key = api_key or LASTFM_API_KEY
+
+        if not self.api_key:
+            raise LastFmException(
+                "Lastfm API key was not found. Set it in environment variable or directly pass it when creating object."
+            )
+
+        self._is_session_closed = False
+
+        self.__api_url = "https://ws.audioscrobbler.com/2.0"
+        self.__session = requests.Session()
+
+    def __enter__(self):
+        """Enters the runtime context related to this object."""
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        """Exits the runtime context related to this object."""
+        self.close_session()
+
+    def close_session(self) -> None:
+        """Closes the current session(s)."""
+        if not self._is_session_closed:
+            self.__session.close()
+            self._is_session_closed = True
+
+    @property
+    def is_session_closed(self) -> bool:
+        """Checks if the session is closed."""
+        return self._is_session_closed
+
+    def get_currently_playing(self, username: str) -> Optional[UserPlaying]:
+        """
+        Fetches information about the currently playing or most recent track for a user.
+
+        Parameters
+        ----------
+        username : str
+            The Last.fm username to fetch data for.
+
+        Returns
+        -------
+        Optional[UserPlaying_]
+            An instance of the ``UserPlaying`` model containing details about the currently
+            playing track if available, or ``None`` if the request fails or no data is available.
+        """
+        query = f"?method=user.getrecenttracks&user={username}&limit=1&api_key={self.api_key}&format=json"
+        query_url = self.__api_url + query
+
+        try:
+            response = self.__session.get(query_url, timeout=30)
+            response.raise_for_status()
+        except requests.RequestException as e:
+            logger.error(f"Failed to fetch user profile: {e}")
+            return None
+
+        response_json = response.json()
+        result = response_json.get("recenttracks", {}).get("track", [])[0]
+        album_art = [
+            img.get("#text")
+            for img in result.get("image", [])
+            if img.get("size") == "extralarge"
+        ]
+        return UserPlaying(
+            album_art="".join(album_art),
+            album_title=result.get("album", {}).get("#text"),
+            artists=", ".join(separate_artists(result.get("artist", {}).get("#text"))),
+            id=result.get("mbid"),
+            title=result.get("name"),
+            url=result.get("url"),
+            is_playing=result.get("@attr", {}).get("nowplaying", False),
+        )
+
+
+if __name__ == "__main__":
+    with LastFm() as lastfm:
+        username = input("Enter Lasfm Username: ").strip()
+        result = lastfm.get_currently_playing(username=username, limit=5)
+
+        if result:
+            pprint(asdict(result))
+        else:
+            print("No result was found. Make sure the username is correct!")

yutipy/spotify.py

@@ -192,7 +192,7 @@ class Spotify:
             response_json["requested_at"] = time()
             return response_json
         else:
-            raise InvalidResponseException(
+            raise AuthenticationException(
                 f"Invalid response received: {response.json()}"
             )
 
@@ -814,6 +814,9 @@ class SpotifyAuth:
 
     def __refresh_access_token(self):
         """Refreshes the token if it has expired."""
+        if not self.__access_token:
+            raise SpotifyAuthException("No access token was found.")
+
         if time() - self.__token_requested_at >= self.__token_expires_in:
             token_info = self.__get_access_token(refresh_token=self.__refresh_token)
 
@@ -844,7 +847,7 @@ class SpotifyAuth:
         """
         return secrets.token_urlsafe(16)
 
-    def get_authorization_url(self, state: str = None):
+    def get_authorization_url(self, state: str = None, show_dialog: bool = False):
         """
         Constructs the Spotify authorization URL for user authentication.
 
@@ -858,6 +861,11 @@ class SpotifyAuth:
             If not provided, no state parameter is included.
 
             You may use :meth:`SpotifyAuth.generate_state` method to generate one.
+        show_dialog : bool, optional
+            Whether or not to force the user to approve the app again if they’ve already done so.
+            If ``False`` (default), a user who has already approved the application may be automatically
+            redirected to the URI specified by redirect_uri. If ``True``, the user will not be automatically
+            redirected and will have to approve the app again.
 
         Returns
         -------
@@ -869,6 +877,7 @@ class SpotifyAuth:
             "response_type": "code",
             "client_id": self.client_id,
             "redirect_uri": self.redirect_uri,
+            "show_dialog": show_dialog,
         }
 
         if self.scope:
@@ -1012,7 +1021,14 @@ class SpotifyAuth:
         dict
             A dictionary containing the user's display name and profile images.
         """
-        self.__refresh_access_token()
+        try:
+            self.__refresh_access_token()
+        except SpotifyAuthException:
+            logger.warning(
+                "No access token was found. You may authenticate the user again."
+            )
+            return None
+
         query_url = self.__api_url
         header = self.__authorization_header()
 
@@ -1054,7 +1070,14 @@ class SpotifyAuth:
         - If the API response does not contain the expected data, the method will return `None`.
 
         """
-        self.__refresh_access_token()
+        try:
+            self.__refresh_access_token()
+        except SpotifyAuthException:
+            logger.warning(
+                "No access token was found. You may authenticate the user again."
+            )
+            return None
+
         query_url = f"{self.__api_url}/player/currently-playing"
         header = self.__authorization_header()
 
@@ -1064,8 +1087,16 @@ class SpotifyAuth:
         except requests.RequestException as e:
             raise NetworkException(f"Network error occurred: {e}")
 
+        if response.status_code == 204:
+            logger.info("Requested user is currently not listening to any music.")
+            return None
         if response.status_code != 200:
-            logger.error(f"Unexpected response: {response.json()}")
+            try:
+                logger.error(f"Unexpected response: {response.json()}")
+            except requests.exceptions.JSONDecodeError:
+                logger.error(
+                    f"Response Code: {response.status_code}, Reason: {response.reason}"
+                )
             return None
 
         response_json = response.json()
@@ -1099,6 +1130,8 @@ class SpotifyAuth:
                 url=result.get("external_urls", {}).get("spotify"),
             )
 
+        return None
+
 
 if __name__ == "__main__":
     import logging

{yutipy-2.1.1.dist-info → yutipy-2.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.1.1
+Version: 2.2.1
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -90,6 +90,7 @@ Feel free to request any music platform you would like me to add by opening an i
 - `Deezer`: https://www.deezer.com
 - `iTunes`: https://music.apple.com
 - `KKBOX`: https://www.kkbox.com
+- `Lastfm`: https://last.fm
 - `Spotify`: https://spotify.com
 - `YouTube Music`: https://music.youtube.com
 

{yutipy-2.1.1.dist-info → yutipy-2.2.1.dist-info}/RECORD

@@ -1,21 +1,22 @@
-yutipy/__init__.py,sha256=eURfdAFBvA9xF6cuUJUMWLf44LHxRQuXONfIPD-CkIQ,268
+yutipy/__init__.py,sha256=Zrw3cr_6khXp1IgQdZxGcUM9A64GYgPs-6rlqSukW5Q,294
 yutipy/deezer.py,sha256=PTTTfeORh1HZ_ta7_Uu4YARouSknUnAxO9AQJPFm4v0,11402
-yutipy/exceptions.py,sha256=fur945x1Ibu7yeIPDRsOcujfVRRa5JHQw27dsOUreK4,1393
+yutipy/exceptions.py,sha256=oMuhNfDJ2AFsM_fJn6sayxMqIJRY_ihHRmL0U2IK6qQ,1501
 yutipy/itunes.py,sha256=fV7KLsXWvfM_97KwVwn_KfnWM7j0cVGE7RytvnDGlZM,7929
 yutipy/kkbox.py,sha256=MuYpR_UTZQxeitn2rc0UUgiMVikIXcVWmns3eSVjd_g,18847
+yutipy/lastfm.py,sha256=0adVGigS8Kqnu52k-ry5eqHR6koktgKBhCNI1riUMfk,4302
 yutipy/logger.py,sha256=cHCjpDslVsBOnp7jluqrOOi4ekDIggPhbSfqHeIfT-U,1263
 yutipy/models.py,sha256=_92e54uXXCw53oWZiNLBBai6C0InOZMJL7r8GJ5smbM,2215
 yutipy/musicyt.py,sha256=6Vz8bI8hDNFoDKRh6GK90dGMRbn_d5d6eGPsaYogb_Y,9315
-yutipy/spotify.py,sha256=m9GV3xZ94jRKtajMo34BARuR4l2gP6sUfZ8CKsJQDWo,42135
+yutipy/spotify.py,sha256=mHa5C6LTzfWOb_6LJhGm_HX7yvWcY0q7acUfU_ofw4A,43508
 yutipy/yutipy_music.py,sha256=cHJ95HxGILweVrnEacj8tTlU0NPxMpuDVMpngdX0mZQ,6558
 yutipy/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yutipy/cli/config.py,sha256=6p69ZlT3ebUH5wzhd0iisLYKOnYX6xTSzoyrdBwGNo0,3230
+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=W3g9iqoSygcFFCKCp2sk0NQrZOEG26wI2XuNi9pgAXE,5207
-yutipy-2.1.1.dist-info/licenses/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
-yutipy-2.1.1.dist-info/METADATA,sha256=86Xbqgk9pHIiGIQkZAMzaOKkUu4vmo8sadsoH1hAlQ8,6494
-yutipy-2.1.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-yutipy-2.1.1.dist-info/entry_points.txt,sha256=BrgmanaPjQqKQ3Ip76JLcsPgGANtrBSURf5CNIxl1HA,106
-yutipy-2.1.1.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
-yutipy-2.1.1.dist-info/RECORD,,
+yutipy-2.2.1.dist-info/licenses/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
+yutipy-2.2.1.dist-info/METADATA,sha256=sVaTUKYsKzgOyN8I3LLkHzUIWIGGln3FjfnTARrzdX8,6522
+yutipy-2.2.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+yutipy-2.2.1.dist-info/entry_points.txt,sha256=BrgmanaPjQqKQ3Ip76JLcsPgGANtrBSURf5CNIxl1HA,106
+yutipy-2.2.1.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
+yutipy-2.2.1.dist-info/RECORD,,