Sync Spotify playlists -> YT Music

.env.example

@@ -1 +1,4 @@
-HEADER_RAW='Paste your raw header here'
+SPOTIPY_CLIENT_ID='paste your Spotify client id here'
+SPOTIPY_CLIENT_SECRET='paste your Spotify client secret here'
+SPOTIPY_REDIRECT_URI='paste your Spotify redirect uri here. E.g. http://localhost:8888/callback/'
+YTMUSIC_HEADER_RAW='Paste your raw header here'

.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Tests
+
+on:
+  push:
+    branches: '**'
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -128,6 +128,9 @@ ENV/
 env.bak/
 venv.bak/
 
+# ignore header_raw.txt
+header_raw.txt
+
 # do not ignore env example file
 !.env.example
 
@@ -160,4 +163,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

requirements.txt

@@ -1,4 +1,8 @@
 ytmusicapi~=0.25
 pandas~=1.4
 python-dotenv~=1.0
-chardet~=5.1
+chardet~=5.1
+spotipy~=2.22
+inquirer~=3.1
+pytest~=7.2
+mock~=5.0

src/__init__.py

@@ -0,0 +1,2 @@
+import sys
+sys.path.append('./src')

src/cli/menu.py

@@ -0,0 +1,52 @@
+import inquirer
+from cli.operation import Operation
+from cli.bcolors import bcolors
+from playlist import Playlist
+
+
+def main_menu() -> Operation:
+    questions = [
+        inquirer.List(
+            "operation",
+            message="Select an operation:",
+            choices=[op.value for op in Operation],
+        ),
+    ]
+
+    answers = inquirer.prompt(questions)
+    return Operation(answers["operation"])
+
+
+def playlists_checkbox(playlists: list[Playlist]) -> list[Playlist]:
+
+    questions = [
+        inquirer.Confirm("isAll",
+                         message=f"{bcolors.BOLD}Do you want to sync all spotify playlists?{bcolors.ENDC}",
+                         default=False),
+        inquirer.Checkbox("playlists",
+                          message=f"{bcolors.BOLD}Which playlists do you want to sync?{bcolors.ENDC}",
+                          choices=[playlist.name for playlist in playlists],
+                          ignore=lambda answer: answer["isAll"],
+                          ),
+    ]
+
+    answers = inquirer.prompt(questions)
+
+    if answers["isAll"]:
+        return playlists
+
+    elif answers["playlists"] == []:
+        questions = [
+            inquirer.Confirm("isEmpty",
+                             message=f"{bcolors.BOLD}You have not selected any playlists. Do you want to exit?{bcolors.ENDC}",
+                             default=False),
+        ]
+
+        if (inquirer.prompt(questions)["isEmpty"]):
+            exit(0)
+        else:
+            print()
+            return playlists_checkbox(playlists)
+
+    else:
+        return list(playlist for playlist in playlists if playlist.name.casefold() in [playlist.casefold() for playlist in answers["playlists"]])

src/cli/operation.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Operation(Enum):
+    SYNC_YOUTUBE_PLAYLISTS_WITH_SPOTIFY = 'Sync YouTube Music playlists from Spotify'
+    SYNC_SPOTIFY_PLAYLISTS_WITH_YOUTUBE = 'Sync Spotify playlists from YouTube Music'

src/main.py

@@ -1,9 +1,26 @@
-from yt_music import setup_YTMusic, sync_playlists
-
+"""Main file for the application."""
+from cli.bcolors import bcolors
+from cli.menu import main_menu
+from cli.operation import Operation
+from spotify import setup_spotipy
+from sync import sync_spotify_to_ytmusic
+from yt_music import setup_ytmusic
 
 if __name__ == "__main__":
-    ytmusic = setup_YTMusic()
+    spotify = setup_spotipy()
+    ytmusic = setup_ytmusic()
+
+    operation: Operation = main_menu()
+
+    match operation:
+
+        case Operation.SYNC_YOUTUBE_PLAYLISTS_WITH_SPOTIFY:
+            sync_spotify_to_ytmusic(spotify, ytmusic)
 
-    playlists_dir = 'resources/playlists/'
+        case Operation.SYNC_SPOTIFY_PLAYLISTS_WITH_YOUTUBE:
+            print(f"{bcolors.HEADER}{bcolors.BOLD}{bcolors.UNDERLINE}"
+                  f"{Operation.SYNC_SPOTIFY_PLAYLISTS_WITH_YOUTUBE.value}...{bcolors.ENDC}")
+            print(f"{bcolors.WARNING}Not implemented yet...{bcolors.ENDC}")
 
-    sync_playlists(ytmusic, playlists_dir)
+        case _:
+            print("Invalid operation")

src/playlist.py

@@ -0,0 +1,128 @@
+"""This module contains the Playlist class and its methods."""
+
+from __future__ import annotations
+from dataclasses import dataclass
+from spotipy.client import Spotify
+from song import Song, get_song_from_spotify_json
+from cli.bcolors import bcolors
+
+
+def get_playlist_from_spotify(json, spotify: Spotify) -> Playlist:
+    """
+    Creates a Playlist object from a Spotify playlist JSON object.
+
+    Parameters
+    ----------
+    json : dict
+        The JSON object of the playlist.
+    spotify : Spotify
+        The Spotify object to use for the API calls.
+
+    Returns
+    -------
+    Playlist
+        The Playlist object.
+    """
+    name = json["name"]
+    id = json["id"]
+    image = json["images"][0]["url"] if len(json["images"]) > 0 else None
+    description = json["description"]
+    total_songs = json["tracks"]["total"]
+    songs = get_songs_by_playlist_id(id, total_songs, spotify)
+
+    return Playlist(name, id, image, description, songs)
+
+
+def get_songs_by_playlist_id(playlist_id: str, total_songs: int, spotify: Spotify) -> list[Song]:
+    """
+    Gets all songs from a Spotify playlist by its ID.
+
+    Parameters
+    ----------
+    playlist_id : str
+        The ID of the playlist.
+    total_songs : int
+        The total number of songs in the playlist.
+    spotify : Spotify
+        The Spotify object to use for the API calls.
+
+    Returns
+    -------
+    list[Song]
+        A list of Song objects.
+    """
+    if total_songs == 0:
+        return []
+
+    if total_songs <= 100:
+        songs_json = spotify.playlist_items(
+            playlist_id, limit=total_songs)['items']
+
+    else:
+        # there is a limit of 100 songs per request
+        offset = 0
+        songs_json = []
+        while offset < total_songs:
+            songs_json_temp = spotify.playlist_items(
+                playlist_id, limit=100, offset=offset)
+            songs_json.extend(songs_json_temp["items"])
+            offset += 100
+
+    songs = []
+    for song in songs_json:
+        songs.append(get_song_from_spotify_json(song["track"]))
+
+    if total_songs != len(songs):
+        print(f"{bcolors.WARNING}WARNING: Playlist ID {playlist_id}: "
+              f"{total_songs} songs were expected, but only {len(songs)} were found{bcolors.ENDC}")
+
+    return songs
+
+
+@dataclass
+class Playlist:
+    """
+    A class used to represent a playlist.
+
+    Attributes
+    ----------
+    name : str
+        The name of the playlist.
+    id : str
+        The ID of the playlist.
+    image : str
+        The URL of the playlist's image.
+    description : str
+        The description of the playlist.
+    songs : list[Song]
+        A list of Song objects.
+    """
+
+    def __init__(self, name: str, id: str, image: str, description: str, songs=None):
+        """
+        Parameters
+        ----------
+        name : str
+            The name of the playlist.
+        id : str
+            The ID of the playlist.
+        image : str
+            The URL of the playlist's image.
+        description : str
+            The description of the playlist.
+        songs : list[Song], optional
+            A list of Song objects. If None, an empty list is used.
+        """
+        if songs is None:
+            songs = []
+        self.name: str = name
+        self.id: str = id
+        self.image: str = image
+        self.description: str = description
+        self.songs: list[Song] = songs
+
+    def __str__(self):
+        return "Playlist{name=" + self.name + \
+            ", id=" + self.id + \
+            ", image=" + self.image + \
+            ", description=" + self.description + "}"