yutipy 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

yutipy/__init__.py

@@ -2,12 +2,12 @@ from .deezer import Deezer
 from .itunes import Itunes
 from .models import MusicInfo
 from .musicyt import MusicYT
-from .spotify import Spotipy
+from .spotify import Spotify
 
 __all__ = [
     "Deezer",
     "Itunes",
     "MusicInfo",
     "MusicYT",
-    "Spotipy",
+    "Spotify",
 ]

yutipy/deezer.py

@@ -30,7 +30,7 @@ class Deezer:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -54,7 +54,7 @@ class Deezer:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -104,13 +104,12 @@ class Deezer:
         Optional[Dict]
             A dictionary containing UPC and ISRC information.
         """
-        match music_type:
-            case "track":
-                return self._get_track_info(music_id)
-            case "album":
-                return self._get_album_info(music_id)
-            case _:
-                raise DeezerException(f"Invalid music type: {music_type}")
+        if music_type == "track":
+            return self._get_track_info(music_id)
+        elif music_type == "album":
+            return self._get_album_info(music_id)
+        else:
+            raise DeezerException(f"Invalid music type: {music_type}")
 
     def _get_track_info(self, music_id: int) -> Optional[Dict]:
         """

yutipy/itunes.py

@@ -31,7 +31,7 @@ class Itunes:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -55,7 +55,7 @@ class Itunes:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):

yutipy/musicyt.py

@@ -33,7 +33,7 @@ class MusicYT:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):

yutipy/spotify.py

@@ -2,7 +2,7 @@ import base64
 import os
 import time
 from pprint import pprint
-from typing import Optional
+from typing import Optional, Union
 
 import requests
 from dotenv import load_dotenv
@@ -27,11 +27,11 @@ CLIENT_ID = os.getenv("CLIENT_ID")
 CLIENT_SECRET = os.getenv("CLIENT_SECRET")
 
 
-class Spotipy:
+class Spotify:
     """
     A class to interact with the Spotify API.
 
-    This class reads the CLIENT_ID and CLIENT_SECRET from the .env file by default.
+    This class reads the ``CLIENT_ID`` and ``CLIENT_SECRET`` from environment variables or the ``.env`` file by default.
     Alternatively, users can manually provide these values when creating an object.
     """
 
@@ -39,7 +39,7 @@ class Spotipy:
         self, client_id: str = CLIENT_ID, client_secret: str = CLIENT_SECRET
     ) -> None:
         """
-        Initializes the Spotipy class and sets up the session.
+        Initializes the Spotify class and sets up the session.
 
         Parameters
         ----------
@@ -69,7 +69,7 @@ class Spotipy:
         """Exits the runtime context related to this object."""
         self._close_session()
 
-    def _close_session(self) -> None:
+    def close_session(self) -> None:
         """Closes the current session."""
         if not self.is_session_closed:
             self._session.close()
@@ -147,7 +147,7 @@ class Spotipy:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -192,7 +192,7 @@ class Spotipy:
 
         Returns
         -------
-        Optional[MusicInfo]
+        Optional[MusicInfo_]
             The music information if found, otherwise None.
         """
         if not is_valid_string(artist) or not is_valid_string(song):
@@ -224,7 +224,7 @@ class Spotipy:
         artist_ids = self._get_artists_ids(artist)
         return self._find_music_info(artist, song, response.json(), artist_ids)
 
-    def _get_artists_ids(self, artist: str) -> list | None:
+    def _get_artists_ids(self, artist: str) -> Union[list, None]:
         """
         Retrieves the IDs of the artists.
 
@@ -235,7 +235,7 @@ class Spotipy:
 
         Returns
         -------
-        list | None
+        Union[list, None]
             A list of artist IDs or None if not found.
         """
         artist_ids = []
@@ -403,11 +403,11 @@ class Spotipy:
 
 
 if __name__ == "__main__":
-    spotipy = Spotipy(CLIENT_ID, CLIENT_SECRET)
+    Spotify = Spotify(CLIENT_ID, CLIENT_SECRET)
 
     try:
         artist_name = input("Artist Name: ")
         song_name = input("Song Name: ")
-        pprint(spotipy.search(artist_name, song_name))
+        pprint(Spotify.search(artist_name, song_name))
     finally:
-        spotipy._close_session()
+        Spotify._close_session()

{yutipy-0.1.0.dist-info → yutipy-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yutipy
-Version: 0.1.0
+Version: 0.1.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>
@@ -53,13 +53,34 @@ Requires-Dist: rapidfuzz==3.12.1
 Requires-Dist: requests==2.32.3
 Requires-Dist: ytmusicapi==1.10.1
 Provides-Extra: dev
-Requires-Dist: pytest==8.3.4; extra == "dev"
-Requires-Dist: Sphinx==8.2.0; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />
 </p>
 
+<p align="center">
+<a href="https://github.com/CheapNightbot/yutipy/actions/workflows/tests.yml">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cheapnightbot/yutipy/pytest-unit-testing.yml?style=for-the-badge&label=Pytest">
+</a>
+    
+<a href="https://pypi.org/project/yutipy/">
+<img src="https://img.shields.io/pypi/v/yutipy?style=for-the-badge" alt="PyPI" />
+</a>
+<a href="https://yutipy.readthedocs.io/en/latest/">
+<img src="https://img.shields.io/readthedocs/yutipy?style=for-the-badge" alt="Documentation Status" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/blob/master/LICENSE">
+<img src="https://img.shields.io/github/license/CheapNightbot/yutipy?style=for-the-badge" alt="License" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/stargazers">
+<img src="https://img.shields.io/github/stars/CheapNightbot/yutipy?style=for-the-badge" alt="Stars" />
+</a>
+<a href="https://github.com/CheapNightbot/yutipy/issues">
+<img src="https://img.shields.io/github/issues/CheapNightbot/yutipy?style=for-the-badge" alt="Issues" />
+</a>
+</p>
+
 A _**simple**_ Python package for searching and retrieving music information from various music platforms APIs, including Deezer, iTunes, Spotify, and YouTube Music.
 
 ## Table of Contents
@@ -98,7 +119,7 @@ with Deezer() as deezer:
     print(result)
 ```
 
-For more usage examples, see the [docs](#).
+For more usage examples, see the [Usage Examples](https://yutipy.readthedocs.io/en/latest/usage_examples.html) page in docs.
 
 ## Contributing
 

yutipy-0.1.1.dist-info/RECORD

@@ -0,0 +1,23 @@
+yutipy/__init__.py,sha256=t0w-pRLjIGD3UtDyd-JpeL-RrMona7YTV_0lZCpGLEc,232
+yutipy/deezer.py,sha256=TbPk6f1ytrtk9GHXOoRZ948fcgOi0619-rQC9xfTYu0,8641
+yutipy/exceptions.py,sha256=QDfOkaeZtSNg1lhXZ872yNJwbof68eVHDezZeZh8DiU,1029
+yutipy/itunes.py,sha256=NhrllA3U0PUY3dNoMyiG1oZuyvdMQKYRBHzYSkt8ikM,5843
+yutipy/models.py,sha256=-UEi05on5XsKjFSqUNt1yZnLod_A9upqh2nIPWTtEEI,1415
+yutipy/musicyt.py,sha256=kvRYuhlNVuvy-WahJq895T3JAzmGTTiKB89r_uTMTAI,7155
+yutipy/spotify.py,sha256=YYTF1git7mRVFWWGM1TILIIyZMPPDbD_F_BLjfqU6cI,12906
+yutipy/__pycache__/__init__.cpython-312.pyc,sha256=q-CaghM107NTOH0ZfH9LKDDUZJuGA_teF1QyoO1wNb8,392
+yutipy/__pycache__/deezer.cpython-312.pyc,sha256=UfRxyBobsocMxkpF4HP06EpFsAz96ZHU4QlYn8EzQcY,10588
+yutipy/__pycache__/exceptions.cpython-312.pyc,sha256=Zc73Tr79emWJ9pmpAVoL12YnBBOWJulV1hxtSso4hy8,2096
+yutipy/__pycache__/itunes.cpython-312.pyc,sha256=59fJpxL2ZjQoyzq_1U6sesJEuNrfa62kvtPYeSwzZNg,7521
+yutipy/__pycache__/models.cpython-312.pyc,sha256=KJUa3-C67TMq1EAGuQlZYT99JS1AEDUi74KY8bEHkkg,1848
+yutipy/__pycache__/musicyt.cpython-312.pyc,sha256=y508WR8Cl8DtisJli3FwNDEC6CJZajiZdcWJLN7xXyY,9176
+yutipy/__pycache__/spotify.cpython-312.pyc,sha256=0Knor0AN6zG6ATYSGL0YPb6b7rrT2krnpBv-e2ynam8,15870
+yutipy/utils/__init__.py,sha256=7UFcFZ7fBtNXOTngjnRD3MeobT3x5UT2Gag94TXVgLk,169
+yutipy/utils/cheap_utils.py,sha256=LIuEHib_97NuLahXxdHJUD9v-ccXNUc3NrLYk8EQ52A,1652
+yutipy/utils/__pycache__/__init__.cpython-312.pyc,sha256=_ldEMv66ELlrY1M7fN_2r5XySvgAsqTE0U8ASGXx8bs,286
+yutipy/utils/__pycache__/cheap_utils.cpython-312.pyc,sha256=i6nRmXcRtCkTzKQ1mWyjN7Xz4NapqgBdXA33so8xgLU,2376
+yutipy-0.1.1.dist-info/LICENSE,sha256=Tymbhvk1F_6BDFE0X8BBiQp7cBCjbzKfRAITmvxJIyA,1092
+yutipy-0.1.1.dist-info/METADATA,sha256=nWGLHD2t-1GvvU9vUXcU5TtvLe05_w2G0U8pKhWw_Uc,5865
+yutipy-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+yutipy-0.1.1.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
+yutipy-0.1.1.dist-info/RECORD,,

yutipy-0.1.0.dist-info/RECORD

@@ -1,23 +0,0 @@
-yutipy/__init__.py,sha256=GKMg-aksc_2IAjcKAogGCe_aeSstuwAexjVdJRPS0mE,232
-yutipy/deezer.py,sha256=h2ZeOyzS0L0--qmowkNsFXUl0Nbk30x447bapTV10Io,8667
-yutipy/exceptions.py,sha256=QDfOkaeZtSNg1lhXZ872yNJwbof68eVHDezZeZh8DiU,1029
-yutipy/itunes.py,sha256=NiRGCgV5EASjkS_FPhzDwOq8oge-AeDwkVK4JHNy698,5843
-yutipy/models.py,sha256=-UEi05on5XsKjFSqUNt1yZnLod_A9upqh2nIPWTtEEI,1415
-yutipy/musicyt.py,sha256=fVhCFZUgv34CjyDRMIBeLNYsEuTgENxyMlGUt9Uf1JA,7154
-yutipy/spotify.py,sha256=X8-jDFj8U5kY4zeuGoZ-hrgDbzbKKww47vpVvJev1rA,12849
-yutipy/__pycache__/__init__.cpython-312.pyc,sha256=hnQz69yUeXB3mK1j0EiIsKfFRm1ywiQF170VggBhjdc,392
-yutipy/__pycache__/deezer.cpython-312.pyc,sha256=w5LdiOePHf0NLLDQfj__FxsuplJ4dN5JLnCAK0MXD9I,10578
-yutipy/__pycache__/exceptions.cpython-312.pyc,sha256=Zc73Tr79emWJ9pmpAVoL12YnBBOWJulV1hxtSso4hy8,2096
-yutipy/__pycache__/itunes.cpython-312.pyc,sha256=PvXlgEp6uWzAR_VlPYP-bmQQPmkURz2237AOgFiD5o4,7511
-yutipy/__pycache__/models.cpython-312.pyc,sha256=KJUa3-C67TMq1EAGuQlZYT99JS1AEDUi74KY8bEHkkg,1848
-yutipy/__pycache__/musicyt.cpython-312.pyc,sha256=494-Q64MEXVwsRSZycCCp6T-h37y0RAARnv_OA2QZ-0,9175
-yutipy/__pycache__/spotify.cpython-312.pyc,sha256=P5UXhd8g0h9EaxfPaPyQUeIIHHqLmQCcAXfJcTTKzsI,15789
-yutipy/utils/__init__.py,sha256=7UFcFZ7fBtNXOTngjnRD3MeobT3x5UT2Gag94TXVgLk,169
-yutipy/utils/cheap_utils.py,sha256=LIuEHib_97NuLahXxdHJUD9v-ccXNUc3NrLYk8EQ52A,1652
-yutipy/utils/__pycache__/__init__.cpython-312.pyc,sha256=_ldEMv66ELlrY1M7fN_2r5XySvgAsqTE0U8ASGXx8bs,286
-yutipy/utils/__pycache__/cheap_utils.cpython-312.pyc,sha256=i6nRmXcRtCkTzKQ1mWyjN7Xz4NapqgBdXA33so8xgLU,2376
-yutipy-0.1.0.dist-info/LICENSE,sha256=Tymbhvk1F_6BDFE0X8BBiQp7cBCjbzKfRAITmvxJIyA,1092
-yutipy-0.1.0.dist-info/METADATA,sha256=krlRAHqZqAowrWiRymP1L5pyC5IgHht8BVpQTz01qMs,4708
-yutipy-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-yutipy-0.1.0.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
-yutipy-0.1.0.dist-info/RECORD,,