__init__

Init module for spotdl. This module contains the main entry point for spotdl. And Spotdl class

Spotdl(client_id, client_secret, user_auth=False, cache_path=None, no_cache=False, headless=False, downloader_settings=None, loop=None)

Spotdl class, which simplifies the process of downloading songs from Spotify.

from spotdl import Spotdl

spotdl = Spotdl(client_id='your-client-id', client_secret='your-client-secret')

songs = spotdl.search(['joji - test drive',
    'https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT'])

results = spotdl.download_songs(songs)
song, path = spotdl.download(songs[0])

Arguments

• client_id: Spotify client id
• client_secret: Spotify client secret
• user_auth: If true, user will be prompted to authenticate
• cache_path: Path to cache directory
• no_cache: If true, no cache will be used
• headless: If true, no browser will be opened
• downloader_settings: Settings for the downloader
• loop: Event loop to use

Source code in spotdl/__init__.py

def __init__(
    self,
    client_id: str,
    client_secret: str,
    user_auth: bool = False,
    cache_path: Optional[str] = None,
    no_cache: bool = False,
    headless: bool = False,
    downloader_settings: Optional[
        Union[DownloaderOptionalOptions, DownloaderOptions]
    ] = None,
    loop: Optional[asyncio.AbstractEventLoop] = None,
):
    """
    Initialize the Spotdl class

    ### Arguments
    - client_id: Spotify client id
    - client_secret: Spotify client secret
    - user_auth: If true, user will be prompted to authenticate
    - cache_path: Path to cache directory
    - no_cache: If true, no cache will be used
    - headless: If true, no browser will be opened
    - downloader_settings: Settings for the downloader
    - loop: Event loop to use
    """

    if downloader_settings is None:
        downloader_settings = {}

    # Initialize spotify client
    SpotifyClient.init(
        client_id=client_id,
        client_secret=client_secret,
        user_auth=user_auth,
        cache_path=cache_path,
        no_cache=no_cache,
        headless=headless,
    )

    # Initialize downloader
    self.downloader = Downloader(
        settings=downloader_settings,
        loop=loop,
    )

download(song)

Download and convert song to the output format.

Arguments

• song: Song object

Returns

• A tuple containing the song and the path to the downloaded file if successful.

Source code in spotdl/__init__.py

def download(self, song: Song) -> Tuple[Song, Optional[Path]]:
    """
    Download and convert song to the output format.

    ### Arguments
    - song: Song object

    ### Returns
    - A tuple containing the song and the path to the downloaded file if successful.
    """

    return self.downloader.download_song(song)

download_songs(songs)

Download and convert songs to the output format.

Arguments

• songs: List of Song objects

Returns

• A list of tuples containing the song and the path to the downloaded file if successful.

Source code in spotdl/__init__.py

def download_songs(self, songs: List[Song]) -> List[Tuple[Song, Optional[Path]]]:
    """
    Download and convert songs to the output format.

    ### Arguments
    - songs: List of Song objects

    ### Returns
    - A list of tuples containing the song and the path to the downloaded file if successful.
    """

    return self.downloader.download_multiple_songs(songs)

get_download_urls(songs)

Get the download urls for a list of songs.

Arguments

• songs: List of Song objects

Returns

• A list of urls if successful.

Notes

• This function is multi-threaded.

Source code in spotdl/__init__.py

def get_download_urls(self, songs: List[Song]) -> List[Optional[str]]:
    """
    Get the download urls for a list of songs.

    ### Arguments
    - songs: List of Song objects

    ### Returns
    - A list of urls if successful.

    ### Notes
    - This function is multi-threaded.
    """

    urls: List[Optional[str]] = []
    with concurrent.futures.ThreadPoolExecutor(
        max_workers=self.downloader.settings["threads"]
    ) as executor:
        future_to_song = {
            executor.submit(self.downloader.search, song): song for song in songs
        }
        for future in concurrent.futures.as_completed(future_to_song):
            song = future_to_song[future]
            try:
                data = future.result()
                urls.append(data)
            except Exception as exc:
                logger.error("%s generated an exception: %s", song, exc)

    return urls

search(query)

Search for songs.

Arguments

• query: List of search queries

Returns

• A list of Song objects

Notes

• query can be a list of song titles, urls, uris

Source code in spotdl/__init__.py

def search(self, query: List[str]) -> List[Song]:
    """
    Search for songs.

    ### Arguments
    - query: List of search queries

    ### Returns
    - A list of Song objects

    ### Notes
    - query can be a list of song titles, urls, uris
    """

    return parse_query(
        query=query,
        threads=self.downloader.settings["threads"],
        use_ytm_data=self.downloader.settings["ytm_data"],
        playlist_numbering=self.downloader.settings["playlist_numbering"],
        album_type=self.downloader.settings["album_type"],
        playlist_retain_track_cover=self.downloader.settings[
            "playlist_retain_track_cover"
        ],
    )

console_entry_point()

Entry point for the console. With profile flag, it runs the code with cProfile.

Source code in spotdl/console/entry_point.py

def console_entry_point():
    """
    Entry point for the console. With profile flag, it runs the code with cProfile.
    """

    if "--profile" in sys.argv:
        with cProfile.Profile() as profile:
            entry_point()

        stats = pstats.Stats(profile)
        stats.sort_stats(pstats.SortKey.TIME)
        stats.dump_stats("spotdl.profile")
    else:
        entry_point()