podcasts features ✨ (#559)

README.rst

@@ -47,7 +47,7 @@ Features
 
 | **Library management**:
 
-* get library contents: playlists, songs, artists, albums and subscriptions
+* get library contents: playlists, songs, artists, albums and subscriptions, podcasts, channels
 * add/remove library content: rate songs, albums and playlists, subscribe/unsubscribe artists
 * get and modify play history
 
@@ -62,6 +62,7 @@ Features
 
 * get podcasts
 * get episodes
+* get channels
 
 | **Uploads**:
 

docs/source/reference.rst

@@ -52,7 +52,10 @@ Library
 .. automethod:: YTMusic.get_library_albums
 .. automethod:: YTMusic.get_library_artists
 .. automethod:: YTMusic.get_library_subscriptions
+.. automethod:: YTMusic.get_library_podcasts
+.. automethod:: YTMusic.get_library_channels
 .. automethod:: YTMusic.get_liked_songs
+.. automethod:: YTMusic.get_saved_episodes
 .. automethod:: YTMusic.get_history
 .. automethod:: YTMusic.add_history_item
 .. automethod:: YTMusic.remove_history_items
@@ -74,6 +77,8 @@ Playlists
 
 Podcasts
 --------
+.. automethod:: YTMusic.get_channel
+.. automethod:: YTMusic.get_channel_episodes
 .. automethod:: YTMusic.get_podcast
 .. automethod:: YTMusic.get_episode
 

pyproject.toml

@@ -77,4 +77,5 @@ dev = [
     "mypy>=1.8.0",
     "pytest>=7.4.4",
     "pytest-cov>=4.1.0",
+    "types-requests>=2.31.0.20240218",
 ]

tests/mixins/test_library.py

@@ -60,6 +60,20 @@ def test_get_library_subscriptions(self, config, yt_brand, yt_empty):
         artists = yt_empty.get_library_subscriptions()
         assert len(artists) == 0
 
+    def test_get_library_podcasts(self, yt_brand, yt_empty):
+        podcasts = yt_brand.get_library_podcasts(limit=50, order="a_to_z")
+        assert len(podcasts) > 25
+
+        empty = yt_empty.get_library_podcasts()
+        assert len(empty) == 1  # saved episodes playlist is always there
+
+    def test_get_library_channels(self, yt_brand, yt_empty):
+        channels = yt_brand.get_library_channels(limit=50, order="recently_added")
+        assert len(channels) > 25
+
+        empty = yt_empty.get_library_channels()
+        assert len(empty) == 0
+
     def test_get_liked_songs(self, yt_brand, yt_empty):
         songs = yt_brand.get_liked_songs(200)
         assert len(songs["tracks"]) > 100

tests/mixins/test_podcasts.py

@@ -1,13 +1,26 @@
 class TestPodcasts:
+    def test_get_channel(self, config, yt):
+        podcast_id = config["podcasts"]["channel_id"]
+        channel = yt.get_channel(podcast_id)
+        assert len(channel["episodes"]["results"]) == 10
+        assert len(channel["podcasts"]["results"]) > 5
+
+    def test_get_channel_episodes(self, config, yt_oauth):
+        channel_id = config["podcasts"]["channel_id"]
+        channel = yt_oauth.get_channel(channel_id)
+        channel_episodes = yt_oauth.get_channel_episodes(channel_id, channel["episodes"]["params"])
+        assert len(channel_episodes) >= 150
+        assert len(channel_episodes[0]) == 9
+
     def test_get_podcast(self, config, yt, yt_brand):
         podcast_id = config["podcasts"]["podcast_id"]
-        results = yt.get_podcast(podcast_id)
-        assert len(results["episodes"]) == 100
-        assert not results["saved"]
+        podcast = yt.get_podcast(podcast_id)
+        assert len(podcast["episodes"]) == 100
+        assert not podcast["saved"]
 
-        results = yt_brand.get_podcast(podcast_id, limit=None)
-        assert len(results["episodes"]) > 100
-        assert results["saved"]
+        podcast = yt_brand.get_podcast(podcast_id, limit=None)
+        assert len(podcast["episodes"]) > 100
+        assert podcast["saved"]
 
     def test_many_podcasts(self, yt):
         results = yt.search("podcast", filter="podcasts")
@@ -17,13 +30,13 @@ def test_many_podcasts(self, yt):
 
     def test_get_episode(self, config, yt, yt_brand):
         episode_id = config["podcasts"]["episode_id"]
-        result = yt.get_episode(episode_id)
-        assert len(result["description"]) >= 20
-        assert not result["saved"]
-        assert result["playlistId"] is not None
+        episode = yt.get_episode(episode_id)
+        assert len(episode["description"]) >= 20
+        assert not episode["saved"]
+        assert episode["playlistId"] is not None
 
-        result = yt_brand.get_episode(episode_id)
-        assert result["saved"]
+        episode = yt_brand.get_episode(episode_id)
+        assert episode["saved"]
 
     def test_many_episodes(self, yt):
         results = yt.search("episode", filter="episodes")

tests/setup/setup_account.py

@@ -15,7 +15,7 @@
 yt_brand = YTMusic(Path(__file__).parent.joinpath("oauth.json").as_posix(), brand_account)
 
 
-def populate_account():
+def populate_music():
     """idempotent requests to populate an account"""
     # library
     playlist_id = "RDCLAK5uy_l9ex2d91-Qb1i-W7d0MLCEl_ZjRXss0Dk"  # fixed playlist with many artists
@@ -53,10 +53,18 @@ def populate_account():
     )
     print(f"Created playlist {playlistId}, don't forget to set this in test.cfg playlists/own")
 
-    # podcasts
+
+def populate_podcasts():
     yt_brand.rate_playlist(config["podcasts"]["podcast_id"], rating="LIKE")
     yt_brand.add_playlist_items("SE", [config["podcasts"]["episode_id"]])
+    podcasts = yt_brand.search("podcast", filter="podcasts", limit=40)
+    for podcast in podcasts:
+        playlist_id = podcast["browseId"][4:]
+        yt_brand.rate_playlist(playlist_id, rating="LIKE")
+        podcast = yt_brand.get_podcast(playlist_id)
+        yt_brand.subscribe_artists([podcast["author"]["id"]])
 
 
 if __name__ == "__main__":
-    populate_account()
+    populate_music()
+    populate_podcasts()

tests/test.example.cfg

@@ -31,6 +31,11 @@ private_album_id = sample_id_of_private_album
 private_artist_id = sample_id_of_private_artist
 private_upload_id = sample_video_id_of_private_upload
 
+[podcasts]
+channel_id = UCGwuxdEeCf0TIA2RbPOj-8g
+podcast_id = PLxq_lXOUlvQDgCVFj9L79kqJybW0k6OaB
+episode_id = KNkyHCLOr1o
+
 [limits]
 library_playlists = 100
 library_songs = 200

ytmusicapi/locales/ar/LC_MESSAGES/base.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-11-11 16:22+0100\n"
+"POT-Creation-Date: 2024-03-05 20:13+0100\n"
 "PO-Revision-Date: 2023-01-02 22:14+0530\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -17,54 +17,62 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "X-Generator: Poedit 3.2.2\n"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:22
 msgid "artist"
 msgstr "فنان"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:23
 msgid "playlist"
 msgstr "قائمةالتشغيل"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:24
 msgid "song"
 msgstr "أغنية"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:25
 msgid "video"
 msgstr "فيديو"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:26
 msgid "station"
 msgstr "محطة"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:27
 msgid "profile"
 msgstr "الملف الشخصي"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:28
 msgid "podcast"
 msgstr "بودكاست"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:29
 msgid "episode"
 msgstr "حلقة"
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "albums"
 msgstr "ألبومات"
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "singles"
 msgstr "الفردي"
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "videos"
 msgstr "أشرطة فيديو"
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "playlists"
 msgstr "قوائم التشغيل"
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "related"
 msgstr "ذات صلة"
+
+#: parsers/i18n.py:35
+msgid "episodes"
+msgstr "أحدث الحلقات"
+
+#: parsers/i18n.py:35
+msgid "podcasts"
+msgstr "بودكاست"

ytmusicapi/locales/base.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-11-11 16:22+0100\n"
+"POT-Creation-Date: 2024-03-05 20:13+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -17,54 +17,62 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:22
 msgid "artist"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:23
 msgid "playlist"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:24
 msgid "song"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:25
 msgid "video"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:26
 msgid "station"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:27
 msgid "profile"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:28
 msgid "podcast"
 msgstr ""
 
-#: parsers/i18n.py:16
+#: parsers/i18n.py:29
 msgid "episode"
 msgstr ""
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "albums"
 msgstr ""
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "singles"
 msgstr ""
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "videos"
 msgstr ""
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "playlists"
 msgstr ""
 
-#: parsers/i18n.py:21
+#: parsers/i18n.py:35
 msgid "related"
 msgstr ""
+
+#: parsers/i18n.py:35
+msgid "episodes"
+msgstr ""
+
+#: parsers/i18n.py:35
+msgid "podcasts"
+msgstr ""