yutipy 1.1.0__tar.gz → 1.2.1__tar.gz

yutipy-1.2.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: CheapNightbot
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

yutipy-1.2.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

{yutipy-1.1.0 → yutipy-1.2.1}/.github/workflows/release.yml

@@ -94,27 +94,3 @@ jobs:
         gh release upload
         "$GITHUB_REF_NAME" dist/**
         --repo "$GITHUB_REPOSITORY"
-  publish-to-testpypi:
-    name: Publish Python 🐍 distribution 📦 to TestPyPI
-    needs:
-    - build
-    runs-on: ubuntu-latest
-
-    environment:
-      name: testpypi-release
-      url: https://test.pypi.org/project/yutipy
-
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
-      with:
-        repository-url: https://test.pypi.org/legacy/
-        verbose: true

{yutipy-1.1.0 → yutipy-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: yutipy
-Version: 1.1.0
+Version: 1.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>
@@ -54,6 +54,7 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: ytmusicapi==1.10.1
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />

{yutipy-1.1.0 → yutipy-1.2.1}/docs/api_reference.rst

@@ -116,3 +116,9 @@ Exceptions
     :inherited-members:
     :noindex:
     :exclude-members: add_note, args, with_traceback
+
+.. autoclass:: yutipy.exceptions.KKBoxException
+    :members:
+    :inherited-members:
+    :noindex:
+    :exclude-members: add_note, args, with_traceback

yutipy-1.2.1/tests/test_kkbox.py

@@ -0,0 +1,44 @@
+import pytest
+from pytest import raises
+
+from yutipy.exceptions import KKBoxException, InvalidValueException
+from yutipy.models import MusicInfo
+from yutipy.kkbox import KKBox
+
+
+@pytest.fixture(scope="module")
+def kkbox():
+    try:
+        return KKBox()
+    except KKBoxException:
+        pytest.skip("KKBOX credentials not found")
+
+
+def test_search(kkbox):
+    artist = "Porter Robinson"
+    song = "Shelter"
+    result = kkbox.search(artist, song)
+    assert result is not None
+    assert isinstance(result, MusicInfo)
+    assert result.title == song
+    assert artist in result.artists
+
+
+def test_get_html_widget(kkbox):
+    html_widget = kkbox.get_html_widget(id="8rceGrek59bDS0HmQH", content_type="song")
+    assert html_widget is not None
+    assert isinstance(html_widget, str)
+
+    with raises(InvalidValueException):
+        kkbox.get_html_widget(id="8rceGrek59bDS0HmQH", content_type="track")
+
+    with raises(InvalidValueException):
+        kkbox.get_html_widget(id="8rceGrek59bDS0HmQH", content_type="song", territory="US")
+
+    with raises(InvalidValueException):
+        kkbox.get_html_widget(id="8rceGrek59bDS0HmQH", content_type="song", widget_lang="JP")
+
+
+def test_close_session(kkbox):
+    kkbox.close_session()
+    assert kkbox.is_session_closed

{yutipy-1.1.0 → yutipy-1.2.1}/yutipy/deezer.py

@@ -28,7 +28,7 @@ class Deezer:
 
     def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
         """Exits the runtime context related to this object."""
-        self._close_session()
+        self.close_session()
 
     def close_session(self) -> None:
         """Closes the current session."""

{yutipy-1.1.0 → yutipy-1.2.1}/yutipy/itunes.py

@@ -29,7 +29,7 @@ class Itunes:
 
     def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
         """Exits the runtime context related to this object."""
-        self._close_session()
+        self.close_session()
 
     def close_session(self) -> None:
         """Closes the current session."""

{yutipy-1.1.0 → yutipy-1.2.1}/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."""
@@ -63,7 +64,7 @@ class KKBox:
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
         """Exits the runtime context related to this object."""
-        self._close_session()
+        self.close_session()
 
     def close_session(self) -> None:
         """Closes the current session."""
@@ -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 → yutipy-1.2.1}/yutipy/spotify.py

@@ -69,7 +69,7 @@ class Spotify:
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
         """Exits the runtime context related to this object."""
-        self._close_session()
+        self.close_session()
 
     def close_session(self) -> None:
         """Closes the current session."""

{yutipy-1.1.0 → yutipy-1.2.1}/yutipy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: yutipy
-Version: 1.1.0
+Version: 1.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>
@@ -54,6 +54,7 @@ Requires-Dist: requests==2.32.3
 Requires-Dist: ytmusicapi==1.10.1
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/CheapNightbot/yutipy/main/docs/_static/yutipy_header.png" alt="yutipy" />

{yutipy-1.1.0 → yutipy-1.2.1}/yutipy.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ pyproject.toml
 requirements-dev.txt
 requirements.txt
 .github/FUNDING.yml
+.github/ISSUE_TEMPLATE/bug_report.md
+.github/ISSUE_TEMPLATE/feature_request.md
 .github/workflows/pytest-unit-testing.yml
 .github/workflows/release.yml
 docs/Makefile

yutipy-1.1.0/tests/test_kkbox.py

@@ -1,28 +0,0 @@
-import pytest
-
-from yutipy.exceptions import KKBoxException
-from yutipy.models import MusicInfo
-from yutipy.kkbox import KKBox
-
-
-@pytest.fixture(scope="module")
-def kkbox():
-    try:
-        return KKBox()
-    except KKBoxException:
-        pytest.skip("KKBOX credentials not found")
-
-
-def test_search(kkbox):
-    artist = "Porter Robinson"
-    song = "Shelter"
-    result = kkbox.search(artist, song)
-    assert result is not None
-    assert isinstance(result, MusicInfo)
-    assert result.title == song
-    assert artist in result.artists
-
-
-def test_close_session(kkbox):
-    kkbox.close_session()
-    assert kkbox.is_session_closed