yt-dlp migration (scdl v3.0.0)

.github/workflows/ci.yml

@@ -10,26 +10,30 @@ jobs:
   test:
     strategy:
       matrix:
-        version: ['3.8', '3.12']
+        version: ['3.9', '3.13']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.version }}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.version }}
+        version: '0.8.8'
     - name: Install dependencies
-      run: |
-        pip install -e .[dev]
+      run: uv sync
     - name: Lint
       if: '!cancelled()'
-      run: ruff check --output-format=github
+      run: uv run ruff check --output-format=github
     - name: Format check
       if: '!cancelled()'
-      run: ruff format --check
+      run: uv run ruff format --check
     - name: Type check
       if: '!cancelled()'
-      run: mypy
+      run: uv run mypy
     - name: Install ffmpeg
       run: |
         sudo apt update
@@ -38,8 +42,7 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         AUTH_TOKEN: ${{ secrets.AUTH_TOKEN }}
-      run: |
-        pytest -vv --exitfirst
+      run: uv run pytest -vv --exitfirst
   publish:
     needs: test
     if: startsWith(github.ref, 'refs/tags/v')
@@ -49,14 +52,16 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.9
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: 3.9
+        version: '0.8.8'
     - name: Install dependencies
-      run: |
-        pip install -e .
+      run: uv sync
     - name: Build package
-      run: |
-        pip install --upgrade build
-        python -m build
+      run: uv build
     - name: Publish package
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

.gitignore

@@ -4,10 +4,13 @@ dist/
 *.egg-info/
 __pycache__/
 *.mp3
+*.opus
+*.m4a
+*.flac
 .vscode
 .venv
 .env
 .coverage*
 .idea
 .python-version
-.DS_store
+.DS_Store

README.md

@@ -1,10 +1,16 @@
 # Soundcloud Music Downloader
+
+## Status of the project
+
+As of version 3, this script is a wrapper around `yt-dlp` with some defaults/patches for backwards compatibility.
+Development is not active and new features will likely not be merged, especially if they can be covered with the
+use of `--yt-dlp-args`. Bug reports/fixes are welcome.
+
 ## Description
 
 This script is able to download music from SoundCloud and set id3tag to the downloaded music.
 Compatible with Windows, OS X, Linux.
 
-
 ## System requirements
 
 * python3
@@ -91,6 +97,7 @@ scdl me -f
 --add-description               Adds the description to a seperate txt file (can be read by some players)
 --no-playlist                   Skip downloading playlists
 --opus                          Prefer downloading opus streams over mp3 streams
+--yt-dlp-args                   String with custom args to forward to yt-dlp
 ```
 
 

pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "scdl"
+version = "3.0.0"
+authors=[
+    {name = "7x11x13"}, {name = "FlyinGrub"}
+]
+description = "Download Music from Souncloud"
+readme = "README.md"
+requires-python = ">=3.9.0"
+dependencies = [
+    "docopt-ng>=0.9.0",
+    "mutagen>=1.47.0",
+    "soundcloud-v2>=1.6.0",
+    "yt-dlp>=2025.2.19",
+]
+classifiers = [
+    "Programming Language :: Python",
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet",
+    "Topic :: Multimedia :: Sound/Audio",
+]
+
+[dependency-groups]
+dev = [
+    "music-tag>=0.4.3",
+    "mypy>=1.13.0",
+    "pytest>=8.3.4",
+    "pytest-dotenv>=0.5.2",
+    "ruff>=0.8.3",
+    "types-requests>=2.32.0.20241016",
+    "typing_extensions>=4.12.2; python_version < '3.11'",
+]
+
+[project.urls]
+Issues = "https://github.com/scdl-org/scdl/issues"
+Repository = "https://github.com/scdl-org/scdl"
+Changelog = "https://github.com/scdl-org/scdl/blob/master/CHANGELOG.md"
+
+[project.scripts]
+scdl = "scdl.scdl:_main"
+
+[tool.uv]
+package = true
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "ANN",
+    "C90", "D",
+    "S", "BLE", "FBT", "A", "EM", "FA", "G", "SLF", "PTH",
+    "PLR", "TRY",
+    "PLW2901", "ANN204",
+    "COM812", "ISC001",
+    "EXE"
+]
+
+[tool.mypy]
+packages = ["scdl", "tests"]
+check_untyped_defs = true
+disable_error_code = ["import-untyped"]
+
+[[tool.mypy.overrides]]
+module = "scdl.patches.*"
+ignore_errors = true

scdl/__init__.py

@@ -1,3 +1,6 @@
 """Python Soundcloud Music Downloader."""
 
-__version__ = "v2.12.4"
+from . import patches  # noqa: F401, I001
+from scdl.scdl import download_url
+
+__all__ = ["download_url"]