v4.2.5

.github/workflows/tests.yml

@@ -37,7 +37,7 @@ jobs:
 
       - name: Run tests
         run: |
-          poetry run pytest -vvv --ignore tests/test_matching.py --ignore tests/utils/test_ffmpeg.py --ignore tests/utils/test_metadata.py
+          poetry run pytest -vvv --ignore tests/test_matching.py --ignore tests/utils/test_ffmpeg.py --ignore tests/utils/test_metadata.py --ignore tests/providers/lyrics/test_azlyrics.py --ignore tests/providers/lyrics/test_musixmatch.py 
         env:
           PLATFORM: ${{ matrix.platform }}
 
@@ -73,6 +73,6 @@ jobs:
 
       - name: Run tests
         run: |
-          poetry run pytest -vvv --disable-vcr --vcr-record=none --ignore tests/providers/lyrics --ignore tests/utils/test_github.py --ignore tests/utils/test_ffmpeg.py --ignore tests/utils/test_metadata.py
+          poetry run pytest -vvv --record-mode=none --disable-recording --ignore tests/providers/lyrics --ignore tests/utils/test_github.py --ignore tests/utils/test_ffmpeg.py --ignore tests/utils/test_metadata.py
         env:
           PLATFORM: ${{ matrix.platform }}

.gitignore

@@ -1,4 +1,8 @@
+# Ignore IDE folders
+.idea
+
 # Spotdl stuff
+*.skip
 *.mp3
 *.m4a
 *.wav

docs/usage.md

@@ -288,6 +288,7 @@ If you don't want config to load automatically change `load_config` option in co
     "format": "mp3",
     "save_file": null,
     "filter_results": true,
+    "album_type": null,
     "threads": 4,
     "cookie_file": null,
     "restrict": null,
@@ -310,7 +311,8 @@ If you don't want config to load automatically change `load_config` option in co
     "keep_alive": false,
     "allowed_origins": null,
     "keep_sessions": false,
-    "only_verified_results": false
+    "only_verified_results": false,
+    "skip_album_art": false
 }
 ```
 
@@ -382,6 +384,8 @@ Main options:
                         {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
   --dont-filter-results
                         Disable filtering results.
+  --album-type {single, album}
+                        Type of the album to filter the songs
   --only-verified-results
                         Use only verified results. (Not all providers support this)
 
@@ -454,10 +458,13 @@ Output options:
   --detect-formats [{mp3,flac,ogg,opus,m4a,wav} ...]
                         Detect already downloaded songs with file format different from the --format option (When combined with --m3u option, only first detected format will be added to m3u file)
   --redownload          to redownload the local song in diffrent format using --format for meta operation
+  --skip-album-art      Skip downloading album art for meta operation
   --ignore-albums [IGNORE_ALBUMS ...]
                         ignores the song of the given albums
   --skip-explicit       Skip explicit songs
   --proxy PROXY         Http(s) proxy server for download song. Example: http://host:port
+  --create-skip-file    Create skip file for successfully downloaded file
+  --respect-skip-file   If a file with the extension .skip exists, skip download
 
 Web options:
   --host HOST           The host to use for the web server.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spotdl"
-version = "4.2.4"
+version = "4.2.5"
 description = "Download your Spotify playlists and songs along with album art and metadata"
 license = "MIT"
 authors = ["spotDL Team <spotdladmins@googlegroups.com>"]
@@ -30,54 +30,57 @@ classifiers = [
 python = ">=3.8,<3.13"
 
 spotipy = "^2.23.0"
-ytmusicapi = "^1.3.2"
+ytmusicapi = [
+    {version = "^1.3.2", python = "<3.10"},
+    {version = "^1.4.1", python = ">=3.10"},
+]
 pytube = "^15.0.0"
-yt-dlp = "^2023.11.16"
+yt-dlp = "^2024.3.10"
 mutagen = "^1.47.0"
-rich = "^13.7.0"
-beautifulsoup4 = "^4.12.2"
+rich = "^13.7.1"
+beautifulsoup4 = "^4.12.3"
 requests = "^2.31.0"
-rapidfuzz = "^3.5.2"
-python-slugify = {extras = ["unidecode"], version = "^8.0.1"}
+rapidfuzz = "^3.7.0"
+python-slugify = {extras = ["unidecode"], version = "^8.0.4"}
 uvicorn = "^0.23.2"
-pydantic = "^2.5.2"
+pydantic = "^2.6.4"
 fastapi = "^0.103.0"
-platformdirs = "^3.11.0"
+platformdirs = "^4.2.0"
 pykakasi = "^2.2.1"
 syncedlyrics = "^0.7.0"
-soundcloud-v2 = "^1.3.1"
-setuptools = "^69.0.2"
+soundcloud-v2 = "^1.3.7"
+setuptools = "^69.2.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.4.3"
-pytest-mock = "^3.12.0"
-pytest-vcr = "^1.0.2"
-pyfakefs = "^5.3.2"
-pytest-cov = "^4.1.0"
+pytest = "^8.1.1"
+pytest-mock = "^3.14.0"
+pyfakefs = "^5.3.5"
+pytest-cov = "^5.0.0"
 pytest-subprocess = "^1.5.0"
 pytest-asyncio = "^0.21.1"
-mypy = "^1.7.1"
-pylint = "^3.0.2"
-black = "^23.11.0"
+mypy = "^1.9.0"
+pylint = "^3.1.0"
+black = "^24.3.0"
 mdformat-gfm = "^0.3.5"
 types-orjson = "^3.6.2"
-types-python-slugify = "^8.0.0.3"
+types-python-slugify = "^8.0.2.20240310"
 types-requests = "==2.31.0.6"
-types-setuptools = "^69.0.0.0"
+types-setuptools = "^69.2.0.20240317"
 types-toml = "^0.10.8.7"
-types-ujson = "^5.8.0.1"
-pyinstaller = "^6.2.0"
+types-ujson = "^5.9.0.0"
+pyinstaller = "^6.5.0"
 mkdocs = "^1.5.3"
-isort = "^5.12.0"
+isort = "^5.13.2"
 dill = "^0.3.7"
-mkdocs-material = "^9.4.14"
+mkdocs-material = "^9.5.15"
 mkdocstrings = "^0.22.0"
-mkdocstrings-python = "^1.7.5"
-pymdown-extensions = "^10.5"
+mkdocstrings-python = "^1.9.0"
+pymdown-extensions = "^10.7.1"
 mkdocs-gen-files = "^0.5.0"
 mkdocs-literate-nav = "^0.6.0"
 mkdocs-section-index = "^0.3.5"
-vcrpy = "^5.1.0"
+vcrpy = "^6.0.1"
+pytest-recording = "^0.13.1"
 
 [tool.poetry.scripts]
 spotdl = "spotdl:console_entry_point"

scripts/termux.sh

@@ -5,7 +5,7 @@ termux-setup-storage
 pkg update -y
 
 # install python and ffmpeg
-pkg install -y python ffmpeg
+pkg install -y python ffmpeg rust binutils
 
 # install spotdl
 pip install -U spotdl
@@ -30,4 +30,4 @@ if [[ $1 == *"open.spotify.com"* ]]; then
     $SPOTDL "$1"
     read -n 1 -s -p "Press Any Key To Exit."
 fi
-EOL
+EOL

spotdl/__init__.py

@@ -100,10 +100,11 @@ def search(self, query: List[str]) -> List[Song]:
         """
 
         return parse_query(
-            query,
-            self.downloader.settings["threads"],
-            self.downloader.settings["ytm_data"],
-            self.downloader.settings["playlist_numbering"],
+            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"],
         )
 
     def get_download_urls(self, songs: List[Song]) -> List[Optional[str]]:

spotdl/_version.py

@@ -2,4 +2,4 @@
 Version module for spotdl.
 """
 
-__version__ = "4.2.4"
+__version__ = "4.2.5"

spotdl/console/download.py

@@ -27,6 +27,7 @@ def download(
         use_ytm_data=downloader.settings["ytm_data"],
         playlist_numbering=downloader.settings["playlist_numbering"],
         albums_to_ignore=downloader.settings["ignore_albums"],
+        album_type=downloader.settings["album_type"],
     )
 
     # Download the songs

spotdl/console/entry_point.py

@@ -92,6 +92,11 @@ def console_entry_point():
     # If the application is frozen start web ui
     # or if the operation is `web`
     if is_executable() or arguments.operation == "web":
+
+        # Default to the current directory when running a frozen application
+        if is_executable():
+            web_settings["web_use_output_dir"] = True
+
         # Start web ui
         web(web_settings, downloader_settings)
 
@@ -138,7 +143,15 @@ def graceful_exit(_signal, _frame):
             query=arguments.query,
             downloader=downloader,
         )
-    except Exception:
+    except Exception as exc:
+        if downloader_settings["save_errors"]:
+            with open(
+                downloader_settings["save_errors"], "a", encoding="utf-8"
+            ) as error_file:
+                error_file.write("\n".join([exc + "\n" for exc in exc.args]))
+
+            logger.debug("Saved errors to %s", downloader_settings["save_errors"])
+
         end_time = time.perf_counter()
         logger.debug("Took %d seconds", end_time - start_time)
 

spotdl/console/meta.py

@@ -130,7 +130,7 @@ def process_file(file: Path):
             song.lyrics = song_meta.get("lyrics")
 
         # Apply metadata to the song
-        embed_metadata(file, song)
+        embed_metadata(file, song, skip_album_art=downloader.settings["skip_album_art"])
 
         logger.info("Applied metadata to %s", file.name)
 
@@ -171,10 +171,11 @@ async def pool_worker(file_path: Path) -> None:
                 songs_url.append(meta_data["url"])
 
         songs_list = parse_query(
-            songs_url,
-            downloader.settings["threads"],
-            downloader.settings["ytm_data"],
-            downloader.settings["playlist_numbering"],
+            query=songs_url,
+            threads=downloader.settings["threads"],
+            use_ytm_data=downloader.settings["ytm_data"],
+            playlist_numbering=downloader.settings["playlist_numbering"],
+            album_type=downloader.settings["album_type"],
         )
 
         downloader.download_multiple_songs(songs_list)

spotdl/console/save.py

@@ -42,10 +42,11 @@ def save(
 
     # Parse the query
     songs = parse_query(
-        query,
-        downloader.settings["threads"],
-        downloader.settings["ytm_data"],
-        downloader.settings["playlist_numbering"],
+        query=query,
+        threads=downloader.settings["threads"],
+        use_ytm_data=downloader.settings["ytm_data"],
+        playlist_numbering=downloader.settings["playlist_numbering"],
+        album_type=downloader.settings["album_type"],
     )
     save_data = [song.json for song in songs]
 

spotdl/console/sync.py

@@ -50,10 +50,11 @@ def sync(
 
         # Parse the query
         songs_list = parse_query(
-            query,
-            downloader.settings["threads"],
-            downloader.settings["ytm_data"],
-            downloader.settings["playlist_numbering"],
+            query=query,
+            threads=downloader.settings["threads"],
+            use_ytm_data=downloader.settings["ytm_data"],
+            playlist_numbering=downloader.settings["playlist_numbering"],
+            album_type=downloader.settings["album_type"],
         )
 
         # Create sync file
@@ -101,10 +102,11 @@ def sync(
 
         # Parse the query
         songs_playlist = parse_query(
-            sync_data["query"],
-            downloader.settings["threads"],
-            downloader.settings["ytm_data"],
-            downloader.settings["playlist_numbering"],
+            query=sync_data["query"],
+            threads=downloader.settings["threads"],
+            use_ytm_data=downloader.settings["ytm_data"],
+            playlist_numbering=downloader.settings["playlist_numbering"],
+            album_type=downloader.settings["album_type"],
         )
 
         # Get the names and URLs of previously downloaded songs from the sync file

spotdl/console/url.py

@@ -28,10 +28,11 @@ def url(
 
     # Parse the query
     songs = parse_query(
-        query,
-        downloader.settings["threads"],
-        downloader.settings["ytm_data"],
-        downloader.settings["playlist_numbering"],
+        query=query,
+        threads=downloader.settings["threads"],
+        use_ytm_data=downloader.settings["ytm_data"],
+        playlist_numbering=downloader.settings["playlist_numbering"],
+        album_type=downloader.settings["album_type"],
     )
 
     def process_song(song: Song):

spotdl/console/web.py

@@ -82,9 +82,11 @@ def web(web_settings: WebOptions, downloader_settings: DownloaderOptions):
     # Add the CORS middleware
     app_state.api.add_middleware(
         CORSMiddleware,
-        allow_origins=ALLOWED_ORIGINS + web_settings["allowed_origins"]
-        if web_settings["allowed_origins"]
-        else ALLOWED_ORIGINS,
+        allow_origins=(
+            ALLOWED_ORIGINS + web_settings["allowed_origins"]
+            if web_settings["allowed_origins"]
+            else ALLOWED_ORIGINS
+        ),
         allow_credentials=True,
         allow_methods=["*"],
         allow_headers=["*"],