Release V4 Release Candidate 4

Author: xnetcat

.github/workflows/build-docs.yml

@@ -5,7 +5,6 @@ on:
     # branches to consider in the event; optional, defaults to all
     branches:
       - master
-      - dev
 
 jobs:
   deploy:

.github/workflows/tests.yml

@@ -3,11 +3,11 @@ name: Tests (Pytest)
 on: [push, pull_request]
 
 jobs:
-  test:
+  test-vcr:
     if: "!contains(github.event.commits[0].message, '[skip ci]')"
     runs-on: ${{ matrix.platform }}
     strategy:
-      max-parallel: 2
+      max-parallel: 4
       matrix:
         platform: [ ubuntu-latest, macos-latest, windows-latest ]
         python-version: [ "3.7", "3.10" ]
@@ -36,6 +36,42 @@ jobs:
 
       - name: Run tests
         run: |
-          poetry run pytest --disable-vcr -vvv --vcr-record=none --ignore tests/utils/test_github.py --ignore tests/providers/lyrics/
+          poetry run pytest -vvv
+        env:
+          PLATFORM: ${{ matrix.platform }}
+
+  test:
+    if: "!contains(github.event.commits[0].message, '[skip ci]')"
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      max-parallel: 1
+      matrix:
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python "3.10"
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: 'poetry'
+
+      - name: Install dependencies
+        run: |
+          poetry env use "3.10"
+          poetry install
+
+      - uses: FedericoCarboni/setup-ffmpeg@v1
+        id: setup-ffmpeg
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run tests
+        run: |
+          poetry run pytest -vvv --disable-vcr --vcr-record=none --ignore tests/providers/lyrics --ignore tests/utils/test_github.py
         env:
           PLATFORM: ${{ matrix.platform }}

README.md

@@ -1,6 +1,6 @@
 <!--- mdformat-toc start --slug=github --->
 
-<!--- 
+<!---
 !!! IF EDITING THE README, ENSURE TO COPY THE WHOLE FILE TO index.md in `/docs/`
 --->
 
@@ -25,7 +25,7 @@ Download your Spotify playlists and songs along with album art and metadata
 
 Please note that v4 is still being worked on, is **not yet fully stable** and unreleased.
 
-To install v4's latest release candidate run `pip install -U --force spotdl==4.0.0rc3`
+To install v4's latest release candidate run `pip install -U --force spotdl==4.0.0rc4`
 > This is correct, the below commands will not install v4.
 
 To install v3 or downgrade to it, run `pip install -U --force spotdl==3.9.6`
@@ -77,7 +77,7 @@ Refer to our [Installation Guide](https://spotdl.rtfd.io/en/latest/installation/
 
 ### Installing FFmpeg
 
-If using FFmpeg only for spotDL, you can install FFmpeg to your local directory.  
+If using FFmpeg only for spotDL, you can install FFmpeg to your local directory.
 `spotdl --download-ffmpeg` will download FFmpeg to your spotDL installation directory.
 
 We recommend the above option, but if you want to install FFmpeg system-wide,

docs/usage.md

@@ -203,8 +203,9 @@ If you don't want config to load automatically change `load_config` option in co
         "youtube-music"
     ],
     "lyrics_providers": [
+        "genius",
+        "azlyrics"
         "musixmatch",
-        "genius"
     ],
     "ffmpeg": "ffmpeg",
     "bitrate": null,
@@ -227,7 +228,8 @@ If you don't want config to load automatically change `load_config` option in co
     "restrict": false,
     "print_errors": false,
     "sponsor_block": false,
-    "preload": false
+    "preload": false,
+    "archive": null
 }
 ```
 
@@ -240,12 +242,13 @@ options:
   -h, --help            show this help message and exit
 
 Main options:
-  {download,save,web,sync}
+  {download,save,web,sync,meta}
                         The operation to perform.
                         download: Download the songs to the disk and embed metadata.
                         save: Saves the songs metadata to a file for further use.
                         web: Starts a web interface to simplify the download process.
-                        sync: removes songs that are no longer present, downloads new ones
+                        sync: Removes songs that are no longer present, downloads new ones
+                        meta: Update your audio files with metadata
   query                 Spotify URL for a song/playlist/album/artist/etc. to download.For manual audio matching, you can use the format 'YouTubeURL|SpotifyURL'
   --audio [{youtube,youtube-music} ...]
                         The audio provider to use. You can provide more than one for fallback.
@@ -255,11 +258,12 @@ Main options:
   --search-query SEARCH_QUERY
                         The search query to use, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count}, {duration}, {year}, {original-
                         date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
-  --dont-filter-results
+  --dont-filter-results FILTER_RESULTS
                         Disable filtering results.
 
 Spotify options:
-  --user-auth           Login to Spotify using OAuth.
+  --user-auth USER_AUTH
+                        Login to Spotify using OAuth.
   --client-id CLIENT_ID
                         The client id to use when logging in to Spotify.
   --client-secret CLIENT_SECRET
@@ -290,11 +294,12 @@ Output options:
   --output OUTPUT       Specify the downloaded file name format, available variables: {title}, {artists}, {artist}, {album}, {album-artist}, {genre}, {disc-number}, {disc-count}, {duration},
                         {year}, {original-date}, {track-number}, {tracks-count}, {isrc}, {track-id}, {publisher}, {list-length}, {list-position}, {list-name}, {output-ext}
   --m3u M3U             Name of the m3u file to save the songs to.
-  --overwrite {skip,force}
+  --overwrite {skip,force,meta}
                         Overwrite existing files.
   --restrict            Restrict filenames to ASCII only
   --print-errors        Print errors (wrong songs, failed downloads etc) on exit, useful for long playlist
   --sponsor-block       Use the sponsor block to download songs from yt/ytm.
+  --archive ARCHIVE     Specify the file name for an archive of already downloaded songs
 
 Misc options:
   --log-level {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}