Musicdl: A lightweight music downloader written in pure python
Project description
📚 Documents: musicdl.readthedocs.io
🎧 Live Demo · MusicSquare (音乐广场)
🛠 Source Code (MusicSquare)
MusicSquare is a browser-based music playground — search, play, and download tracks directly in your browser.
⚠️ For learning and testing only: please respect copyright and the terms of each music platform.
学习收获更多有趣的内容, 欢迎关注微信公众号:Charles的皮卡丘
🎉 What's New
- 2026-02-14: Released musicdl v2.9.5 — this update fixes the incomplete playlist retrieval for NetEase Cloud Music, adds support for Kugou Music playlist parsing, introduces multiple lossless music APIs, and includes several potential bug fixes.
- 2026-02-11: Released musicdl v2.9.4 — supported batch downloading for Kuwo Music playlists; optimized playlist downloading for NetEase Cloud Music and QQ Music; added support for QQ Music’s "Premium Master 4.0" (臻品母带 4.0) to provide high-fidelity audio files.
- 2026-02-10: Released musicdl v2.9.3 — refactored the TIDAL client to utilize N_m3u8DL-RE for HI_RES_LOSSLESS support, and optimized the lossless interface for shared membership accounts.
🎵 Introduction
A lightweight music downloader written in pure Python. Like it? ⭐ Star the repository to stay up to date. Thanks!
⚠️ Disclaimer
This repository is provided solely for educational and research purposes. Commercial use is prohibited. The software only interacts with publicly accessible web endpoints and does not host, store, mirror, or distribute any copyrighted or proprietary content. No executables are distributed with this repository. Redistribution, resale, or bundling of this software (or any derivative packaged distribution) without explicit permission is strictly prohibited. Access to paid, subscription, or otherwise restricted content must be obtained through authorized channels (e.g., purchase or subscription via the relevant service). Use of this software to circumvent paywalls, DRM, licensing restrictions, or other access controls is strictly prohibited. If you are a copyright or rights holder and believe that this repository infringes your rights, please contact me with sufficient detail (e.g., relevant URLs and proof of ownership), and I will promptly investigate and take appropriate action, which may include removal of the referenced material.
🎧 Supported Music Client
🧪 Playground
Here are some projects built on top of musicdl,
| Project (EN) | Project (CN) | WeChat Article | Project Location |
|---|---|---|---|
| Music downloader GUI | 音乐下载器GUI界面 | click | musicdlgui |
| Singer lyrics analysis | 歌手歌词分析 | click | singerlyricsanalysis |
| Lyric-based song snippet retrieval | 歌词获取歌曲片段 | click | searchlyrics |
For example, the Music Downloader GUI looks/works like this,
📦 Install
You have three installation methods to choose from,
# from pip
pip install musicdl
# from github repo method-1
pip install git+https://github.com/CharlesPikachu/musicdl.git@master
# from github repo method-2
git clone https://github.com/CharlesPikachu/musicdl.git
cd musicdl
python setup.py install
Some of the music downloaders supported by musicdl require additional CLI tools to function properly, mainly for decrypting encrypted search/download requests and audio files. These CLI tools include,
-
FFmpeg: At the moment, only
TIDALMusicClientandAppleMusicClientdepends on FFmpeg for audio file decoding. If you don’t need to useTIDALMusicClientandAppleMusicClientwhen working with musicdl, you don’t need to install FFmpeg. After installing it, you should run the following command in a terminal (Command Prompt / PowerShell on Windows, Terminal on macOS/Linux) to check whether FFmpeg is on your systemPATH:ffmpeg -versionIf FFmpeg is installed correctly and on your
PATH, this command will print the FFmpeg version information (e.g., a few lines starting withffmpeg version ...). If you see an error likecommand not foundor'ffmpeg' is not recognized as an internal or external command, then FFmpeg is either not installed or not added to yourPATH. -
Node.js: Currently, only
YouTubeMusicClientin musicdl depends on Node.js, so if you don’t needYouTubeMusicClient, you don’t have to install Node.js. Similar to FFmpeg, after installing Node.js, you should run the following command to check whether Node.js is on your systemPATH:node -v (npm -v)
If Node.js is installed correctly,
node -vwill print the Node.js version (e.g.,v22.11.0), andnpm -vwill print the npm version. If you see a similarcommand not found/not recognizederror, Node.js is not installed correctly or not available on yourPATH. -
N_m3u8DL-RE: N_m3u8DL-RE is a powerful open-source command-line tool for downloading, decrypting, and muxing HLS/DASH (m3u8/mpd) streaming media into local video files. In musicdl, this library is mainly used for handling
TIDALMusicClientandAppleMusicClientaudio streams, so if you don’t needTIDALMusicClientandAppleMusicClientsupport, you don’t need to install it. After installing N_m3u8DL-RE, you need to make sure all of its executables are available in your systemPATH. A quick way to verify this is that you should be able to runpython -c "import shutil; print(shutil.which('N_m3u8DL-RE'))"
in Command Prompt and get the full path without an error.
-
Bento4: Bento4 is an open-source C++ toolkit for reading, writing, inspecting, and packaging MP4 files and related multimedia formats. In musicdl, this library is mainly used for handling
AppleMusicClientaudio streams, so if you don’t needAppleMusicClientsupport, you don’t need to install it. After installing Bento4, you need to make sure all of its executables are available in your systemPATH. A quick way to verify this is that you should be able to runpython -c "import shutil; print(shutil.which('mp4decrypt'))"
in Command Prompt and get the full path without an error.
-
amdecrypt: amdecrypt is a command-line tool developed by AI that leverages Bento4's mp4decrypt to process Apple Music encrypted files into playable formats. You can obtain it from the GitHub Releases of this repository. After installing amdecrypt, you need to make sure all of its executables are available in your system
PATH. A quick way to verify this is that you should be able to runpython -c "import shutil; print(shutil.which('amdecrypt'))"
in Command Prompt and get the full path without an error.
🚀 Quick Start
Typical Examples
Here, we provide some common musicdl use cases to help you quickly get started with the tool.
If you want the quickest way to run musicdl to verify that your environment meets its basic requirements and that musicdl has been installed successfully, you can write and run the following code,
from musicdl import musicdl
music_client = musicdl.MusicClient(music_sources=['MiguMusicClient', 'NeteaseMusicClient', 'QQMusicClient', 'KuwoMusicClient', 'QianqianMusicClient'])
music_client.startcmdui()
The above code runs musicdl using MiguMusicClient, NeteaseMusicClient, QQMusicClient, KuwoMusicClient and QianqianMusicClient as both the search sources and download sources.
Of course, you can also run musicdl by entering the following equivalent command directly in the command line,
musicdl -m NeteaseMusicClient,MiguMusicClient,QQMusicClient,KuwoMusicClient,QianqianMusicClient
Please note that musicdl uses five Mainland China music sources by default for searching. If you need to use overseas music sources, you must manually specify the music platform each time you run the program. For example:
musicdl -m GDStudioMusicClient,JamendoMusicClient
In addition, searching and downloading from many music sources simultaneously may be relatively slow.
Each run may take about 10–30 seconds.
If you are confident that your song can be found on a specific platform or a few platforms, for example, NeteaseMusicClient, QQMusicClient or KuwoMusicClient,
it is recommended to directly specify those platforms:
musicdl -m NeteaseMusicClient,QQMusicClient,KuwoMusicClient
The demonstration is as follows,
You can also use musicdl --help to see the detailed usage of the musicdl command-line tool, as follows:
Usage: musicdl [OPTIONS]
Options:
--version Show the version and exit.
-k, --keyword TEXT The keywords for the music search. If left
empty, an interactive terminal will open
automatically.
-p, --playlist-url, --playlist_url TEXT
Given a playlist URL, e.g., "https://music.1
63.com/#/playlist?id=7583298906", musicdl
automatically parses the playlist and
downloads all tracks in it.
-m, --music-sources, --music_sources TEXT
The music search and download sources.
[default: MiguMusicClient,NeteaseMusicClient
,QQMusicClient,KuwoMusicClient,QianqianMusicClient]
-i, --init-music-clients-cfg, --init_music_clients_cfg TEXT
Config such as `work_dir` for each music
client as a JSON string.
-r, --requests-overrides, --requests_overrides TEXT
Requests.get / Requests.post kwargs such as
`headers` and `proxies` for each music
client as a JSON string.
-c, --clients-threadings, --clients_threadings TEXT
Number of threads used for each music client
as a JSON string.
-s, --search-rules, --search_rules TEXT
Search rules for each music client as a JSON
string.
--help Show this message and exit.
If you want to change the download path for the music files, you can write the following code:
from musicdl import musicdl
init_music_clients_cfg = dict()
init_music_clients_cfg['MiguMusicClient'] = {'work_dir': 'migu'}
init_music_clients_cfg['NeteaseMusicClient'] = {'work_dir': 'netease'}
init_music_clients_cfg['QQMusicClient'] = {'work_dir': 'qq'}
music_client = musicdl.MusicClient(music_sources=['MiguMusicClient', 'NeteaseMusicClient', 'QQMusicClient'])
music_client.startcmdui()
Alternatively, you can equivalently run the following command directly in the command line:
musicdl -m NeteaseMusicClient,MiguMusicClient,QQMusicClient -i "{'MiguMusicClient': {'work_dir': 'migu'}, {'NeteaseMusicClient': {'work_dir': 'netease'}, {'QQMusicClient': {'work_dir': 'qq'}}"
If you are a VIP user on a particular music platform, you can pass the cookies from your logged-in web session on that platform to musicdl to improve the quality of song search and downloads.
Specifically, for example, if you have a membership on QQMusicClient, your code can be written as follows:
from musicdl import musicdl
your_vip_cookies_with_str_or_dict_format = ""
init_music_clients_cfg = dict()
init_music_clients_cfg['QQMusicClient'] = {'default_search_cookies': your_vip_cookies_with_str_or_dict_format, 'default_download_cookies': your_vip_cookies_with_str_or_dict_format}
music_client = musicdl.MusicClient(music_sources=['NeteaseMusicClient', 'QQMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Of course, you can also achieve the same effect by running the following command directly in the command line:
musicdl -m NeteaseMusicClient,QQMusicClient -i "{'QQMusicClient': {'default_search_cookies': your_vip_cookies_with_str_or_dict_format, 'default_download_cookies': your_vip_cookies_with_str_or_dict_format}}"
If you want to search for more songs on a specific music platform (e.g., QQMusicClient), you can do the following:
from musicdl import musicdl
init_music_clients_cfg = dict()
init_music_clients_cfg['QQMusicClient'] = {'search_size_per_source': 20}
music_client = musicdl.MusicClient(music_sources=['NeteaseMusicClient', 'QQMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Or enter the following in the command line:
musicdl -m NeteaseMusicClient,QQMusicClient -i "{'QQMusicClient': {'search_size_per_source': 20}}"
In this way, you can see up to 20 search results from QQMusicClient.
If you want to use the pyfreeproxy library to automatically leverage free online proxies for music search and download, you can do it as follows:
from musicdl import musicdl
init_music_clients_cfg = dict()
init_music_clients_cfg['NeteaseMusicClient'] = {
'search_size_per_source': 1000, 'auto_set_proxies': True,
'freeproxy_settings': dict(
proxy_sources=["ProxyScrapeProxiedSession", "ProxylistProxiedSession"],
init_proxied_session_cfg={"max_pages": 2, "filter_rule": {"country_code": ["CN"], "anonymity": ["elite"], "protocol": ["http", "https"]}},
disable_print=True,
max_tries=20
)
}
music_client = musicdl.MusicClient(music_sources=['NeteaseMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
The command-line usage is similar:
musicdl -m NeteaseMusicClient -i "{'NeteaseMusicClient': {'search_size_per_source': 1000, 'auto_set_proxies': True, 'freeproxy_settings': {'proxy_sources':['ProxyScrapeProxiedSession','ProxylistProxiedSession'],'init_proxied_session_cfg':{'max_pages':2,'filter_rule':{'country_code':['CN'],'anonymity':['elite'],'protocol':['http','https']}},'disable_print':True,'max_tries':20}}}"
Separating Search and Download Results
You can also call the .search and .download interfaces of musicdl separately to inspect its intermediate results or perform secondary development,
from musicdl import musicdl
# instance
music_client = musicdl.MusicClient(music_sources=['NeteaseMusicClient'])
# search
search_results = music_client.search(keyword='尾戒')
print(search_results)
song_infos = []
for song_infos_per_source in list(search_results.values()):
song_infos.extend(song_infos_per_source)
# download
music_client.download(song_infos=song_infos)
You can also choose not to use the unified MusicClient interface and instead directly import the definition class for a specific music platform for secondary development.
Take NeteaseMusicClient as an example:
from musicdl.modules.sources import NeteaseMusicClient
netease_music_client = NeteaseMusicClient()
# search
search_results = netease_music_client.search(keyword='那些年')
print(search_results)
# download
netease_music_client.download(song_infos=search_results)
All supported classes can be obtained by printing MusicClientBuilder.REGISTERED_MODULES, e.g,
from musicdl.modules import MusicClientBuilder
print(MusicClientBuilder.REGISTERED_MODULES)
Download Playlist Items
From musicdl v2.9.0 onward, support for downloading user playlists from each platform will be added gradually. The platforms currently supported are as follows:
Specifically, you only need to run the following command in the terminal, musicdl will automatically detect the playlist in the link and download it in batch:
musicdl -p "https://music.163.com/#/playlist?id=7583298906" -m NeteaseMusicClient
musicdl -p "https://y.qq.com/n/ryqq_v2/playlist/8740590963" -m QQMusicClient
musicdl -p "https://www.kuwo.cn/playlist_detail/3387576633" -m KuwoMusicClient
musicdl -p "https://www.kugou.com/yy/special/single/6914288.html" -m KugouMusicClient
Alternatively, use the following code to invoke it,
from musicdl import musicdl
init_music_clients_cfg = {'NeteaseMusicClient': {'default_parse_cookies': YOUR_VIP_COOKIES}}
music_client = musicdl.MusicClient(music_sources=['NeteaseMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
song_infos = music_client.parseplaylist("https://music.163.com/#/playlist?id=7583298906")
music_client.download(song_infos=song_infos)
WhisperLRC
On some music platforms, it’s not possible to obtain the lyric files corresponding to the audio, e.g, XimalayaMusicClient and MituMusicClient.
To handle this, we provide a faster-whisper interface that can automatically generate lyrics for tracks whose lyrics are unavailable for download.
For audio files that have already been downloaded, you can use the following invocation to automatically generate lyrics for the local file,
from musicdl.modules import WhisperLRC
your_local_music_file_path = 'xxx.flac'
WhisperLRC(model_size_or_path='base').fromfilepath(your_local_music_file_path)
The available model_size_or_path, ordered from smallest to largest, are:
tiny, tiny.en, base, base.en, small, small.en, distil-small.en, medium, medium.en, distil-medium.en, large-v1, large-v2, large-v3, large, distil-large-v2, distil-large-v3, large-v3-turbo, turbo
In general, the larger the model, the better the generated lyrics (transcription/translation) will be, but this also means it will take longer to run.
If you want to automatically generate lyric files during the download process,
you can set the environment variable ENABLE_WHISPERLRC=True (for example, by running export ENABLE_WHISPERLRC=True).
However, this is generally not recommended, as it may cause a single run of the program to take a very long time,
unless you set search_size_per_source to 1 and model_size_or_path to tiny.
Of course, you can also directly call .fromurl to generate a lyrics file for a song given by a direct URL:
from musicdl.modules import WhisperLRC
music_file_link = ''
WhisperLRC(model_size_or_path='base').fromurl(music_link)
Scenarios Where Quark Netdisk Login Cookies Are Required
Some websites share high-quality or lossless music files via Quark Netdisk links, for example, MituMusicClient, GequbaoMusicClient, YinyuedaoMusicClient, and BuguyyMusicClient.
If you want to download high-quality or lossless audio files from these music platforms, you need to provide the cookies from your logged-in Quark Netdisk web session when calling musicdl. For example, you can do the following:
from musicdl import musicdl
init_music_clients_cfg = dict()
init_music_clients_cfg['YinyuedaoMusicClient'] = {'quark_parser_config': {'cookies': your_cookies_with_str_or_dict_format}}
init_music_clients_cfg['GequbaoMusicClient'] = {'quark_parser_config': {'cookies': your_cookies_with_str_or_dict_format}}
init_music_clients_cfg['MituMusicClient'] = {'quark_parser_config': {'cookies': your_cookies_with_str_or_dict_format}}
init_music_clients_cfg['BuguyyMusicClient'] = {'quark_parser_config': {'cookies': your_cookies_with_str_or_dict_format}}
music_client = musicdl.MusicClient(music_sources=['MituMusicClient', 'YinyuedaoMusicClient', 'GequbaoMusicClient', 'BuguyyMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Please note that musicdl does not provide any speed-limit bypass for Quark Netdisk. If the cookies you supply belong to a non-VIP Quark account, the download speed may be limited to only a few hundred KB/s.
Also note that Quark Drive will first save the music file to your own Quark account (usually in the "From: Shares (来自: 分享)" folder) and then start the download. Therefore, if your Quark storage is insufficient, the download may fail.
Kugou Music Download
Musicdl currently supports searching and downloading from KuGou Music, and it is used in the same way as other music clients. The only thing to note is that if you need to configure member cookies to download purchased albums/singles or member-exclusive audio quality, the cookies must be in the following format:
{
'KUGOU_API_GUID': 'xxxx',
'KUGOU_API_MID': 'xxxx',
'KUGOU_API_MAC': 'xxxx',
'KUGOU_API_DEV': 'xxxx',
'token': 'xxxx',
'userid': 'xxxx',
'dfid': 'xxxx'
}
You can either use the build_cookies_for_kugou.py script provided in the repo to obtain them directly, or capture the above arguments yourself via network packet capture on the KuGou app or the web client, and then configure musicdl as follows:
from musicdl import musicdl
cookies = {'KUGOU_API_GUID': 'xxxx', 'KUGOU_API_MID': 'xxxx', 'KUGOU_API_MAC': 'xxxx', 'KUGOU_API_DEV': 'xxxx', 'token': 'xxxx', 'userid': 'xxxx', 'dfid': 'xxxx'}
init_music_clients_cfg = {'KugouMusicClient': {'default_search_cookies': cookies, 'search_size_per_source': 5}}
music_client = musicdl.MusicClient(music_sources=['KugouMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Keep in mind that cookie names captured from network traffic may not match the cookie names required by musicdl. You need to map them correctly to construct valid cookies, otherwise, member-only music downloads won’t work.
XimalayaFM and LizhiFM Audio/Radio Download
Musicdl currently also supports searching for and downloading individual audio tracks, as well as entire albums, from long-form audio platforms (e.g., Ximalaya and Lizhi FM) that host podcasts and audiobooks. By default, both modes start simultaneously, and the top few search results for each mode are shown based on the input keyword.
A simple usage example is shown below,
from musicdl import musicdl
init_music_clients_cfg = {'XimalayaMusicClient': {'search_size_per_source': 2}}
music_client = musicdl.MusicClient(music_sources=['XimalayaMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
The result of running the code above looks like this,
You can also choose the search type yourself by setting allowed_search_types, for example:
from musicdl import musicdl
# only search by track
init_music_clients_cfg = {'XimalayaMusicClient': {'search_size_per_source': 2, 'allowed_search_types': ['track']}}
# only search by album
init_music_clients_cfg = {'XimalayaMusicClient': {'search_size_per_source': 2, 'allowed_search_types': ['album']}}
# instance music_client
music_client = musicdl.MusicClient(music_sources=['XimalayaMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
# start
music_client.startcmdui()
Please note that the code above only supports downloading free albums and audio.
If you need to download paid audio, please configure cookies in init_music_clients_cfg, just as you would with other music clients.
QingtingFM Audio/Radio Download
The usage for searching and downloading on the QingTing FM website is similar to Ximalaya and Lizhi FM. The only thing to watch out for is how cookies are set, it differs from typical music client objects.
Specifically, without logging in (i.e., when you don’t need to download paid audio), you can invoke it by running musicdl -m QingtingMusicClient in the command line, or by calling it via the following code:
from musicdl import musicdl
# only search by track
init_music_clients_cfg = {'QingtingMusicClient': {'search_size_per_source': 2, 'allowed_search_types': ['track']}}
# only search by album
init_music_clients_cfg = {'QingtingMusicClient': {'search_size_per_source': 2, 'allowed_search_types': ['album']}}
# search by album and track
init_music_clients_cfg = {'QingtingMusicClient': {'search_size_per_source': 2, 'allowed_search_types': ['album', 'track']}}
# instance music_client
music_client = musicdl.MusicClient(music_sources=['QingtingMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
# start
music_client.startcmdui()
When you need to download paid audio, you’ll have to capture the network traffic yourself on the QingTing FM web client.
Look for an AJAX request with the keyword auth, its response data will look like:
{
"errorno": 0,
"errormsg": "",
"data": {
"qingting_id": "xxxx",
"access_token": "xxx",
"refresh_token": "xxx",
"expires_in": 7200
}
}
Or, use the script build_cookies_for_qingtingfm.py in this repository to retrieve it.
Once you’ve obtained this data, you can configure cookies for QingtingMusicClient as follows:
from musicdl import musicdl
cookies = {"qingting_id": "xxxx", "access_token": "xxx", "refresh_token": "xxx"}
init_music_clients_cfg = {'QingtingMusicClient': {'default_search_cookies': cookies, 'default_download_cookies': cookies, 'search_size_per_source': 3}}
music_client = musicdl.MusicClient(music_sources=['QingtingMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Of course, it’s worth noting that another prerequisite for downloading paid audio is that your account must already have permission to access (listen to) that audio.
TIDAL High-Quality Music Download
Prior to using TIDALMusicClient, verify that the following command-line tools are correctly installed and available in your environment,
If you plan to use musicdl to download high-quality lossless audio from TIDAL, you must have an active TIDAL subscription. Otherwise, musicdl may fall back to third-party sources, and stable access to the highest-quality lossless files cannot be guaranteed.
After you have a TIDAL membership account, you need to manually capture the cookies of your account from the TIDAL website using network packet capturing. The format is as follows:
{
"access_token": "xxx",
"refresh_token": "xxx",
"expires": "2026-02-10T07:32:18.102233",
"user_id": xxx,
"country_code": "SG",
"client_id": "7m7Ap0JC9j1cOM3n",
"client_secret": "vRAdA108tlvkJpTsGZS8rGZ7xTlbJ0qaZ2K9saEzsgY="
}
Of course, musicdl also provides a script build_cookies_for_tidal.py to automatically obtain your TIDAL membership cookies. You can simply run the script and follow the prompts to retrieve the cookies mentioned above.
Once you have successfully obtained your membership cookies, you can use musicdl to download lossless music from TIDAL using the following method,
from musicdl import musicdl
cookies = "YOUR_VIP_COOKIES"
init_music_clients_cfg = {'TIDALMusicClient': {'default_search_cookies': cookies, 'search_size_per_source': 5}}
music_client = musicdl.MusicClient(music_sources=['TIDALMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
YouTube Music Download
If you want to use musicdl to search for and download music from YouTubeMusicClient, you must have Node.js installed, e.g., on Linux, you can install Node.js using the following script:
#!/usr/bin/env bash
set -e
# Install nvm (Node Version Manager)
curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
# Load nvm for this script
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
# Install and use latest LTS Node.js
nvm install --lts
nvm use --lts
# Print versions
node -v
npm -v
On macOS, you can install Node.js using the following script:
#!/usr/bin/env bash
set -e
# Install nvm (Node Version Manager)
curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
# Load nvm for this script
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
# Install and use latest LTS Node.js
nvm install --lts
nvm use --lts
# Print versions
node -v
npm -v
On Windows (PowerShell), you can install Node.js using the following script:
# Install Node.js LTS via winget
winget install --id OpenJS.NodeJS.LTS -e --source winget
# Print hint for version check
Write-Output ""
Write-Output "Please reopen PowerShell and run:"
Write-Output " node -v"
Write-Output " npm -v"
A simple example of searching for and downloading music from YouTubeMusicClient is as follows,
from musicdl import musicdl
music_client = musicdl.MusicClient(music_sources=['YouTubeMusicClient'])
music_client.startcmdui()
SoundCloud Music Download
Musicdl lets you search for and download your favorite songs from SoundCloud. Specifically, you only need to run the following command:
musicdl -m SoundCloudMusicClient
Or you can invoke it with the following code:
from musicdl import musicdl
music_client = musicdl.MusicClient(music_sources=['SoundCloudMusicClient'])
music_client.startcmdui()
The only thing to note is that SoundCloudMusicClient handles login cookies for downloading subscriber-only tracks slightly differently from the other music clients.
You need to capture packets (i.e., sniff the network requests) from SoundCloud’s official website yourself to obtain the Authorization field in the request headers, then fill it in as follows:
from musicdl import musicdl
cookies = {'oauth_token': 'OAuth x-xxxxxx-xxxxxxxxx-xxxxxxx'}
init_music_clients_cfg = {'SoundCloudMusicClient': {'default_search_cookies': cookies, 'default_download_cookies': cookies, 'search_size_per_source': 5}}
music_client = musicdl.MusicClient(music_sources=['SoundCloudMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Apple Music Download
Before using AppleMusicClient, please ensure that the following command-line tools are installed and available in your environment,
Apple Music is like TIDAL, only users with a paid Apple Music subscription can download Apple Music tracks, otherwise, you can only download an approximately 30-90 second preview clip. Specifically, for paid Apple Music users, musicdl supports downloading music files in the following formats,
aac-legacyaac-he-legacyaacaac-heaac-binauralaac-downmixaac-he-binauralaac-he-downmixatmosac3alac
Specifically, if you only need to download tracks in the aac-legacy and aac-he-legacy quality tiers, you just need to make sure that FFmpeg and N_m3u8DL-RE are already installed and available in your environment variables.
Then, set the media-user-token argument you obtained by capturing network traffic from the Apple Music website as follows:
from musicdl import musicdl
from musicdl.modules.sources.apple import SongCodec
cookies = {'media-user-token': xxx}
init_music_clients_cfg = {'AppleMusicClient': {'default_search_cookies': cookies, 'search_size_per_source': 10, 'language': 'en-US', 'codec': SongCodec.AAC_LEGACY}}
music_client = musicdl.MusicClient(music_sources=['AppleMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
However, if you need to download higher-quality audio (e.g., alac), the setup is relatively more complex.
First, follow the wrapper guide and start the wrapper server (❗ note that Windows users need to download and install WSL first, followed by installing Ubuntu on WSL, and finally start the wrapper server within Ubuntu, otherwise, decryption will most likely fail ❗).
Then, in addition to FFmpeg and N_m3u8DL-RE, you also need to install Bento4 and amdecrypt.
Finally, configure your musicdl as follows:
from musicdl import musicdl
from musicdl.modules.sources.apple import SongCodec
init_music_clients_cfg = {'AppleMusicClient': {
'search_size_per_source': 10,
'language': 'en-US',
'codec': SongCodec.ALAC,
'use_wrapper': True,
'wrapper_account_url': 'http://127.0.0.1:30020/',
'wrapper_decrypt_ip': '127.0.0.1:10020',
}}
music_client = musicdl.MusicClient(music_sources=['AppleMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
Note that the wrapper_account_url and wrapper_decrypt_ip settings must match the corresponding arguments configured in your wrapper server.
GD Studio Music Download
We’ve added GDStudioMusicClient to musicdl as a practical solution for users who are on a tight budget or who find it difficult to configure extra command-line tools/arguments for musicdl.
With only the basic installation of musicdl, you can search for and download high-quality music files from the following music platforms:
| Source (EN) | Source (CN) | Official Websites | allowed_music_sources |
|---|---|---|---|
| Spotify | Spotify | https://www.spotify.com | spotify |
| Tencent (QQ Music) | QQ音乐 | https://y.qq.com | tencent |
| NetEase Cloud Music | 网易云音乐 | https://music.163.com | netease |
| Kuwo | 酷我音乐 | https://www.kuwo.cn | kuwo |
| TIDAL | TIDAL | https://tidal.com | tidal |
| Qobuz | Qobuz | https://www.qobuz.com | qobuz |
| JOOX | JOOX | https://www.joox.com | joox |
| Bilibili | 哔哩哔哩 | https://www.bilibili.com | bilibili |
| Apple Music | 苹果音乐 | https://www.apple.com/apple-music/ | apple |
| YouTube Music | 油管音乐 | https://music.youtube.com | ytmusic |
Specifically, you just need to write and run a few lines of code like this
(song retrieval from YouTube and Tencent is unstable, so musicdl disables these two sources by default.
You can manually enable them by setting allowed_music_sources.):
from musicdl import musicdl
music_client = musicdl.MusicClient(music_sources=['GDStudioMusicClient'])
music_client.startcmdui()
Or, equivalently, run the following command in the command line:
musicdl -m GDStudioMusicClient
By default, the above code will search for and download music from eight music platforms, excluding YouTube and Tencent Music (as using GDStudioMusicClient for search and download on both platforms seems to be unstable).
The screenshot of the running result is as follows:
However, please note that this way of running is not very stable (e.g., some sources may fail to find any valid songs) and is likely to exceed the limit on the number of requests per minute allowed for a single IP by GDStudioMusicClient.
If you still wish to perform a full-platform search, we recommend modifying the default arguments as follows:
from musicdl import musicdl
init_music_clients_cfg = {'GDStudioMusicClient': {'search_size_per_source': 1}}
music_client = musicdl.MusicClient(music_sources=['GDStudioMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
The equivalent command in the command line is:
musicdl -m GDStudioMusicClient -i "{'GDStudioMusicClient': {'search_size_per_source': 1}}"
Or, an even better option is to manually specify a few platforms where you believe your desired music files are likely to be found, for example:
from musicdl import musicdl
# allowed_music_sources can be set to any subset (i.e., any combination) of ['spotify', 'tencent', 'netease', 'kuwo', 'tidal', 'qobuz', 'joox', 'bilibili', 'apple', 'ytmusic']
init_music_clients_cfg = {'GDStudioMusicClient': {'search_size_per_source': 5, 'allowed_music_sources': ['spotify', 'qobuz', 'tidal', 'apple']}}
music_client = musicdl.MusicClient(music_sources=['GDStudioMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
The way to run it from the command line is similar:
musicdl -m GDStudioMusicClient -i "{'GDStudioMusicClient': {'search_size_per_source': 5, 'allowed_music_sources': ['spotify', 'qobuz', 'tidal', 'apple']}}"
TuneHub Music Download
TuneHubMusicClient is actually quite similar to GDStudioMusicClient, as it allows music search and download from multiple music platforms.
However, it primarily supports music platforms in Mainland China and offers fewer music sources compared to GDStudioMusicClient.
Specifically, the list of platforms it currently supports is as follows:
| Source (EN) | Source (CN) | Official Websites | allowed_music_sources |
|---|---|---|---|
| Tencent (QQ Music) | QQ音乐 | https://y.qq.com | qq |
| NetEase Cloud Music | 网易云音乐 | https://music.163.com | netease |
| Kuwo | 酷我音乐 | https://www.kuwo.cn | kuwo |
Specifically, you can call it using the following code:
from musicdl import musicdl
music_client = musicdl.MusicClient(music_sources=['TuneHubMusicClient'])
music_client.startcmdui()
Alternatively, you can directly run the following command in the terminal:
musicdl -m TuneHubMusicClient
The screenshot of the running result is as follows:
JBSou Music Download
JBSouMusicClient’s functionality is similar to TuneHubMusicClient’s.
Both are third-party APIs that consolidate music search and download functions from multiple platforms into a single interface.
The key difference is that JBSouMusicClient focuses on searching and downloading 320 kbps MP3 audio files.
The list of music platforms it currently supports is as follows:
| Source (EN) | Source (CN) | Official Websites | allowed_music_sources |
|---|---|---|---|
| Tencent (QQ Music) | QQ音乐 | https://y.qq.com | qq |
| NetEase Cloud Music | 网易云音乐 | https://music.163.com | netease |
| Kuwo | 酷我音乐 | https://www.kuwo.cn | kuwo |
| Kugou | 酷狗音乐 | https://www.kugou.com/ | kugou |
More specifically, its invocation is as follows,
from musicdl import musicdl
init_music_clients_cfg = {'JBSouMusicClient': {'search_size_per_source': 5, 'allowed_music_sources': ['qq', 'netease', 'kuwo', 'kugou']}}
music_client = musicdl.MusicClient(music_sources=['JBSouMusicClient'], init_music_clients_cfg=init_music_clients_cfg)
music_client.startcmdui()
The screenshot of the running result is as follows:
For more details, please refer to the official documentation.
⭐ Recommended Projects
| Project | ⭐ Stars | 📦 Version | ⏱ Last Update | 🛠 Repository |
|---|---|---|---|---|
| 🎵 Musicdl 轻量级无损音乐下载器 |
🛠 Repository | |||
| 🎬 Videodl 轻量级高清无水印视频下载器 |
🛠 Repository | |||
| 🖼️ Imagedl 轻量级海量图片搜索下载器 |
🛠 Repository | |||
| 🌐 FreeProxy 全球海量高质量免费代理采集器 |
🛠 Repository | |||
| 🌐 MusicSquare 简易音乐搜索下载和播放网页 |
🛠 Repository | |||
| 🌐 FreeGPTHub 真正免费的GPT统一接口 |
🛠 Repository |
📚 Citation
If you use this project in your research, please cite the repository.
@misc{musicdl2020,
author = {Zhenchao Jin},
title = {Musicdl: A lightweight music downloader written in pure python},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/CharlesPikachu/musicdl}},
}
🌟 Star History
☕ Appreciation (赞赏 / 打赏)
| WeChat Appreciation QR Code (微信赞赏码) | Alipay Appreciation QR Code (支付宝赞赏码) |
|---|---|
📢 WeChat Official Account (微信公众号):
Charles的皮卡丘 (Charles_pikachu)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file musicdl-2.9.5.tar.gz.
File metadata
- Download URL: musicdl-2.9.5.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b9620ef9ccf57e51cac0ffb5a7d65f8abf584307dec5db0c762ba95d2a9c7da
|
|
| MD5 |
152b2dee3a54f9bf6a8c434d8694eda0
|
|
| BLAKE2b-256 |
e52046df757f9eee7c607a3f1e67844cfb2710ac1fa883ee983623ff878e2474
|
File details
Details for the file musicdl-2.9.5-py3-none-any.whl.
File metadata
- Download URL: musicdl-2.9.5-py3-none-any.whl
- Upload date:
- Size: 1.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17520783051b7d2458080563319fc5c7a7800f2877836a668243e3003a91059f
|
|
| MD5 |
4052ec040de9047a3b9fe7c9724a09e3
|
|
| BLAKE2b-256 |
5fc591e3a31c8c5d3ee3f973f092f15457a8673c043f4d586cb0b0fb1eb6b02b
|