yutipy 2.3.6__tar.gz → 2.4.0__tar.gz

{yutipy-2.3.6 → yutipy-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.3.6
+Version: 2.4.0
 Summary: A simple Python package to interact with various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -92,6 +92,7 @@ Feel free to request any music platform you would like me to add by opening an i
 - `iTunes`: https://music.apple.com
 - `KKBOX`: https://www.kkbox.com
 - `Lastfm`: https://last.fm
+- `ListenBrainz`: https://listenbrainz.org
 - `Spotify`: https://spotify.com
 - `YouTube Music`: https://music.youtube.com
 

{yutipy-2.3.6 → yutipy-2.4.0}/README.md

@@ -58,6 +58,7 @@ Feel free to request any music platform you would like me to add by opening an i
 - `iTunes`: https://music.apple.com
 - `KKBOX`: https://www.kkbox.com
 - `Lastfm`: https://last.fm
+- `ListenBrainz`: https://listenbrainz.org
 - `Spotify`: https://spotify.com
 - `YouTube Music`: https://music.youtube.com
 

{yutipy-2.3.6 → yutipy-2.4.0}/docs/api_reference.rst

@@ -41,6 +41,15 @@ Lastfm
     :noindex:
     :exclude-members: is_session_closed
 
+ListenBrainz
+------------
+
+.. autoclass:: yutipy.listenbrainz.ListenBrainz
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: is_session_closed
+
 LRCLIB
 ------
 

{yutipy-2.3.6 → yutipy-2.4.0}/docs/available_platforms.rst

@@ -10,5 +10,6 @@ Feel free to request any music platform you would like me to add by opening an i
 - ``iTunes``: https://music.apple.com
 - ``KKBOX``: https://www.kkbox.com
 - ``Lastfm``: https://last.fm
+- ``ListenBrainz``: https://listenbrainz.org
 - ``Spotify``: https://spotify.com
 - ``YouTube Music``: https://music.youtube.com

{yutipy-2.3.6 → yutipy-2.4.0}/docs/usage_examples.rst

@@ -102,6 +102,19 @@ Alternatively, you can manually provide these values when creating an object of
         result = lastfm.get_currently_playing(username="username")
         print(result)
 
+ListenBrainz
+------------
+
+.. code-block:: python
+
+    from dataclasses import asdict
+    from yutipy.listenbrainz import ListenBrainz
+
+    with ListenBrainz() as listenbrainz:
+        result = listenbrainz.get_currently_playing(username="username")
+        if result:
+            print(asdict(result))
+
 Spotify
 -------
 

yutipy-2.4.0/tests/test_listenbrainz.py

@@ -0,0 +1,103 @@
+import pytest
+
+from yutipy.listenbrainz import ListenBrainz
+from tests import BaseResponse
+
+
+@pytest.fixture
+def listenbrainz():
+    return ListenBrainz()
+
+
+class MockResponseUsers(BaseResponse):
+    @staticmethod
+    def json():
+        return {
+            "users": [
+                {"user_name": "test4test"},
+                {"user_name": "lb_test"},
+                {"user_name": "lb-test"},
+                {"user_name": "muz-test"},
+                {"user_name": "tes--"},
+                {"user_name": "lb_test_1"},
+                {"user_name": "suvid_test"},
+                {"user_name": "testins"},
+                {"user_name": "hemang-test"},
+                {"user_name": "Test4585"},
+            ]
+        }
+
+
+class MockResponseActivity(BaseResponse):
+    @staticmethod
+    def json():
+        return {
+            "payload": {
+                "count": 1,
+                "listens": [
+                    {
+                        "playing_now": True,
+                        "track_metadata": {
+                            "additional_info": {
+                                "duration": 269,
+                                "media_player": "Some Music Player",
+                                "origin_url": "https://music.youtube.com/watch?v=lYBUbBu4W08",
+                                "submission_client": "Some Scrobbler Plugin",
+                            },
+                            "artist_name": "Artist",
+                            "track_name": "Song",
+                        },
+                    }
+                ],
+                "playing_now": True,
+                "user_id": "Username",
+            }
+        }
+
+
+@pytest.fixture
+def mock_response_users(listenbrainz, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return MockResponseUsers()
+
+    monkeypatch.setattr(listenbrainz._ListenBrainz__session, "get", mock_get)
+
+
+@pytest.fixture
+def mock_response_activity(listenbrainz, monkeypatch):
+    def mock_get(*args, **kwargs):
+        return MockResponseActivity()
+
+    monkeypatch.setattr(listenbrainz._ListenBrainz__session, "get", mock_get)
+
+
+def test_find_user(listenbrainz, mock_response_users):
+    username = "Test4585"
+    user_name = listenbrainz.find_user(username=username)
+    assert user_name is not None
+    assert username == user_name
+
+    username = "potato"
+    user_name = listenbrainz.find_user(username=username)
+    assert user_name is None
+
+
+def test_find_user_case_insensitive(listenbrainz, mock_response_users):
+    username = "muz-TEST"
+    user_name = listenbrainz.find_user(username=username)
+    assert user_name is not None
+    assert username.lower() == user_name.lower()
+
+
+def test_get_currently_playing(listenbrainz, mock_response_activity):
+    username = "Username"
+    activity = listenbrainz.get_currently_playing(username)
+    assert activity.is_playing is True
+    assert activity.title
+    assert activity.artists
+    assert activity.url
+
+def test_get_currently_playing_no_user(listenbrainz, mock_response_activity):
+    username = "Bob"
+    activity = listenbrainz.get_currently_playing(username)
+    assert activity is None

{yutipy-2.3.6 → yutipy-2.4.0}/yutipy/lastfm.py

@@ -71,6 +71,11 @@ class LastFm:
         """
         Fetches the user profile information for the provided username.
 
+        Parameters
+        ----------
+        username : str
+            The Last.fm username to fetch profile information for.
+
         Returns
         -------
         dict
@@ -109,7 +114,7 @@ class LastFm:
 
     def get_currently_playing(self, username: str) -> Optional[UserPlaying]:
         """
-        Fetches information about the currently playing or most recent track for a user.
+        Fetches information about the currently playing track for a user.
 
         Parameters
         ----------

yutipy-2.4.0/yutipy/listenbrainz.py

@@ -0,0 +1,141 @@
+__all__ = ["ListenBrainz"]
+
+from typing import Optional
+from time import time
+
+import requests
+
+from yutipy.logger import logger
+from yutipy.models import UserPlaying
+from yutipy.utils.helpers import are_strings_similar
+
+
+class ListenBrainz:
+    """A class to interact with the ListenBrainz API for fetching user music data."""
+
+    def __init__(self):
+        self._is_session_closed = False
+        self.__api_url = "https://api.listenbrainz.org"
+        self.__session = requests.Session()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self.close_session()
+
+    def close_session(self):
+        """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 find_user(self, username: str) -> Optional[str]:
+        """
+        Whether profile with the provided username exists on the ListenBrainz.
+
+        It searches ListenBrainz for the provided username and fuzzy matches
+        the provided username with the username(s) returned from ListenBrainz API.
+
+        Parameters
+        ----------
+        username : str
+            The username to search.
+
+        Returns
+        -------
+        Optional[str]
+            The username returned by ListenBrainz API if user found,
+            or ``None`` if the user with provided username does not exist.
+        """
+        endpoint = "/1/search/users/"
+        url = self.__api_url + endpoint
+
+        try:
+            response = self.__session.get(
+                url=url, params={"search_term": username}, timeout=30
+            )
+            response.raise_for_status()
+        except requests.RequestException as e:
+            logger.warning(f"Failed to search for the user: {e}")
+            return
+
+        response_json = response.json()
+        users = response_json.get("users")
+
+        if not users:
+            return
+
+        for user in users:
+            user_name = user.get("user_name")
+            if are_strings_similar(
+                username, user_name, threshold=100, use_translation=False
+            ):
+                return user_name
+
+    def get_currently_playing(self, username: str) -> Optional[UserPlaying]:
+        """
+        Fetches information about the currently playing track for a user.
+
+        Parameters
+        ----------
+        username : str
+            The ListenBrainz 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.
+        """
+        endpoint = f"/1/user/{username}/playing-now"
+        url = self.__api_url + endpoint
+
+        try:
+            response = self.__session.get(url=url, timeout=30)
+            response.raise_for_status()
+        except requests.RequestException as e:
+            logger.warning(f"Failed to retrieve listening activity: {e}")
+            return
+
+        response_json = response.json()
+        if not response_json:
+            logger.info(
+                f"It seems no activity found for `{username}`. Might be user does not exist or not no data available."
+            )
+            return
+
+        result = response_json.get("payload", {})
+        is_playing = result.get("playing_now", False)
+        user_id = result.get("user_id", "")
+
+        if username.lower() != user_id.lower():
+            return
+
+        if result and is_playing:
+            track_metadata = result.get("listens", [{}])[0].get("track_metadata", {})
+            return UserPlaying(
+                artists=track_metadata.get("artist_name"),
+                id=None,
+                timestamp=time(),
+                title=track_metadata.get("track_name"),
+                url=track_metadata.get("additional_info", {}).get("origin_url"),
+                is_playing=is_playing,
+            )
+        return None
+
+
+if __name__ == "__main__":
+    with ListenBrainz() as listenbrainz:
+        username = input("Enter ListenBrainz Username: ").strip()
+        result = listenbrainz.find_user(username)
+
+        if result:
+            print(f"User found with username: {result}")
+        else:
+            print(f"No user with username '{username}' found!")

{yutipy-2.3.6 → yutipy-2.4.0}/yutipy/utils/helpers.py

@@ -76,7 +76,7 @@ def are_strings_similar(
     Args:
         str1 (str): First string to compare.
         str2 (str): Second string to compare.
-        threshold (int, optional): Similarity threshold. Defaults to 80.
+        threshold (int, optional): Similarity threshold. Defaults to 95.
         use_translation (bool, optional): Use translations to compare strings. Defaults to ``True``
         translation_session (requests.Session, optional): A `requests.Session` object to use for making the API request. If not provided, a new session will be created and closed within the function.
             Providing your own session can improve performance by reusing the same session for multiple requests. Don't forget to close the session afterwards.

{yutipy-2.3.6 → yutipy-2.4.0}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yutipy
-Version: 2.3.6
+Version: 2.4.0
 Summary: A simple Python package to interact with various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>
@@ -92,6 +92,7 @@ Feel free to request any music platform you would like me to add by opening an i
 - `iTunes`: https://music.apple.com
 - `KKBOX`: https://www.kkbox.com
 - `Lastfm`: https://last.fm
+- `ListenBrainz`: https://listenbrainz.org
 - `Spotify`: https://spotify.com
 - `YouTube Music`: https://music.youtube.com
 

{yutipy-2.3.6 → yutipy-2.4.0}/yutipy.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ tests/test_deezer.py
 tests/test_itunes.py
 tests/test_kkbox.py
 tests/test_lastfm.py
+tests/test_listenbrainz.py
 tests/test_lrclib.py
 tests/test_models.py
 tests/test_musicyt.py
@@ -43,6 +44,7 @@ yutipy/exceptions.py
 yutipy/itunes.py
 yutipy/kkbox.py
 yutipy/lastfm.py
+yutipy/listenbrainz.py
 yutipy/logger.py
 yutipy/lrclib.py
 yutipy/models.py