yutipy 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

yutipy/kkbox.py

@@ -56,6 +56,7 @@ class KKBox:
         self.__header, self.__expires_in = self.__authenticate()
         self.__start_time = time.time()
         self._is_session_closed = False
+        self.valid_territories = ["HK", "JP", "MY", "SG", "TW"]
 
     def __enter__(self):
         """Enters the runtime context related to this object."""
@@ -174,6 +175,58 @@ class KKBox:
 
         return self._find_music_info(artist, song, response.json())
 
+    def get_html_widget(
+        self,
+        id: str,
+        content_type: str,
+        territory: str = "TW",
+        widget_lang: str = "EN",
+        autoplay: bool = False,
+        loop: bool = False,
+    ) -> str:
+        """
+        Return KKBOX HTML widget for "Playlist", "Album" or "Song". It does not return actual HTML code,
+        the URL returned can be used in an HTML ``iframe`` with the help of ``src`` attribute.
+
+        Parameters
+        ----------
+        id : str
+             ``ID`` of playlist, album or track.
+        content_type : str
+            Content type can be ``playlist``, ``album`` or ``song``.
+        territory : str, optional
+            Territory code, i.e. "TW", "HK", "JP", "SG", "MY", by default "TW"
+        widget_lang : str, optional
+            The display language of the widget. Can be "TC", "SC", "JA", "EN", "MS", by default "EN"
+        autoplay : bool, optional
+            Whether to start playing music automatically in widget, by default False
+        loop : bool, optional
+            Repeat/loop song(s), by default False
+
+        Returns
+        -------
+        str
+            KKBOX HTML widget URL.
+        """
+        valid_content_types = ["playlist", "album", "song"]
+        valid_widget_langs = ["TC", "SC", "JA", "EN", "MS"]
+        if content_type not in valid_content_types:
+            raise InvalidValueException(
+                f"`content_type` must be one of these: {valid_content_types} !"
+            )
+
+        if territory not in self.valid_territories:
+            raise InvalidValueException(
+                f"`territory` must be one of these: {self.valid_territories} !"
+            )
+
+        if widget_lang not in valid_widget_langs:
+            raise InvalidValueException(
+                f"`widget_lang` must be one of these: {valid_widget_langs} !"
+            )
+
+        return f"https://widget.kkbox.com/v1/?id={id}&type={content_type}&terr={territory}&lang={widget_lang}&autoplay={autoplay}&loop={loop}"
+
     def _find_music_info(
         self, artist: str, song: str, response_json: dict
     ) -> Optional[MusicInfo]:

{yutipy-1.1.0.dist-info → yutipy-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yutipy
-Version: 1.1.0
+Version: 1.2.0
 Summary: A simple package for retrieving music information from various music platforms APIs.
 Author: Cheap Nightbot
 Author-email: Cheap Nightbot <hi@cheapnightbot.slmail.me>

{yutipy-1.1.0.dist-info → yutipy-1.2.0.dist-info}/RECORD

@@ -2,14 +2,14 @@ yutipy/__init__.py,sha256=t0w-pRLjIGD3UtDyd-JpeL-RrMona7YTV_0lZCpGLEc,232
 yutipy/deezer.py,sha256=TbPk6f1ytrtk9GHXOoRZ948fcgOi0619-rQC9xfTYu0,8641
 yutipy/exceptions.py,sha256=4L0Oe1PwFP34LoFTy-Fruipk7uB-JkaackRmkjlaZJU,1138
 yutipy/itunes.py,sha256=NhrllA3U0PUY3dNoMyiG1oZuyvdMQKYRBHzYSkt8ikM,5843
-yutipy/kkbox.py,sha256=l-I1FZjKzLLqjN0hO2hvz6AdNuYvD1B4XI36m3sWmfM,10123
+yutipy/kkbox.py,sha256=yuyEanxxOXsiL2ZTtJMraETQxDetWfUu9K8IULSKQrQ,12186
 yutipy/models.py,sha256=RnfWjoNO1UoNsRvNRYd-4TpkU-4jHKu5t394vIqOOgw,1360
 yutipy/musicyt.py,sha256=kvRYuhlNVuvy-WahJq895T3JAzmGTTiKB89r_uTMTAI,7155
 yutipy/spotify.py,sha256=CZA9XF0EV5wSrLrN9cURtiFKSEHsIvqVlXLKkvb4JEM,13609
 yutipy/utils/__init__.py,sha256=7UFcFZ7fBtNXOTngjnRD3MeobT3x5UT2Gag94TXVgLk,169
 yutipy/utils/cheap_utils.py,sha256=LIuEHib_97NuLahXxdHJUD9v-ccXNUc3NrLYk8EQ52A,1652
-yutipy-1.1.0.dist-info/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
-yutipy-1.1.0.dist-info/METADATA,sha256=2EY4cfuWnLA1fH4E1G1qp8x3o53M8bzAYSX6QPdxAms,6467
-yutipy-1.1.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-yutipy-1.1.0.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
-yutipy-1.1.0.dist-info/RECORD,,
+yutipy-1.2.0.dist-info/LICENSE,sha256=_89JsS2QnBG8tAb5-VWbJDj_uJ002zPJAYBJJdh3DPY,1071
+yutipy-1.2.0.dist-info/METADATA,sha256=GZOfBMev_zfoZ2JWhFM60t85GkOU2rerxowo1CFqR4c,6467
+yutipy-1.2.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+yutipy-1.2.0.dist-info/top_level.txt,sha256=t2A5V2_mUcfnHkbCy6tAQlb3909jDYU5GQgXtA4756I,7
+yutipy-1.2.0.dist-info/RECORD,,