mirror of
https://github.com/darkzoul5/YoutubePlaylistSync.git
synced 2026-07-04 04:53:58 +03:00
Compare commits
149 Commits
1.0.0
...
e7f1dbc1f7
| Author | SHA1 | Date | |
|---|---|---|---|
| e7f1dbc1f7 | |||
| 8e3a7e3920 | |||
| 5d4cba3df3 | |||
| b17913e21b | |||
| 98fab7838a | |||
| 1928f70928 | |||
| 4cd6255b0f | |||
| e8535d335d | |||
| 0cd693d07a | |||
| bf57bd77e6 | |||
| da8bf1786c | |||
| e4e342adf5 | |||
| 1ea4352737 | |||
| 812664051f | |||
| 53b7303049 | |||
| 7715d53bba | |||
| f886ebcd12 | |||
| 3faf76e097 | |||
| dc3403eb9e | |||
| ea41c3c67f | |||
| 1f636fe9d2 | |||
| c736957e3c | |||
| cca8fad387 | |||
| 234e616cee | |||
| e54af9f2be | |||
| e112a7eeb7 | |||
| fa0f9a02ce | |||
| 7e22aae1a0 | |||
| 08e1e322f1 | |||
| e5ad786bcf | |||
| abd3c2ed62 | |||
| 6d8649ac2d | |||
| 658def3d58 | |||
| 0ab96e4399 | |||
| 0cea4cfcb8 | |||
| 04a7367d19 | |||
| 760b6c2f94 | |||
| d7a05c5f52 | |||
| 93522423ae | |||
| e52dbdcb2e | |||
| 543dd39618 | |||
| a841fb4fd8 | |||
| 2b843ab322 | |||
| ef57b2e79e | |||
| e8d955ab08 | |||
| c0b919953d | |||
| 5ab5dcbaf1 | |||
| df6b1655cd | |||
| e4f0d0c97a | |||
| 22ad7af3e8 | |||
| e53b91f0e6 | |||
| da6e939c1d | |||
| a5ffa38785 | |||
| 40c2839ffc | |||
| 0c8de9aebb | |||
| eeb01117c3 | |||
| 25c833435f | |||
| 8106fa1f04 | |||
| b6afbb33c1 | |||
| 2e1ebe1eea | |||
| ce777a59b3 | |||
| 10ac547458 | |||
| 77108cb1a8 | |||
| a81f69280f | |||
| 148322cfb7 | |||
| 46a31fa0f7 | |||
| e3559118c1 | |||
| 33f8a4e72f | |||
| 1a1225459e | |||
| 1b7e2a70dd | |||
| 4a82a8f435 | |||
| c282501444 | |||
| eb69f6f736 | |||
| d7da1d0588 | |||
| 90f2842fb6 | |||
| 0d1c0403f2 | |||
| d197e14425 | |||
| d2556185b8 | |||
| 09a0b513d7 | |||
| 6da6472173 | |||
| c14cf8cd51 | |||
| a68e21444e | |||
| 8133f28488 | |||
| 1b0df9dd33 | |||
| aaa02c8eb1 | |||
| 27d571876f | |||
| 6589cd5a95 | |||
| 951b485e4e | |||
| 94db632043 | |||
| 7b6e0c094e | |||
| e38099698c | |||
| 9e5540b89b | |||
| c339443fd5 | |||
| f1558c5181 | |||
| dc534f583e | |||
| 3598a41284 | |||
| 537c49be86 | |||
| 0d60ed99fb | |||
| 491e6764b7 | |||
| 279cb0900b | |||
| 11bb420f19 | |||
| 8c99edf3ac | |||
| 1d8dab1bfb | |||
| b91d3f4c48 | |||
| 70e90ce9be | |||
| 5eecf5fd08 | |||
| 3d813200a5 | |||
| 6ccb869c3c | |||
| 4a56c03b62 | |||
| 1d99fd2b10 | |||
| b5ee8dbf3b | |||
| 21ba87c501 | |||
| 681291c79e | |||
| 5c9d0b3255 | |||
| 9c241a45ec | |||
| d2127b2b2c | |||
| 3d8a634241 | |||
| b88c23a476 | |||
| 961e43c43b | |||
| 058c1b9fd0 | |||
| 75c8993bb4 | |||
| 07c4533cba | |||
| 7b704a1e21 | |||
| 6631a4bd40 | |||
| 3bff5dda49 | |||
| fd3af146ae | |||
| 15414c56fa | |||
| 05355f54fc | |||
| 5eae107475 | |||
| 9f8a0e8449 | |||
| aff5dda8e5 | |||
| bf211fc176 | |||
| 5acafcadb3 | |||
| 4eff4a5536 | |||
| 7dfa83565c | |||
| 98afb8c74e | |||
| 599a0751b9 | |||
| e1ec65094f | |||
| 1402af52d6 | |||
| b64e39a95f | |||
| fc72bc161c | |||
| 6a0c5bd120 | |||
| eb7c059155 | |||
| f47eccbb07 | |||
| 41359edc51 | |||
| f41e82e17a | |||
| 1223335370 | |||
| f2a4bcbbe1 | |||
| 9f0c44c1a3 |
@@ -0,0 +1,16 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: pip
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: daily
|
||||
time: "10:00"
|
||||
groups:
|
||||
python-packages:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
@@ -0,0 +1,262 @@
|
||||
name: Build Release V2
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: "Release tag (e.g., v0.1.0)"
|
||||
required: true
|
||||
default: "v0.1.0"
|
||||
type: string
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: '3.11'
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install pytest
|
||||
- name: Run tests
|
||||
env:
|
||||
PYTHONPATH: ${{ github.workspace }}
|
||||
run: pytest
|
||||
|
||||
build:
|
||||
needs: test
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- platform: windows
|
||||
os: windows-latest
|
||||
artifact_name: windows-release
|
||||
- platform: linux
|
||||
os: ubuntu-latest
|
||||
artifact_name: linux-release
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Get version
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
TAG="${{ github.event.inputs.tag || inputs.tag }}"
|
||||
VERSION="${TAG#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
# --- WINDOWS BUILD ---
|
||||
- name: Build Windows Package
|
||||
if: matrix.platform == 'windows'
|
||||
shell: pwsh
|
||||
run: |
|
||||
$VERSION = "${{ steps.version.outputs.version }}"
|
||||
$WORKSPACE = "${{ github.workspace }}"
|
||||
New-Item -ItemType Directory -Force -Path "$WORKSPACE/dist/windows/bin"
|
||||
|
||||
# yt-dlp
|
||||
Invoke-WebRequest -Uri "https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe" -OutFile "$WORKSPACE/dist/windows/bin/yt-dlp.exe"
|
||||
|
||||
# FFmpeg
|
||||
Invoke-WebRequest -Uri "https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip" -OutFile "$WORKSPACE/dist/windows/ffmpeg.zip"
|
||||
Expand-Archive "$WORKSPACE/dist/windows/ffmpeg.zip" -DestinationPath "$WORKSPACE/dist/windows/ffmpeg_temp"
|
||||
$ffmpegExe = Get-ChildItem -Path "$WORKSPACE/dist/windows/ffmpeg_temp" -Filter "ffmpeg.exe" -Recurse | Select-Object -First 1
|
||||
Move-Item $ffmpegExe.FullName "$WORKSPACE/dist/windows/bin/ffmpeg.exe"
|
||||
|
||||
# aria2c (Windows Portable)
|
||||
Invoke-WebRequest -Uri "https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0-win-64bit-build1.zip" -OutFile "$WORKSPACE/dist/windows/aria2c.zip"
|
||||
Expand-Archive "$WORKSPACE/dist/windows/aria2c.zip" -DestinationPath "$WORKSPACE/dist/windows/aria2_temp"
|
||||
Move-Item "$WORKSPACE/dist/windows/aria2_temp/aria2-1.37.0-win-64bit-build1/aria2c.exe" "$WORKSPACE/dist/windows/bin/aria2c.exe"
|
||||
|
||||
# Build .exe using PyInstaller
|
||||
# Use --add-data to include the src folder so internal imports (like 'import cli') work
|
||||
pip install pyinstaller
|
||||
pyinstaller --onefile --name "yt-playlist-downloader" --workpath "$WORKSPACE/build" --specpath "$WORKSPACE" --distpath "$WORKSPACE/dist" --add-data "$WORKSPACE/src;src" "$WORKSPACE/yt-playlist-main.py"
|
||||
Move-Item "$WORKSPACE/dist/yt-playlist-downloader.exe" "$WORKSPACE/dist/windows/yt-playlist-downloader.exe"
|
||||
|
||||
# Cleanup & Archive
|
||||
Remove-Item -Recurse -Force "$WORKSPACE/dist/windows/ffmpeg_temp", "$WORKSPACE/dist/windows/aria2_temp", "$WORKSPACE/dist/windows/*.zip"
|
||||
Compress-Archive -Path "$WORKSPACE/dist/windows/*" -DestinationPath "$WORKSPACE/yt-playlist-windows-$VERSION.zip"
|
||||
|
||||
# --- LINUX BUILD ---
|
||||
- name: Build Linux Package
|
||||
if: matrix.platform == 'linux'
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin"
|
||||
cp "$GITHUB_WORKSPACE/yt-playlist-main.py" "$GITHUB_WORKSPACE/dist/linux/"
|
||||
cp -r "$GITHUB_WORKSPACE/src" "$GITHUB_WORKSPACE/dist/linux/"
|
||||
|
||||
# yt-dlp
|
||||
curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux -o "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp"
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp"
|
||||
|
||||
# FFmpeg (static)
|
||||
curl -L https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz -o "$GITHUB_WORKSPACE/ffmpeg.tar.xz"
|
||||
mkdir -p "$GITHUB_WORKSPACE/ffmpeg_temp"
|
||||
tar -xf "$GITHUB_WORKSPACE/ffmpeg.tar.xz" -C "$GITHUB_WORKSPACE/ffmpeg_temp" --strip-components=1
|
||||
mv "$GITHUB_WORKSPACE/ffmpeg_temp/ffmpeg" "$GITHUB_WORKSPACE/dist/linux/bin/"
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/ffmpeg"
|
||||
|
||||
- name: Cache aria2c binary (Linux)
|
||||
if: matrix.platform == 'linux'
|
||||
id: aria2-cache
|
||||
uses: actions/cache@v5
|
||||
with:
|
||||
path: ${{ github.workspace }}/dist/linux/bin/aria2c
|
||||
key: aria2c-linux-1.37.0
|
||||
|
||||
- name: Build aria2c (Linux)
|
||||
if: matrix.platform == 'linux' && steps.aria2-cache.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
set -e
|
||||
sudo apt update && sudo apt install -y build-essential pkg-config libssl-dev zlib1g-dev wget
|
||||
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin"
|
||||
cd "$GITHUB_WORKSPACE"
|
||||
|
||||
wget https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0.tar.gz
|
||||
tar -xzf aria2-1.37.0.tar.gz
|
||||
cd aria2-1.37.0
|
||||
|
||||
CFLAGS="-Os -s" LDFLAGS="-static" ./configure \
|
||||
--enable-static --disable-shared \
|
||||
--disable-libaria2 --without-ca-bundle \
|
||||
--without-libnettle --without-libgcrypt \
|
||||
--without-libssh2 --without-libexpat \
|
||||
--without-libxml2 --without-libsqlite3 \
|
||||
--with-openssl
|
||||
|
||||
make -j"$(nproc)"
|
||||
strip src/aria2c
|
||||
cp src/aria2c "$GITHUB_WORKSPACE/dist/linux/bin/aria2c"
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/aria2c"
|
||||
|
||||
cd "$GITHUB_WORKSPACE"
|
||||
rm -rf aria2-1.37.0 aria2-1.37.0.tar.gz
|
||||
|
||||
- name: Archive Linux Package
|
||||
if: matrix.platform == 'linux'
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
# Archive
|
||||
cd "$GITHUB_WORKSPACE/dist/linux" && tar -czf "$GITHUB_WORKSPACE/yt-playlist-linux-$VERSION.tar.gz" *
|
||||
|
||||
- name: Upload Artifact
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: ${{ matrix.artifact_name }}
|
||||
path: |
|
||||
${{ github.workspace }}/*.zip
|
||||
${{ github.workspace }}/*.tar.gz
|
||||
|
||||
docker:
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Get version
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
TAG="${{ github.event.inputs.tag || inputs.tag }}"
|
||||
VERSION="${TAG#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Download Linux Artifact
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: linux-release
|
||||
path: ${{ github.workspace }}/dist/linux-docker
|
||||
|
||||
- name: Prepare Docker build context
|
||||
run: |
|
||||
cd "$GITHUB_WORKSPACE/dist/linux-docker"
|
||||
# Extract Linux artifact which now contains bin/, src/, and yt-playlist-main.py
|
||||
tar -xzf "$GITHUB_WORKSPACE/dist/linux-docker/yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz"
|
||||
|
||||
# Copy Docker-specific files
|
||||
cp "$GITHUB_WORKSPACE/Dockerfile" .
|
||||
cp "$GITHUB_WORKSPACE/docker-entrypoint.sh" .
|
||||
|
||||
# Ensure config directory is present (not included in Linux zip by default)
|
||||
if [ ! -d "config" ]; then cp -r "$GITHUB_WORKSPACE/config" . ; fi
|
||||
|
||||
# Debug: List context to verify paths match Dockerfile expectations
|
||||
ls -R
|
||||
|
||||
- name: Set docker image names
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
echo "RELEASE_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytplst:${VERSION}" >> $GITHUB_ENV
|
||||
echo "LATEST_IMAGE=ghcr.io/${GITHUB_ACTOR}/ytplst:latest" >> $GITHUB_ENV
|
||||
|
||||
- name: Build Docker image
|
||||
run: |
|
||||
docker build . -t $RELEASE_IMAGE -t $LATEST_IMAGE
|
||||
working-directory: ${{ github.workspace }}/dist/linux-docker
|
||||
|
||||
- name: Save Docker images
|
||||
run: |
|
||||
docker save -o docker-image.tar $RELEASE_IMAGE
|
||||
docker save -o docker-image-latest.tar $LATEST_IMAGE
|
||||
working-directory: ${{ github.workspace }}/dist/linux-docker
|
||||
|
||||
- name: Upload Docker artifacts
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: docker-images
|
||||
path: ${{ github.workspace }}/dist/linux-docker/docker-image*.tar
|
||||
|
||||
release:
|
||||
needs: [build, docker]
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.event.inputs.tag, 'v')
|
||||
steps:
|
||||
- name: Download all artifacts
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
path: ${{ github.workspace }}/artifacts
|
||||
|
||||
- name: Get version
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
TAG="${{ github.event.inputs.tag || inputs.tag }}"
|
||||
VERSION="${TAG#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Push Docker images
|
||||
run: |
|
||||
docker load -i "${{ github.workspace }}/artifacts/docker-images/docker-image.tar"
|
||||
docker push ghcr.io/${GITHUB_ACTOR}/ytplst:${{ steps.version.outputs.version }}
|
||||
docker load -i "${{ github.workspace }}/artifacts/docker-images/docker-image-latest.tar"
|
||||
docker push ghcr.io/${GITHUB_ACTOR}/ytplst:latest
|
||||
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v3
|
||||
with:
|
||||
tag_name: ${{ github.event.inputs.tag }}
|
||||
draft: true
|
||||
files: |
|
||||
${{ github.workspace }}/artifacts/**/*.zip
|
||||
${{ github.workspace }}/artifacts/**/*.tar.gz
|
||||
@@ -0,0 +1,64 @@
|
||||
name: dependency-updates
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: "0 12 * * 1"
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
update-bundled-binaries:
|
||||
name: Refresh pinned build dependencies
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Discover latest aria2 release
|
||||
id: aria2
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
latest_version="$(
|
||||
git ls-remote --tags --refs https://github.com/aria2/aria2.git 'refs/tags/release-*' \
|
||||
| awk -F/ '{print $NF}' \
|
||||
| sed 's/^release-//' \
|
||||
| sort -V \
|
||||
| tail -n 1
|
||||
)"
|
||||
|
||||
if [ -z "$latest_version" ]; then
|
||||
echo "Unable to determine the latest aria2 release." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "version=$latest_version" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Update release workflow pins
|
||||
shell: bash
|
||||
env:
|
||||
ARIA2_VERSION: ${{ steps.aria2.outputs.version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
python3 -c 'from pathlib import Path; import os; path = Path(".github/workflows/build_v2.yml"); text = path.read_text(encoding="utf-8"); version = os.environ["ARIA2_VERSION"]; updated = text.replace("release-1.37.0", f"release-{version}").replace("aria2-1.37.0", f"aria2-{version}").replace("aria2c-linux-1.37.0", f"aria2c-linux-{version}"); path.write_text(updated, encoding="utf-8") if updated != text else None; print(f"Updated aria2 references to {version}." if updated != text else "No aria2 references changed.")'
|
||||
|
||||
- name: Create Pull Request
|
||||
uses: peter-evans/create-pull-request@v8
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
commit-message: "chore: refresh aria2 build pins"
|
||||
title: "Refresh aria2 build pins"
|
||||
body: |
|
||||
Automated maintenance update for the bundled aria2 release references used by the release workflow.
|
||||
branch: dependency-updates/aria2
|
||||
delete-branch: true
|
||||
labels: dependencies, maintenance
|
||||
@@ -0,0 +1,46 @@
|
||||
name: Integration tests (minimal)
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
#push:
|
||||
#branches: [ main, Next ]
|
||||
#pull_request:
|
||||
#branches: [ main, Next ]
|
||||
|
||||
jobs:
|
||||
integration:
|
||||
name: Run integration tests
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
INTEGRATION_TEST: '1'
|
||||
TEST_PLAYLIST_URL: 'https://www.youtube.com/playlist?list=PLUmRr21IDW9WCW87FnbWAbIwwZHbf-lAz'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Make bundled linux binaries executable (if present)
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [ -d ./bin/linux ]; then
|
||||
chmod +x ./bin/linux/* || true
|
||||
ls -l ./bin/linux || true
|
||||
fi
|
||||
|
||||
- name: Create venv and install project
|
||||
run: |
|
||||
set -euo pipefail
|
||||
python3 -m venv .venv
|
||||
. .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
# Install project in editable mode. If the 'test' extra exists, prefer it.
|
||||
python -m pip install -e .[test] || python -m pip install -e .
|
||||
python -m pip install pytest
|
||||
|
||||
- name: Run integration script directly
|
||||
env:
|
||||
YTPL_DEBUG: '1'
|
||||
run: |
|
||||
set -euo pipefail
|
||||
. .venv/bin/activate
|
||||
python tests/integration_full_workflow_test.py
|
||||
@@ -0,0 +1,18 @@
|
||||
name: Lint Python code
|
||||
|
||||
on:
|
||||
push:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Install Ruff
|
||||
run: pip install ruff
|
||||
|
||||
- name: Run linter
|
||||
run: ruff check .
|
||||
@@ -1,341 +0,0 @@
|
||||
name: Build Release Packages
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: "Release tag (e.g., v0.1.0)"
|
||||
required: true
|
||||
type: string
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
build-windows-package:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Install dependencies
|
||||
run: sudo apt update && sudo apt install -y unzip zip curl
|
||||
|
||||
- name: Get version from tag
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
VERSION="${{ inputs.tag }}"
|
||||
elif [ "${{ github.event_name }}" = "release" ]; then
|
||||
VERSION="${{ github.event.release.tag_name }}"
|
||||
else
|
||||
VERSION="${{ github.ref_name }}"
|
||||
fi
|
||||
VERSION="${VERSION#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Prepare Windows package
|
||||
run: |
|
||||
set -e
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/windows/bin"
|
||||
cp "$GITHUB_WORKSPACE/yt-playlist-main.py" "$GITHUB_WORKSPACE/dist/windows/"
|
||||
|
||||
# yt-dlp
|
||||
curl -fL --retry 3 -H "User-Agent: github-actions" \
|
||||
-o "$GITHUB_WORKSPACE/dist/windows/bin/yt-dlp.exe" \
|
||||
https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe
|
||||
|
||||
# FFmpeg Windows static
|
||||
curl -fL --retry 3 -H "User-Agent: github-actions" \
|
||||
-o "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" \
|
||||
https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip
|
||||
unzip -q "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" -d "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp"
|
||||
mv $(find "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp" -name ffmpeg.exe | head -n 1) "$GITHUB_WORKSPACE/dist/windows/bin/ffmpeg.exe"
|
||||
|
||||
# aria2c Windows static
|
||||
curl -fL --retry 3 -H "User-Agent: github-actions" \
|
||||
-o "$GITHUB_WORKSPACE/dist/windows/aria2c.zip" \
|
||||
https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0-win-64bit-build1.zip
|
||||
unzip "$GITHUB_WORKSPACE/dist/windows/aria2c.zip" -d "$GITHUB_WORKSPACE/dist/windows/"
|
||||
mv "$GITHUB_WORKSPACE/dist/windows/aria2-1.37.0-win-64bit-build1/aria2c.exe" "$GITHUB_WORKSPACE/dist/windows/bin/aria2c.exe"
|
||||
|
||||
rm -rf "$GITHUB_WORKSPACE/dist/windows/ffmpeg_temp" "$GITHUB_WORKSPACE/dist/windows/aria2-1.37.0-win-64bit-build1" "$GITHUB_WORKSPACE/dist/windows/ffmpeg.zip" "$GITHUB_WORKSPACE/dist/windows/aria2c.zip"
|
||||
|
||||
# Create windows archive
|
||||
cd "$GITHUB_WORKSPACE/dist/windows"
|
||||
ZIP_NAME="yt-playlist-windows-${VERSION}.zip"
|
||||
zip -r "$GITHUB_WORKSPACE/$ZIP_NAME" *
|
||||
echo "ZIP_PATH=$GITHUB_WORKSPACE/$ZIP_NAME" >> $GITHUB_ENV
|
||||
|
||||
- name: Upload Windows artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: windows-release
|
||||
path: ${{ github.workspace }}/yt-playlist-windows-*.zip
|
||||
|
||||
build-linux-package:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Get version from tag
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
VERSION="${{ inputs.tag }}"
|
||||
elif [ "${{ github.event_name }}" = "release" ]; then
|
||||
VERSION="${{ github.event.release.tag_name }}"
|
||||
else
|
||||
VERSION="${{ github.ref_name }}"
|
||||
fi
|
||||
VERSION="${VERSION#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
sudo apt update
|
||||
sudo apt install -y unzip zip curl wget build-essential pkg-config libssl-dev zlib1g-dev
|
||||
|
||||
- name: Prepare workspace
|
||||
run: |
|
||||
set -e
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin"
|
||||
cp "$GITHUB_WORKSPACE/yt-playlist-main.py" "$GITHUB_WORKSPACE/dist/linux/"
|
||||
|
||||
- name: Download yt-dlp
|
||||
run: |
|
||||
curl -fL --retry 3 -H "User-Agent: github-actions" \
|
||||
-o "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp" \
|
||||
https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/yt-dlp"
|
||||
|
||||
- name: Download FFmpeg static
|
||||
run: |
|
||||
curl -fL --retry 3 -H "User-Agent: github-actions" \
|
||||
-o "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz" \
|
||||
https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp"
|
||||
tar -xf "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz" -C "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp" --strip-components=1
|
||||
mv "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp/ffmpeg" "$GITHUB_WORKSPACE/dist/linux/bin/ffmpeg"
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/ffmpeg"
|
||||
|
||||
- name: Restore aria2 cache
|
||||
id: aria2-cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: dist/linux/bin/aria2c
|
||||
key: aria2c-${{ runner.os }}-1.37.0
|
||||
|
||||
- name: Build aria2c if not cached
|
||||
if: steps.aria2-cache.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
set -e
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/bin"
|
||||
|
||||
mkdir -p "$GITHUB_WORKSPACE/dist/linux/aria2c_build"
|
||||
cd "$GITHUB_WORKSPACE"
|
||||
wget https://github.com/aria2/aria2/releases/download/release-1.37.0/aria2-1.37.0.tar.gz
|
||||
tar -xzf aria2-1.37.0.tar.gz
|
||||
cd aria2-1.37.0
|
||||
CFLAGS="-Os -s" LDFLAGS="-static" ./configure \
|
||||
--enable-static --disable-shared \
|
||||
--disable-libaria2 --without-ca-bundle \
|
||||
--without-libnettle --without-libgcrypt \
|
||||
--without-libssh2 --without-libexpat \
|
||||
--without-libxml2 --without-libsqlite3 \
|
||||
--with-openssl
|
||||
make -j"$(nproc)"
|
||||
strip src/aria2c
|
||||
cp src/aria2c "$GITHUB_WORKSPACE/dist/linux/bin/aria2c"
|
||||
chmod +x "$GITHUB_WORKSPACE/dist/linux/bin/aria2c"
|
||||
rm -rf "$GITHUB_WORKSPACE/dist/linux/aria2c_build" "$GITHUB_WORKSPACE/aria2-1.37.0" "$GITHUB_WORKSPACE/aria2-1.37.0.tar.gz"
|
||||
|
||||
|
||||
- name: Show cache status and bin contents
|
||||
run: |
|
||||
echo "Cache hit: ${{ steps.aria2-cache.outputs.cache-hit }}"
|
||||
echo "Listing dist/linux/bin:"
|
||||
ls -la dist/linux/bin || true
|
||||
|
||||
- name: Cleanup FFmpeg temp
|
||||
run: rm -rf "$GITHUB_WORKSPACE/dist/linux/ffmpeg_temp" "$GITHUB_WORKSPACE/dist/linux/ffmpeg.tar.xz"
|
||||
|
||||
- name: Archive Linux package
|
||||
run: |
|
||||
set -e
|
||||
VERSION="${{ steps.version.outputs.version }}"
|
||||
cd "$GITHUB_WORKSPACE/dist/linux"
|
||||
TAR_NAME="yt-playlist-linux-${VERSION}.tar.gz"
|
||||
tar -czf "$GITHUB_WORKSPACE/$TAR_NAME" *
|
||||
|
||||
- name: Upload Linux artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: linux-release
|
||||
path: ${{ github.workspace }}/yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz
|
||||
|
||||
build-docker-image:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [build-linux-package]
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Get version from tag
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
VERSION="${{ inputs.tag }}"
|
||||
elif [ "${{ github.event_name }}" = "release" ]; then
|
||||
VERSION="${{ github.event.release.tag_name }}"
|
||||
else
|
||||
VERSION="${{ github.ref_name }}"
|
||||
fi
|
||||
VERSION="${VERSION#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Set docker image names
|
||||
run: |
|
||||
echo "RELEASE_IMAGE=ghcr.io/${GITHUB_ACTOR}/youtubeplaylistdownloader:${{ steps.version.outputs.version }}" >> $GITHUB_ENV
|
||||
echo "LATEST_IMAGE=ghcr.io/${GITHUB_ACTOR}/youtubeplaylistdownloader:latest" >> $GITHUB_ENV
|
||||
|
||||
- name: Download linux artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: linux-release
|
||||
|
||||
- name: Prepare Docker build context
|
||||
run: |
|
||||
mkdir -p dist/linux-docker
|
||||
cp Dockerfile dist/linux-docker/
|
||||
echo "Copying and extracting Linux artifact..."
|
||||
tar -xzf yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz -C dist/linux-docker/
|
||||
echo "Build context contents:"
|
||||
ls -R dist/linux-docker
|
||||
|
||||
- name: Build Docker image (release)
|
||||
run: docker build dist/linux-docker -t $RELEASE_IMAGE
|
||||
|
||||
- name: Save Docker image as tar (release)
|
||||
run: docker save -o docker-image.tar $RELEASE_IMAGE
|
||||
|
||||
- name: Upload docker-image artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: docker-image
|
||||
path: docker-image.tar
|
||||
|
||||
- name: Build Docker image (latest)
|
||||
run: docker build dist/linux-docker --label build_as_latest=true -t $LATEST_IMAGE
|
||||
|
||||
- name: Save Docker image as tar (latest)
|
||||
run: docker save -o docker-image-latest.tar $LATEST_IMAGE
|
||||
|
||||
- name: Upload docker-image-latest artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: docker-image-latest
|
||||
path: docker-image-latest.tar
|
||||
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [build-windows-package, build-linux-package, build-docker-image]
|
||||
env:
|
||||
IMAGE_NAME: youtubeplaylistdownloader
|
||||
steps:
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: windows-release
|
||||
path: windows-release
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: linux-release
|
||||
path: linux-release
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: docker-image
|
||||
path: docker-image
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: docker-image-latest
|
||||
path: docker-image-latest
|
||||
|
||||
- name: Get version from tag
|
||||
id: version
|
||||
shell: bash
|
||||
run: |
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
VERSION="${{ inputs.tag }}"
|
||||
elif [ "${{ github.event_name }}" = "release" ]; then
|
||||
VERSION="${{ github.event.release.tag_name }}"
|
||||
else
|
||||
VERSION="${{ github.ref_name }}"
|
||||
fi
|
||||
VERSION="${VERSION#v}"
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
- name: Set docker image names
|
||||
run: |
|
||||
echo "RELEASE_IMAGE=ghcr.io/${GITHUB_ACTOR}/youtubeplaylistdownloader:${{ steps.version.outputs.version }}" >> $GITHUB_ENV
|
||||
echo "LATEST_IMAGE=ghcr.io/${GITHUB_ACTOR}/youtubeplaylistdownloader:latest" >> $GITHUB_ENV
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Load and push Docker release image
|
||||
run: |
|
||||
docker load -i docker-image/docker-image.tar
|
||||
docker push $RELEASE_IMAGE
|
||||
- name: Load and push Docker latest image
|
||||
run: |
|
||||
docker load -i docker-image-latest/docker-image-latest.tar
|
||||
docker push $LATEST_IMAGE
|
||||
- name: Create GitHub Release
|
||||
id: create_release
|
||||
uses: actions/create-release@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag_name: ${{ steps.version.outputs.version }}
|
||||
release_name: ${{ steps.version.outputs.version }}
|
||||
draft: true
|
||||
- name: Upload Windows release asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: windows-release/yt-playlist-windows-${{ steps.version.outputs.version }}.zip
|
||||
asset_name: yt-playlist-windows-${{ steps.version.outputs.version }}.zip
|
||||
asset_content_type: application/zip
|
||||
- name: Upload Linux release asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: linux-release/yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz
|
||||
asset_name: yt-playlist-linux-${{ steps.version.outputs.version }}.tar.gz
|
||||
asset_content_type: application/gzip
|
||||
- name: Upload Docker release tar
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: docker-image/docker-image.tar
|
||||
asset_name: docker-image-${{ steps.version.outputs.version }}.tar
|
||||
asset_content_type: application/x-tar
|
||||
- name: Upload Docker latest tar
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||
asset_path: docker-image-latest/docker-image-latest.tar
|
||||
asset_name: docker-image-latest.tar
|
||||
asset_content_type: application/x-tar
|
||||
@@ -0,0 +1,41 @@
|
||||
name: Unit tests
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
tests:
|
||||
name: Run unit tests
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Create venv and install project
|
||||
run: |
|
||||
set -euo pipefail
|
||||
python3 -m venv .venv
|
||||
. .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
# Install project (editable) and test deps
|
||||
python -m pip install -e .[test] || python -m pip install -e .
|
||||
python -m pip install pytest
|
||||
|
||||
- name: Run tests
|
||||
env:
|
||||
PYTHONPATH: ${{ github.workspace }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
. .venv/bin/activate
|
||||
pytest -q
|
||||
+7
-3
@@ -2,9 +2,13 @@
|
||||
|
||||
|
||||
#Custom for this project
|
||||
yt-playlist-config.json
|
||||
/bin/
|
||||
/config/
|
||||
config/yt-playlist-config.json
|
||||
/tmp*
|
||||
/*/tmp*
|
||||
*.code-workspace
|
||||
/bin/*
|
||||
/app/data
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
|
||||
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"python.terminal.activateEnvironment": true,
|
||||
"python.testing.pytestArgs": [
|
||||
"tests"
|
||||
],
|
||||
"python.testing.unittestEnabled": false,
|
||||
"python.testing.pytestEnabled": true,
|
||||
"github-actions.workflows.pinned.workflows": []
|
||||
}
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
FROM python:3.12-alpine
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY yt-playlist-main.py /app/
|
||||
COPY ./bin/ffmpeg /app/bin
|
||||
COPY ./bin/yt-dlp /app/bin
|
||||
COPY ./bin/aria2c /app/bin
|
||||
|
||||
CMD ["python", "yt-playlist-main.py"]
|
||||
@@ -1,232 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
||||
|
||||
YouTube-Playlist-Downloader
|
||||
Copyright (C) 2025 dark_zoul
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
||||
|
||||
YouTube-Playlist-Downloader Copyright (C) 2025 dark_zoul
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@@ -1,169 +1,95 @@
|
||||
# YouTube Playlist Downloader
|
||||
# YouTube Playlist Sync
|
||||
|
||||
A cross-platform tool for downloading entire YouTube playlists as MP3 or MP4 files, using [yt-dlp](https://github.com/yt-dlp/yt-dlp), [ffmpeg](https://ffmpeg.org/), and [aria2c](https://github.com/aria2/aria2). Includes a GitHub Actions CI/CD workflow for packaging and releasing Windows and Linux binaries.
|
||||
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/build_v2.yml)
|
||||
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/unit-tests.yml)
|
||||
|
||||
A cross-platform tool for downloading and keeping in sync a local copy of entire YouTube playlists as MP3 or MP4 files, using [yt-dlp](https://github.com/yt-dlp/yt-dlp) & [ffmpeg](https://ffmpeg.org/).
|
||||
|
||||
Supports audio, video, or both download modes, music and videos are numbered as they are on your youtube playlist, playlist cleanup, and configurable parallel download options.
|
||||
Local-first YouTube playlist synchronization client.
|
||||
|
||||
---
|
||||
## What’s Included
|
||||
|
||||
## Features
|
||||
|
||||
- **Download full YouTube playlists** as high-quality MP3 (audio), MP4 (video), or both.
|
||||
- **Download mode:** Choose `audio`, `video`, or `both` for each playlist.
|
||||
- **Max video quality:** Select from `720p`, `1080p`, `1440p`, `2160p`, or `best`.
|
||||
- **Parallel downloads:** Using aria2 for speed.
|
||||
- **Automatic renumbering:** Tracks are renumbered to match playlist order after download.
|
||||
- **Cleanup of tracks:** Option to remove files not in playlist anymore, with confirmation.
|
||||
- **Configurable output paths** and archive tracking.
|
||||
- **Cross-platform:** Windows and Linux support.
|
||||
- **GitHub Actions CI/CD workflow** for automated packaging and release.
|
||||
|
||||
---
|
||||
- Scanner (yt-dlp extract-only), diff engine, filesystem scan
|
||||
- Safe reordering via two-pass rename, recycle deletions
|
||||
- Async download queue with simple retry (yt-dlp Python API)
|
||||
- SQLite metadata; DB updates on rename/download/delete; `last_sync`
|
||||
- Optional event publishing for future GUI/logs
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.8+
|
||||
- Python 3.10+
|
||||
- `ffmpeg` (needed for `audio` and `both` modes)
|
||||
|
||||
---
|
||||
Quick start:
|
||||
|
||||
## Installation
|
||||
Download the latest release from [releases](https://github.com/darkzoul5/YoutubePlaylistSyncThing/releases) page
|
||||
|
||||
### Quick Start
|
||||
## Configure
|
||||
|
||||
1. **Download the latest release:**
|
||||
On first run, the app will auto-create a default `config/yt-playlist-config.json` (if missing).
|
||||
|
||||
- Go to the [Releases](https://github.com/darkzoul5/YoutubePlaylistDownloader/releases) page.
|
||||
- Download the appropriate archive for your platform (Windows or Linux).
|
||||
|
||||
1. **Unzip the archive:**
|
||||
|
||||
- Extract the contents to a folder of your choice.
|
||||
|
||||
1. **Edit configuration:**
|
||||
|
||||
- Open `yt-playlist-config.json` and adjust paths, playlist URLs, download mode, and quality as needed.
|
||||
|
||||
1. **Run the downloader:**
|
||||
|
||||
- On Windows:
|
||||
|
||||
```sh
|
||||
python yt-playlist-main.py
|
||||
```
|
||||
|
||||
- On Linux:
|
||||
|
||||
```sh
|
||||
python3 yt-playlist-main.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
|
||||
Edit `yt-playlist-config.json` to specify playlists, paths, and options:
|
||||
Create/edit `config/yt-playlist-config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"ffmpeg_path": "./bin/ffmpeg.exe",
|
||||
"playlists": [
|
||||
{
|
||||
"url": "https://www.youtube.com/playlist?list=playlistidhere",
|
||||
"download_mode": "audio",
|
||||
"max_video_quality": "1080p",
|
||||
"save_path": "./music",
|
||||
"archive": "archive.txt",
|
||||
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID",
|
||||
"download_mode": "video",
|
||||
"max_download_quality": "1080p",
|
||||
"save_path": "./downloads"
|
||||
}
|
||||
],
|
||||
"yt_dlp_path": "./bin/yt-dlp.exe", // or "yt-dlp" for Linux
|
||||
"ffmpeg_path": "./bin/ffmpeg.exe", // or "ffmpeg" for Linux
|
||||
"aria2c_path": "./bin/aria2c.exe", // or "aria2c" for Linux
|
||||
"max_parallel_downloads": 10,
|
||||
"aria2c_connections": 8
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- **playlists:** List of playlist objects. Each must have a `url`, `save_path`, and `archive`.
|
||||
- **yt_dlp_path, ffmpeg_path, aria2c_path:** Paths to binaries (relative or absolute).
|
||||
- **download_mode:** Choose `audio`, `video`, or `both`.
|
||||
- **max_video_quality:** Set max video quality for downloads.
|
||||
- **max_parallel_downloads:** Number of simultaneous downloads.
|
||||
- **aria2c_connections:** Connections per download.
|
||||
Defaults:
|
||||
- `ffmpeg_path`: `./bin/ffmpeg.exe` (Windows) or `./bin/ffmpeg` (Linux)
|
||||
- `download_mode`: `video`
|
||||
- `max_download_quality`: `1080p`
|
||||
- `save_path`: `./downloads`
|
||||
|
||||
---
|
||||
`max_download_quality`:
|
||||
|
||||
### Running
|
||||
- Limits yt-dlp download quality (e.g. `"1080p"`, `"720p"`, `"360p"`). This only affects the downloaded video format selection.
|
||||
- If the requested max quality isn't available for a video, the best available quality is chosen.
|
||||
|
||||
- Just run the script with Python:
|
||||
- On Windows: `python yt-playlist-main.py`
|
||||
- On Linux: `python3 yt-playlist-main.py`
|
||||
`download_mode`:
|
||||
|
||||
- The downloader will:
|
||||
- Check for required tools and update yt-dlp automatically
|
||||
- Download new tracks or videos from your playlist(s)
|
||||
- Number and name files to match the playlist order
|
||||
- Skip deleted or private videos
|
||||
- Avoid re-downloading files you've already downloaded
|
||||
- Offer to clean up files that are no longer in the playlist
|
||||
- `video`: download playlist videos as muxed `.mp4` (no ffmpeg processing)
|
||||
- `audio`: download muxed `.mp4`, extract `.mp3`, delete the `.mp4`
|
||||
- `both`: download muxed `.mp4`, extract `.mp3`, keep both files
|
||||
|
||||
---
|
||||
## Run
|
||||
|
||||
## Docker Usage
|
||||
- Compute-only:
|
||||
|
||||
You can run YouTube Playlist Downloader using the official Docker image.
|
||||
|
||||
### Run the container
|
||||
|
||||
```pwsh
|
||||
docker run -v /path/to/downloads:/app/downloads -v /path/to/config:/app/config ghcr.io/dark_zoul/YoutubePlaylistDownloader:latest
|
||||
```bash
|
||||
python -m src.app.cli
|
||||
```
|
||||
|
||||
Replace `/path/to/downloads` and `/path/to/config` with your local directories.
|
||||
- Apply actions:
|
||||
|
||||
**Required volumes:**
|
||||
|
||||
- `/app/downloads`: Directory for downloaded audio/videos
|
||||
- `/app/config`: Directory for the configuration file
|
||||
|
||||
### Docker Compose example
|
||||
|
||||
Create a `docker-compose.yml` with the following content (replace the host paths as needed):
|
||||
|
||||
```yaml
|
||||
services:
|
||||
yt-downloader:
|
||||
image: ghcr.io/dark_zoul/YoutubePlaylistDownloader:latest
|
||||
container_name: yt-downloader
|
||||
restart: no
|
||||
volumes:
|
||||
- /path/to/downloads:/app/downloads
|
||||
- /path/to/config:/app/config
|
||||
```bash
|
||||
python -m src.app.cli --apply
|
||||
```
|
||||
|
||||
Run it with:
|
||||
- Single playlist (0-based index):
|
||||
|
||||
```pwsh
|
||||
docker compose up -d
|
||||
```bash
|
||||
python -m src.app.cli --apply --playlist 0
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
## Data & Layout
|
||||
|
||||
- **No binaries found:** Ensure paths in `yt-playlist-config.json` are correct and binaries are present.
|
||||
- **No tracks downloaded:** Check playlist URL and archive file.
|
||||
- **Download mode or quality issues:** Make sure `download_mode` and `max_video_quality` are set to valid values.
|
||||
- **Network overload warning:** If you set very high parallel/connections, the script will warn you.
|
||||
- Database: `app/data/app.db`
|
||||
- Outputs: `<save_path>/audio` and/or `<save_path>/video`
|
||||
- Recycle bin: `<save_path>/.recycle/{audio,video}`
|
||||
|
||||
---
|
||||
## Roadmap (short)
|
||||
|
||||
## License
|
||||
|
||||
See [LICENSE](LICENSE).
|
||||
|
||||
---
|
||||
|
||||
## Credits
|
||||
|
||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
|
||||
- [ffmpeg](https://ffmpeg.org/)
|
||||
- [aria2c](https://github.com/aria2/aria2)
|
||||
- Scheduler (periodic sync), richer retries/logging
|
||||
- GUI (PySide6) wired to EventBus
|
||||
- Enhanced config validation
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"ffmpeg_path": "./bin/ffmpeg.exe",
|
||||
"playlists": [
|
||||
{
|
||||
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID_HERE",
|
||||
"download_mode": "video",
|
||||
"max_download_quality": "1080p",
|
||||
"save_path": "./downloads"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
# GUI Plan
|
||||
|
||||
## Python-first Desktop Architecture
|
||||
|
||||
- **Primary GUI framework**: `PySide6` (Qt for Python).
|
||||
- **Communication Layer**: A local `FastAPI` backend to separate core logic from the UI.
|
||||
- **IPC Mechanism**: The GUI spawns the FastAPI server on a random high port (binding to `127.0.0.1` ONLY) and communicates via REST/WebSockets.
|
||||
|
||||
## Core Features to Implement
|
||||
|
||||
1. **Dashboard Overview**: List all tracked playlists, their status (Last Sync), and total size.
|
||||
2. **Interactive Configuration**: Wizard-style setup for new playlists (URL detection, folder picker).
|
||||
3. **Queue Manager**: Visual progress bars for active downloads, showing speed, ETA, and current video title.
|
||||
4. **Log Viewer**: Real-time streaming of yt-dlp logs for troubleshooting.
|
||||
5. **Settings Panel**: Global settings for binary paths (ffmpeg, aria2c), max parallel jobs, and Docker detection toggle.
|
||||
|
||||
## Phase 1 Roadmap: "The Bridge"
|
||||
|
||||
- [ ] **Refactor `src/manager.py`**: Convert CLI-first execution to async-compatible methods for FastAPI consumption.
|
||||
- [ ] **FastAPI Integration**: Create endpoints for `/playlists`, `/status`, and `/download/start`.
|
||||
- [ ] **PySide6 Skeleton**: Basic window with `QWebEngine` (if hybrid) or native `QWidget` dashboard.
|
||||
- [ ] **Packaging**: `pyinstaller` configuration to bundle both backend and frontend into a single `.exe`.
|
||||
|
||||
## Packaging & Distribution (brief)
|
||||
|
||||
- Bundle the backend and GUI into one distributable. The GUI should spawn the local API process (background subprocess) on startup.
|
||||
- Windows: use `pyinstaller` or `briefcase` to create an executable/installer. Consider creating an MSI or Inno Setup installer for a polished UX.
|
||||
- Linux: provide AppImage, Snap, or distribution-specific packages (deb/rpm) — AppImage is a good starting point for single-file distribution.
|
||||
- Security: bind the local API to `localhost` only, use a short-lived token or IPC for authentication between GUI and backend, and avoid exposing unnecessary ports.
|
||||
|
||||
## Roadmap (GUI → Web → Mobile)
|
||||
|
||||
1. Desktop prototype: `FastAPI` backend + `PySide6` GUI (thin client) with basic playlist add/update/download controls and status streaming.
|
||||
2. Packaging: create Windows exe/installer and Linux AppImage for the prototype.
|
||||
3. Web frontend: build a web SPA that consumes the same backend API (hosted or local) — this reuses business logic with minimal change.
|
||||
4. Android: either a native app or cross-platform UI (Flutter/React Native) that calls the backend API; alternatively host the backend and make a thin mobile client.
|
||||
|
||||
If you want, I can now: scaffold a minimal `FastAPI` backend and `PySide6` desktop starter in this repo, or produce concise packaging steps for Windows and Linux. Which do you prefer?
|
||||
@@ -0,0 +1,50 @@
|
||||
# Project Plan
|
||||
|
||||
## Subject Area
|
||||
|
||||
- Tool for downloading and synchronizing YouTube playlists.
|
||||
- Focuses on batch downloading, format selection (audio and/or video), configurable quality and keeping local copies synced with playlist changes.
|
||||
- Targets power users and archivists who need large-scale, repeatable playlist archiving and ongoing synchronization, with GUI interface.
|
||||
|
||||
## Problem
|
||||
|
||||
- Users and power-users who manage large or frequently changing YouTube playlists lack a dependable, configurable tool that:
|
||||
- correctly detects and downloads new videos while avoiding duplicates,
|
||||
- and can be configured easily via file or GUI for repeatable workflows.
|
||||
|
||||
## Users Definition
|
||||
|
||||
Individuals who need to download a large number of videos or audio files from a YouTube playlist and keep it updated
|
||||
|
||||
## Functionality Definition
|
||||
|
||||
- Multi-format Download:
|
||||
- Video only (mp4)
|
||||
- Audio only (mp3)
|
||||
- Both video and audio (mp3 & mp4)
|
||||
- Smart Synchronization:
|
||||
- Archive tracking (prevents re-downloading existing media)
|
||||
- Playlist Pruning (automatically deletes local files no longer in the YouTube playlist)
|
||||
- Sequential Renumbering (keeps local files sorted by playlist position)
|
||||
- Advanced Configuration:
|
||||
- Per-playlist settings (Quality, paths, archive file)
|
||||
- Global performance options (Parallel downloads, aria2c threading)
|
||||
- Path management for yt-dlp, ffmpeg, and aria2c (Docker-aware)
|
||||
- GUI Integration:
|
||||
- Real-time status updates via backend API
|
||||
- Visual configuration editor
|
||||
- Modern, responsive Qt-based interface
|
||||
|
||||
## Platforms
|
||||
|
||||
- Desktop: Windows (Primary), Linux
|
||||
- Docker
|
||||
- Possible Future: Web App, Android App (via shared FastAPI backend)
|
||||
|
||||
## Architecture & Languages
|
||||
|
||||
- Core Engine: Python (yt-dlp wrapper)
|
||||
- Backend API: FastAPI (Local localhost-only boundary)
|
||||
- Desktop Frontend: PySide6 (Qt for Python)
|
||||
- Distribution: PyInstaller / Briefcase (Windows .exe, Linux AppImage)
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
# Project Schedule
|
||||
|
||||
| No. | Task description | Estimated time |
|
||||
| --- | --- | --- |
|
||||
| 1 | Define the project requirements, target users, and core features for playlist downloading and synchronization. | 3 hours |
|
||||
| 2 | Design the overall architecture for the Python package, CLI entry point, and configuration structure. | 4 hours |
|
||||
| 3 | Implement configuration loading and validation for paths, download modes, quality settings, and external tools. | 5 hours |
|
||||
| 4 | Build the playlist fetching logic to read playlist entries and detect new, deleted, or private videos. | 5 hours |
|
||||
| 5 | Implement the downloader core for audio, video, and combined download modes using yt-dlp, ffmpeg, and aria2c. | 8 hours |
|
||||
| 6 | Add filename sanitization, track renumbering, and output path management to keep downloaded files organized. | 5 hours |
|
||||
| 7 | Implement playlist update and cleanup logic so the local library stays synchronized with the online playlist. | 5 hours |
|
||||
| 8 | Create CLI flags for debug mode, pruning, auto-confirmation, and custom config file selection. | 4 hours |
|
||||
| 9 | Add logging, warnings, and error handling for missing binaries, network issues, and invalid settings. | 4 hours |
|
||||
| 10 | Prepare Docker support and environment-variable based configuration for containerized usage. | 4 hours |
|
||||
| 11 | Review the implementation, fix bugs, and refine behavior based on test results and runtime issues. | 6 hours |
|
||||
| 12 | Choose the GUI framework and define the desktop architecture, create a local backend API. | 4 hours |
|
||||
| 13 | Build the initial desktop GUI prototype with controls & basic actions. | 6 hours |
|
||||
| 14 | Connect the GUI to backend functionality for adding playlists, starting downloads, and showing progress updates. | 6 hours |
|
||||
| 15 | Add GUI settings for download mode, quality, save paths, and external tool configuration. | 5 hours |
|
||||
| 16 | Prepare GUI packaging and distribution for Windows and Linux. | 5 hours |
|
||||
| 17 | Write automated tests for config loading, downloader behavior, playlist updates, and cleanup edge cases. | 7 hours |
|
||||
| 18 | Write user documentation, usage examples, and release instructions for Windows and Linux. | 3 hours |
|
||||
|
||||
## Total Time
|
||||
|
||||
89 hours
|
||||
@@ -0,0 +1,781 @@
|
||||
# YouTube Playlist Sync — Project Conversion Plan
|
||||
|
||||
Repository:
|
||||
|
||||
- [darkzoul5/YoutubePlaylistDownloader](https://github.com/darkzoul5/YoutubePlaylistDownloader?utm_source=chatgpt.com)
|
||||
|
||||
---
|
||||
|
||||
# Project Direction
|
||||
|
||||
Convert the project from:
|
||||
|
||||
```text
|
||||
Single-purpose YouTube playlist downloader
|
||||
```
|
||||
|
||||
into:
|
||||
|
||||
```text
|
||||
Persistent YouTube playlist synchronization client
|
||||
```
|
||||
|
||||
The application becomes state-driven.
|
||||
|
||||
---
|
||||
|
||||
# Core Product Goals
|
||||
|
||||
## Main Features
|
||||
|
||||
- Sync playlists locally
|
||||
- Download missing items
|
||||
- Remove deleted playlist items
|
||||
- Keep exact playlist ordering
|
||||
- Support audio/video modes
|
||||
- Multiple playlists
|
||||
- Background auto-sync
|
||||
- GUI configuration
|
||||
- Queue management
|
||||
- Logs/history
|
||||
|
||||
---
|
||||
|
||||
# Explicit Non-Goals (Current Scope)
|
||||
|
||||
Not planned right now:
|
||||
|
||||
- Built-in media playback
|
||||
- Advanced naming templates
|
||||
- Drag-and-drop manual ordering
|
||||
- Private playlist sync
|
||||
- Channel subscriptions
|
||||
- Metadata editing
|
||||
|
||||
Design the architecture so these can be added later.
|
||||
|
||||
---
|
||||
|
||||
# Recommended Stack
|
||||
|
||||
## Core Language
|
||||
|
||||
- Python 3.12+
|
||||
|
||||
Reason:
|
||||
|
||||
- Native yt-dlp ecosystem
|
||||
- Easier async/background work
|
||||
- Better packaging than many expect
|
||||
- Simpler iteration speed
|
||||
|
||||
---
|
||||
|
||||
# GUI
|
||||
|
||||
## Recommended
|
||||
|
||||
- PySide6
|
||||
|
||||
Why:
|
||||
|
||||
- Modern Qt ecosystem
|
||||
- Better long-term support
|
||||
- Cleaner than Tkinter
|
||||
- Easier dynamic playlist UI
|
||||
- Good threading support
|
||||
- Better styling
|
||||
|
||||
Avoid:
|
||||
|
||||
- Tkinter for this scale
|
||||
- Electron/Tauri unless you want a web stack
|
||||
|
||||
---
|
||||
|
||||
# Downloader Backend
|
||||
|
||||
## Recommended
|
||||
|
||||
- yt-dlp Python API
|
||||
|
||||
Install:
|
||||
|
||||
```bash
|
||||
pip install yt-dlp
|
||||
```
|
||||
|
||||
Do NOT:
|
||||
|
||||
- scrape YouTube manually
|
||||
- parse HTML yourself
|
||||
- depend on external unofficial APIs
|
||||
|
||||
Use yt-dlp for:
|
||||
|
||||
- metadata extraction
|
||||
- playlist scanning
|
||||
- downloading
|
||||
- postprocessing
|
||||
|
||||
Use your own app for:
|
||||
|
||||
- sync logic
|
||||
- ordering
|
||||
- deletion
|
||||
- scheduling
|
||||
- state tracking
|
||||
|
||||
---
|
||||
|
||||
# Media Processing
|
||||
|
||||
## Recommended
|
||||
|
||||
- ffmpeg
|
||||
|
||||
Needed for:
|
||||
|
||||
- audio extraction
|
||||
- remuxing
|
||||
- conversions
|
||||
- thumbnail embedding later
|
||||
|
||||
Recommended approach:
|
||||
|
||||
- auto-detect ffmpeg
|
||||
- optionally bundle with packaged app
|
||||
|
||||
---
|
||||
|
||||
# Database
|
||||
|
||||
## Recommended
|
||||
|
||||
- SQLite
|
||||
|
||||
Reason:
|
||||
|
||||
- Zero setup
|
||||
- Local-first architecture
|
||||
- Perfect for sync metadata
|
||||
- Easy migrations
|
||||
- Reliable
|
||||
|
||||
SQLite is extremely important for this project.
|
||||
|
||||
Do NOT rely only on:
|
||||
|
||||
- filenames
|
||||
- folders
|
||||
- JSON
|
||||
|
||||
---
|
||||
|
||||
# Background Scheduling
|
||||
|
||||
## Recommended
|
||||
|
||||
- APScheduler
|
||||
|
||||
Use for:
|
||||
|
||||
- interval syncs
|
||||
- delayed jobs
|
||||
- retry jobs
|
||||
- startup sync
|
||||
|
||||
---
|
||||
|
||||
# Async/Concurrency
|
||||
|
||||
## Recommended
|
||||
|
||||
- asyncio
|
||||
|
||||
Use for:
|
||||
|
||||
- concurrent playlist syncs
|
||||
- GUI-safe task execution
|
||||
- download queue
|
||||
- cancellation
|
||||
- progress updates
|
||||
|
||||
---
|
||||
|
||||
# Logging
|
||||
|
||||
## Recommended
|
||||
|
||||
- loguru
|
||||
|
||||
or:
|
||||
|
||||
- standard logging module
|
||||
|
||||
Need:
|
||||
|
||||
- rotating logs
|
||||
- GUI log panel
|
||||
- error history
|
||||
- debug support
|
||||
|
||||
---
|
||||
|
||||
# Packaging
|
||||
|
||||
## Recommended
|
||||
|
||||
### During development
|
||||
|
||||
```text
|
||||
venv + pip
|
||||
```
|
||||
|
||||
### Release builds
|
||||
|
||||
Choose one:
|
||||
|
||||
| Tool | Notes |
|
||||
| ----------- | ------------------------------- |
|
||||
| Nuitka | Best performance and protection |
|
||||
| PyInstaller | Easier and common |
|
||||
|
||||
Nuitka is probably best long-term.
|
||||
|
||||
---
|
||||
|
||||
# Major Architectural Changes
|
||||
|
||||
---
|
||||
|
||||
# 1. Move to State-Based Sync Architecture
|
||||
|
||||
Current downloader logic is likely:
|
||||
|
||||
```text
|
||||
Playlist URL
|
||||
↓
|
||||
Download everything
|
||||
```
|
||||
|
||||
Replace with:
|
||||
|
||||
```text
|
||||
Remote Playlist State
|
||||
↓
|
||||
Stored Local State
|
||||
↓
|
||||
Filesystem State
|
||||
↓
|
||||
Diff Engine
|
||||
↓
|
||||
Sync Actions
|
||||
```
|
||||
|
||||
This is the single most important change.
|
||||
|
||||
---
|
||||
|
||||
# 2. Introduce Playlist Metadata Database
|
||||
|
||||
Create persistent tracking.
|
||||
|
||||
Suggested tables:
|
||||
|
||||
## playlists
|
||||
|
||||
```sql
|
||||
CREATE TABLE playlists (
|
||||
id TEXT PRIMARY KEY,
|
||||
name TEXT,
|
||||
url TEXT,
|
||||
path TEXT,
|
||||
mode TEXT,
|
||||
auto_sync INTEGER,
|
||||
sync_interval_minutes INTEGER,
|
||||
last_sync TEXT
|
||||
);
|
||||
```
|
||||
|
||||
## playlist\_items
|
||||
|
||||
```sql
|
||||
CREATE TABLE playlist_items (
|
||||
playlist_id TEXT,
|
||||
video_id TEXT,
|
||||
title TEXT,
|
||||
playlist_index INTEGER,
|
||||
local_filename TEXT,
|
||||
downloaded INTEGER,
|
||||
last_seen TEXT,
|
||||
PRIMARY KEY (playlist_id, video_id)
|
||||
);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 3. Implement Playlist Scanner Layer
|
||||
|
||||
Create dedicated metadata extraction.
|
||||
|
||||
Suggested structure:
|
||||
|
||||
```text
|
||||
core/
|
||||
├── scanner/
|
||||
│ └── playlist_scanner.py
|
||||
```
|
||||
|
||||
Responsibilities:
|
||||
|
||||
- fetch playlist entries
|
||||
- extract video IDs
|
||||
- detect unavailable videos
|
||||
- return normalized playlist state
|
||||
|
||||
Use:
|
||||
|
||||
```python
|
||||
extract_info(download=False)
|
||||
```
|
||||
|
||||
This allows playlist scanning without downloading.
|
||||
|
||||
---
|
||||
|
||||
# 4. Create Diff Engine
|
||||
|
||||
The app should compare:
|
||||
|
||||
```text
|
||||
Remote playlist
|
||||
vs
|
||||
Database state
|
||||
vs
|
||||
Filesystem state
|
||||
```
|
||||
|
||||
Output actions:
|
||||
|
||||
```text
|
||||
DOWNLOAD
|
||||
DELETE
|
||||
RENAME
|
||||
REORDER
|
||||
SKIP
|
||||
REPAIR
|
||||
```
|
||||
|
||||
Suggested file:
|
||||
|
||||
```text
|
||||
core/sync/diff_engine.py
|
||||
```
|
||||
|
||||
This becomes the heart of the application.
|
||||
|
||||
---
|
||||
|
||||
# 5. Add Download Queue System
|
||||
|
||||
Multi-playlist sync requires a queue.
|
||||
|
||||
Suggested states:
|
||||
|
||||
```text
|
||||
Queued
|
||||
Downloading
|
||||
Converting
|
||||
Completed
|
||||
Failed
|
||||
Skipped
|
||||
Cancelled
|
||||
```
|
||||
|
||||
Suggested structure:
|
||||
|
||||
```text
|
||||
core/download/
|
||||
├── queue_manager.py
|
||||
├── downloader.py
|
||||
└── workers.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 6. Implement Stable File Naming
|
||||
|
||||
Recommended naming:
|
||||
|
||||
```text
|
||||
0001 - Title.ext
|
||||
```
|
||||
|
||||
Benefits:
|
||||
|
||||
- native filesystem sorting
|
||||
- easy reorder support
|
||||
- easy repairs
|
||||
- user friendly
|
||||
|
||||
Use:
|
||||
|
||||
```python
|
||||
%(playlist_index)04d - %(title)s.%(ext)s
|
||||
```
|
||||
|
||||
through yt-dlp.
|
||||
|
||||
---
|
||||
|
||||
# 7. Implement Safe Reordering
|
||||
|
||||
Playlist ordering changes frequently.
|
||||
|
||||
Never rename directly.
|
||||
|
||||
Use:
|
||||
|
||||
```text
|
||||
Temporary rename pass
|
||||
↓
|
||||
Final rename pass
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
0001.mp3 → temp_a
|
||||
0002.mp3 → temp_b
|
||||
↓
|
||||
temp_a → 0002.mp3
|
||||
```
|
||||
|
||||
Avoid collisions.
|
||||
|
||||
---
|
||||
|
||||
# 8. Implement Deletion Strategy
|
||||
|
||||
Recommended:
|
||||
|
||||
Instead of immediate delete:
|
||||
|
||||
```text
|
||||
playlist/.recycle/
|
||||
```
|
||||
|
||||
Move removed files there.
|
||||
|
||||
Benefits:
|
||||
|
||||
- safer
|
||||
- recoverable
|
||||
- easier debugging
|
||||
|
||||
Optional:
|
||||
|
||||
- auto-clean after X days
|
||||
|
||||
---
|
||||
|
||||
# 9. Redesign GUI Around Playlists
|
||||
|
||||
Current downloader GUIs are usually task-oriented.
|
||||
|
||||
You should move to:
|
||||
|
||||
```text
|
||||
Playlist-oriented UI
|
||||
```
|
||||
|
||||
Recommended sections:
|
||||
|
||||
```text
|
||||
Sidebar
|
||||
├── Playlists
|
||||
├── Queue
|
||||
├── History
|
||||
├── Logs
|
||||
└── Settings
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 10. Support Infinite Playlist Entries
|
||||
|
||||
Use dynamic UI generation.
|
||||
|
||||
Example:
|
||||
|
||||
```python
|
||||
class PlaylistConfig:
|
||||
url: str
|
||||
path: str
|
||||
mode: str
|
||||
auto_sync: bool
|
||||
```
|
||||
|
||||
GUI should render from:
|
||||
|
||||
```python
|
||||
list[PlaylistConfig]
|
||||
```
|
||||
|
||||
Do NOT hardcode playlist pages.
|
||||
|
||||
---
|
||||
|
||||
# 11. Add Background Sync
|
||||
|
||||
Start simple.
|
||||
|
||||
## Phase 1
|
||||
|
||||
- Timer-based sync
|
||||
- Tray icon
|
||||
- Run minimized
|
||||
|
||||
## Phase 2
|
||||
|
||||
- Background daemon/service
|
||||
- Headless mode
|
||||
- Autostart support
|
||||
|
||||
---
|
||||
|
||||
# 12. Add Progress/Event System
|
||||
|
||||
Needed for GUI responsiveness.
|
||||
|
||||
Recommended:
|
||||
|
||||
```text
|
||||
event_bus.py
|
||||
```
|
||||
|
||||
Events:
|
||||
|
||||
```text
|
||||
DownloadStarted
|
||||
DownloadProgress
|
||||
SyncStarted
|
||||
SyncFinished
|
||||
FileDeleted
|
||||
PlaylistUpdated
|
||||
```
|
||||
|
||||
This decouples GUI from backend.
|
||||
|
||||
---
|
||||
|
||||
# 13. Introduce Config Management
|
||||
|
||||
Recommended:
|
||||
|
||||
```text
|
||||
config.json
|
||||
```
|
||||
|
||||
Only for:
|
||||
|
||||
- app settings
|
||||
- UI preferences
|
||||
- non-relational settings
|
||||
|
||||
Do NOT store sync state in JSON.
|
||||
|
||||
---
|
||||
|
||||
# Suggested Folder Structure
|
||||
|
||||
```text
|
||||
app/
|
||||
├── core/
|
||||
│ ├── scanner/
|
||||
│ ├── sync/
|
||||
│ ├── download/
|
||||
│ ├── database/
|
||||
│ ├── scheduler/
|
||||
│ └── events/
|
||||
│
|
||||
├── gui/
|
||||
│ ├── pages/
|
||||
│ ├── widgets/
|
||||
│ ├── dialogs/
|
||||
│ └── models/
|
||||
│
|
||||
├── config/
|
||||
├── logs/
|
||||
├── data/
|
||||
└── main.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Suggested Sync Flow
|
||||
|
||||
```text
|
||||
Load playlists
|
||||
↓
|
||||
Scheduler triggers sync
|
||||
↓
|
||||
Scanner fetches remote playlist
|
||||
↓
|
||||
Database state loaded
|
||||
↓
|
||||
Filesystem scanned
|
||||
↓
|
||||
Diff engine computes actions
|
||||
↓
|
||||
Queue downloads
|
||||
↓
|
||||
Reorder files
|
||||
↓
|
||||
Move removed files
|
||||
↓
|
||||
Update database
|
||||
↓
|
||||
Emit GUI events
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Recommended MVP Conversion Order
|
||||
|
||||
## Phase 1 — Backend Foundation
|
||||
|
||||
Implement:
|
||||
|
||||
- SQLite
|
||||
- playlist scanner
|
||||
- diff engine
|
||||
- download wrapper
|
||||
- basic sync logic
|
||||
|
||||
No GUI redesign yet.
|
||||
|
||||
---
|
||||
|
||||
# Phase 2 — Stable Syncing
|
||||
|
||||
Implement:
|
||||
|
||||
- deletion handling
|
||||
- reorder handling
|
||||
- queue system
|
||||
- retry system
|
||||
- logs
|
||||
|
||||
---
|
||||
|
||||
# Phase 3 — GUI Rewrite
|
||||
|
||||
Implement:
|
||||
|
||||
- playlist manager UI
|
||||
- queue page
|
||||
- logs page
|
||||
- settings page
|
||||
- dynamic playlists
|
||||
|
||||
---
|
||||
|
||||
# Phase 4 — Automation
|
||||
|
||||
Implement:
|
||||
|
||||
- background sync
|
||||
- tray mode
|
||||
- startup sync
|
||||
- periodic sync
|
||||
|
||||
---
|
||||
|
||||
# Important Recommendations
|
||||
|
||||
## Recommendation 1
|
||||
|
||||
Treat:
|
||||
|
||||
```text
|
||||
video_id
|
||||
```
|
||||
|
||||
as the canonical identity.
|
||||
|
||||
Never titles.
|
||||
|
||||
---
|
||||
|
||||
# Recommendation 2
|
||||
|
||||
Do NOT rely on yt-dlp archive files alone.
|
||||
|
||||
Your own DB should be the source of truth.
|
||||
|
||||
---
|
||||
|
||||
# Recommendation 3
|
||||
|
||||
Keep download logic isolated.
|
||||
|
||||
yt-dlp should be replaceable internally.
|
||||
|
||||
---
|
||||
|
||||
# Recommendation 4
|
||||
|
||||
Do not overcomplicate the GUI early.
|
||||
|
||||
Focus on sync correctness first.
|
||||
|
||||
Sync reliability matters more than appearance.
|
||||
|
||||
---
|
||||
|
||||
# Recommendation 5
|
||||
|
||||
Design everything around interruption recovery.
|
||||
|
||||
The app should survive:
|
||||
|
||||
- crashes
|
||||
- partial downloads
|
||||
- force closes
|
||||
- network failures
|
||||
- playlist changes mid-sync
|
||||
|
||||
---
|
||||
|
||||
# Recommendation 6
|
||||
|
||||
Keep the application local-first.
|
||||
|
||||
No account system. No cloud backend. No telemetry.
|
||||
|
||||
That becomes a strong project identity.
|
||||
|
||||
---
|
||||
|
||||
# Final Recommended Identity
|
||||
|
||||
Instead of:
|
||||
|
||||
```text
|
||||
YouTube Downloader GUI
|
||||
```
|
||||
|
||||
Position the project as:
|
||||
|
||||
```text
|
||||
Local-first YouTube playlist synchronization client.
|
||||
```
|
||||
|
||||
That identity is:
|
||||
|
||||
- clearer
|
||||
- more unique
|
||||
- technically stronger
|
||||
- easier to expand later
|
||||
@@ -0,0 +1,38 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=61.0", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "ytplst"
|
||||
version = "1.1.1"
|
||||
description = "YouTube playlist Sync Thing"
|
||||
readme = "README.md"
|
||||
authors = [ { name = "Dark_Zoul" } ]
|
||||
license = { file = "LICENSE" }
|
||||
keywords = ["youtube", "yt-dlp", "playlist", "sync"]
|
||||
requires-python = ">=3.10"
|
||||
dependencies = [
|
||||
"yt-dlp>=2026.3.17",
|
||||
]
|
||||
[project.optional-dependencies]
|
||||
gui = [
|
||||
"PySide6"
|
||||
]
|
||||
dev = [
|
||||
"pytest",
|
||||
"ruff",
|
||||
"black"
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Home = "https://github.com/darkzoul5/YoutubePlaylistSyncThing"
|
||||
|
||||
[project.scripts]
|
||||
ytplst = "ytplst.main:main"
|
||||
|
||||
[tool.setuptools]
|
||||
package-dir = {"" = "src"}
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
include = ["ytplst*"]
|
||||
@@ -0,0 +1,5 @@
|
||||
[pytest]
|
||||
testpaths = tests
|
||||
# Collect all standardized tests using the conventional pattern
|
||||
python_files = test_*.py
|
||||
addopts = -q
|
||||
@@ -0,0 +1,10 @@
|
||||
"""
|
||||
App package: backend foundation for playlist sync (no GUI).
|
||||
|
||||
This package is the new, state-driven backend. It is intentionally
|
||||
minimal at this stage and will be filled out iteratively.
|
||||
"""
|
||||
|
||||
__all__ = [
|
||||
"core",
|
||||
]
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
from pathlib import Path
|
||||
|
||||
from .config.settings import Settings
|
||||
from .core.database.db import Database
|
||||
from .core.sync.service import SyncService
|
||||
from .core.sync.executor import ActionExecutor
|
||||
from .core.events.event_bus import EventBus
|
||||
import re
|
||||
from .core.utils.yt import extract_playlist_id
|
||||
from .core.utils.deps import DependencyError
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
parser = argparse.ArgumentParser(description="YouTube Playlist Sync — compute/apply actions")
|
||||
parser.add_argument("--apply", action="store_true", help="Apply actions (otherwise compute-only)")
|
||||
parser.add_argument("--db", type=Path, default=Path("app/data/app.db"), help="Path to SQLite database")
|
||||
parser.add_argument("--playlist", type=int, default=None, help="Only run for a specific playlist index (0-based)")
|
||||
parser.add_argument("--verbose", action="store_true", help="Print detailed events (rename/recycle/start)")
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
settings = Settings()
|
||||
db = Database(args.db.resolve())
|
||||
service = SyncService(db)
|
||||
bus = EventBus()
|
||||
executor = ActionExecutor(db, event_bus=bus)
|
||||
|
||||
seen_errors: set[str] = set()
|
||||
|
||||
ansi = re.compile(r"\x1b\[[0-9;]*m")
|
||||
|
||||
async def on_started(payload):
|
||||
if args.verbose:
|
||||
vid = payload.get("video_id")
|
||||
target = payload.get("target")
|
||||
print(f"START: {vid} → {target}")
|
||||
|
||||
async def on_completed(payload):
|
||||
pid = payload.get("playlist_id")
|
||||
vid = payload.get("video_id")
|
||||
target = payload.get("target")
|
||||
print(f"OK: {vid} → {target}")
|
||||
|
||||
async def on_failed(payload):
|
||||
raw = str(payload.get("error", "failed"))
|
||||
msg = ansi.sub("", raw)
|
||||
# Print only once per unique message
|
||||
if msg not in seen_errors:
|
||||
seen_errors.add(msg)
|
||||
# Friendly hint for missing ffmpeg
|
||||
if "ffmpeg not found" in msg.lower():
|
||||
print("ERROR: ffmpeg not found. Install ffmpeg or set 'ffmpeg_path' in config.")
|
||||
else:
|
||||
print(f"ERROR: {msg}")
|
||||
|
||||
# Subscribe to key events
|
||||
bus.subscribe("DownloadStarted", on_started)
|
||||
bus.subscribe("DownloadCompleted", on_completed)
|
||||
bus.subscribe("DownloadFailed", on_failed)
|
||||
if args.verbose:
|
||||
async def on_rename(payload):
|
||||
print(f"RENAME: {payload.get('video_id')} → {payload.get('to')}")
|
||||
async def on_recycle(payload):
|
||||
print(f"RECYCLE: {payload.get('video_id')} ← {payload.get('name')}")
|
||||
bus.subscribe("RenameApplied", on_rename)
|
||||
bus.subscribe("FileRecycled", on_recycle)
|
||||
|
||||
playlists = settings.playlists
|
||||
if args.playlist is not None:
|
||||
playlists = [playlists[args.playlist]] if 0 <= args.playlist < len(playlists) else []
|
||||
|
||||
for pl in playlists:
|
||||
url = pl.get("url")
|
||||
pid = extract_playlist_id(url) or (url or "")
|
||||
try:
|
||||
actions = service.sync_from_config(pl)
|
||||
except ImportError as e:
|
||||
msg = str(e)
|
||||
if "yt_dlp" in msg or "yt-dlp" in msg:
|
||||
print("yt-dlp Python package is required. Install with: pip install -U yt-dlp")
|
||||
return 2
|
||||
raise
|
||||
counts: dict[str, int] = {}
|
||||
for a in actions:
|
||||
counts[a.type.name] = counts.get(a.type.name, 0) + 1
|
||||
summary = ", ".join(f"{k}:{v}" for k, v in sorted(counts.items()))
|
||||
print(f"Playlist {pid}: {len(actions)} actions → {summary}")
|
||||
if args.apply and actions:
|
||||
try:
|
||||
asyncio.run(executor.execute(actions, pl))
|
||||
except DependencyError as e:
|
||||
print(f"ERROR: {e}")
|
||||
return 2
|
||||
db.set_playlist_last_sync(pid)
|
||||
print(f"Applied actions for {pid}.")
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
@@ -0,0 +1 @@
|
||||
"""Config loader for the new backend (separate from legacy)."""
|
||||
@@ -0,0 +1,75 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
|
||||
def _default_ffmpeg_path() -> str:
|
||||
if os.name == "nt":
|
||||
return "./bin/ffmpeg.exe"
|
||||
return "./bin/ffmpeg"
|
||||
|
||||
|
||||
DEFAULT_CONFIG: Dict[str, Any] = {
|
||||
"playlists": [],
|
||||
"download_mode": "video",
|
||||
"max_download_quality": "1080p",
|
||||
"save_path": "./downloads",
|
||||
"ffmpeg_path": _default_ffmpeg_path(),
|
||||
}
|
||||
|
||||
|
||||
class Settings:
|
||||
def __init__(self) -> None:
|
||||
base_dir = Path("config")
|
||||
base_dir.mkdir(parents=True, exist_ok=True)
|
||||
self.path = (base_dir / "yt-playlist-config.json").resolve()
|
||||
self.data: Dict[str, Any] = dict(DEFAULT_CONFIG)
|
||||
|
||||
# Ensure there is always a config file at the default path.
|
||||
if not self.path.exists():
|
||||
self._write_default_config(self.path)
|
||||
|
||||
self._load_from_path(self.path)
|
||||
|
||||
def _load_from_path(self, path: Path) -> None:
|
||||
try:
|
||||
self.data.update(json.loads(path.read_text(encoding="utf-8")))
|
||||
except Exception:
|
||||
# Leave defaults if invalid JSON; validation can be added later.
|
||||
pass
|
||||
|
||||
def _write_default_config(self, path: Path) -> None:
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
default_payload: Dict[str, Any] = {
|
||||
"playlists": [
|
||||
{
|
||||
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID",
|
||||
"download_mode": "video",
|
||||
"max_download_quality": "1080p",
|
||||
"save_path": "./downloads",
|
||||
}
|
||||
],
|
||||
"ffmpeg_path": _default_ffmpeg_path(),
|
||||
}
|
||||
path.write_text(json.dumps(default_payload, indent=2) + "\n", encoding="utf-8")
|
||||
|
||||
@property
|
||||
def playlists(self) -> List[Dict[str, Any]]:
|
||||
global_defaults = {
|
||||
"download_mode": self.data.get("download_mode", DEFAULT_CONFIG["download_mode"]),
|
||||
"max_download_quality": self.data.get("max_download_quality", DEFAULT_CONFIG["max_download_quality"]),
|
||||
"save_path": self.data.get("save_path", DEFAULT_CONFIG["save_path"]),
|
||||
"ffmpeg_path": self.data.get("ffmpeg_path", DEFAULT_CONFIG["ffmpeg_path"]),
|
||||
}
|
||||
|
||||
results: List[Dict[str, Any]] = []
|
||||
for pl in list(self.data.get("playlists", [])):
|
||||
if not isinstance(pl, dict):
|
||||
continue
|
||||
merged = dict(global_defaults)
|
||||
merged.update(pl)
|
||||
results.append(merged)
|
||||
return results
|
||||
@@ -0,0 +1,10 @@
|
||||
"""Core backend modules (scanner, sync, download, db, scheduler, events)."""
|
||||
|
||||
__all__ = [
|
||||
"scanner",
|
||||
"sync",
|
||||
"download",
|
||||
"database",
|
||||
"scheduler",
|
||||
"events",
|
||||
]
|
||||
@@ -0,0 +1 @@
|
||||
"""Database helpers (SQLite)."""
|
||||
@@ -0,0 +1,101 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import sqlite3
|
||||
from pathlib import Path
|
||||
from typing import Iterable
|
||||
|
||||
|
||||
SCHEMA = """
|
||||
PRAGMA journal_mode=WAL;
|
||||
|
||||
CREATE TABLE IF NOT EXISTS playlists (
|
||||
id TEXT PRIMARY KEY,
|
||||
name TEXT,
|
||||
url TEXT,
|
||||
path TEXT,
|
||||
mode TEXT,
|
||||
auto_sync INTEGER,
|
||||
sync_interval_minutes INTEGER,
|
||||
last_sync TEXT
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS playlist_items (
|
||||
playlist_id TEXT,
|
||||
video_id TEXT,
|
||||
title TEXT,
|
||||
playlist_index INTEGER,
|
||||
local_filename TEXT,
|
||||
downloaded INTEGER,
|
||||
last_seen TEXT,
|
||||
PRIMARY KEY (playlist_id, video_id)
|
||||
);
|
||||
"""
|
||||
|
||||
|
||||
class Database:
|
||||
def __init__(self, db_path: Path) -> None:
|
||||
self.path = db_path
|
||||
self.path.parent.mkdir(parents=True, exist_ok=True)
|
||||
self._conn = sqlite3.connect(self.path)
|
||||
self._conn.row_factory = sqlite3.Row
|
||||
self._migrate()
|
||||
|
||||
def _migrate(self) -> None:
|
||||
with self._conn:
|
||||
self._conn.executescript(SCHEMA)
|
||||
|
||||
def upsert_playlist_items(self, rows: Iterable[tuple]):
|
||||
sql = (
|
||||
"INSERT INTO playlist_items (playlist_id, video_id, title, playlist_index, local_filename, downloaded, last_seen) "
|
||||
"VALUES (?, ?, ?, ?, ?, ?, datetime('now')) "
|
||||
"ON CONFLICT(playlist_id, video_id) DO UPDATE SET "
|
||||
"title=excluded.title, playlist_index=excluded.playlist_index, local_filename=excluded.local_filename, "
|
||||
"downloaded=excluded.downloaded, last_seen=datetime('now')"
|
||||
)
|
||||
with self._conn:
|
||||
self._conn.executemany(sql, rows)
|
||||
|
||||
def get_items_index(self, playlist_id: str) -> dict[str, sqlite3.Row]:
|
||||
cur = self._conn.execute(
|
||||
"SELECT * FROM playlist_items WHERE playlist_id = ?",
|
||||
(playlist_id,),
|
||||
)
|
||||
return {row["video_id"]: row for row in cur.fetchall()}
|
||||
|
||||
def upsert_playlist(self, *, id: str, name: str | None, url: str, path: str, mode: str, auto_sync: int = 0, sync_interval_minutes: int = 0) -> None:
|
||||
sql = (
|
||||
"INSERT INTO playlists (id, name, url, path, mode, auto_sync, sync_interval_minutes, last_sync) "
|
||||
"VALUES (?, ?, ?, ?, ?, ?, ?, NULL) "
|
||||
"ON CONFLICT(id) DO UPDATE SET name=excluded.name, url=excluded.url, path=excluded.path, mode=excluded.mode, "
|
||||
"auto_sync=excluded.auto_sync, sync_interval_minutes=excluded.sync_interval_minutes"
|
||||
)
|
||||
with self._conn:
|
||||
self._conn.execute(sql, (id, name, url, path, mode, auto_sync, sync_interval_minutes))
|
||||
|
||||
def update_local_filename(self, playlist_id: str, video_id: str, local_filename: str | None) -> None:
|
||||
with self._conn:
|
||||
self._conn.execute(
|
||||
"UPDATE playlist_items SET local_filename = ?, last_seen = datetime('now') WHERE playlist_id = ? AND video_id = ?",
|
||||
(local_filename, playlist_id, video_id),
|
||||
)
|
||||
|
||||
def mark_downloaded(self, playlist_id: str, video_id: str, downloaded: bool) -> None:
|
||||
with self._conn:
|
||||
self._conn.execute(
|
||||
"UPDATE playlist_items SET downloaded = ?, last_seen = datetime('now') WHERE playlist_id = ? AND video_id = ?",
|
||||
(1 if downloaded else 0, playlist_id, video_id),
|
||||
)
|
||||
|
||||
def clear_file_state(self, playlist_id: str, video_id: str) -> None:
|
||||
with self._conn:
|
||||
self._conn.execute(
|
||||
"UPDATE playlist_items SET local_filename = NULL, downloaded = 0, last_seen = datetime('now') WHERE playlist_id = ? AND video_id = ?",
|
||||
(playlist_id, video_id),
|
||||
)
|
||||
|
||||
def set_playlist_last_sync(self, playlist_id: str) -> None:
|
||||
with self._conn:
|
||||
self._conn.execute(
|
||||
"UPDATE playlists SET last_sync = datetime('now') WHERE id = ?",
|
||||
(playlist_id,),
|
||||
)
|
||||
@@ -0,0 +1,133 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Optional
|
||||
|
||||
from .queue_manager import DownloadJob, JobState
|
||||
|
||||
|
||||
class Downloader:
|
||||
"""
|
||||
Thin wrapper around yt-dlp usage. For MVP, this is a placeholder
|
||||
where actual download logic will land (audio/video/both).
|
||||
"""
|
||||
|
||||
def __init__(self, yt_dlp_path: Optional[str] = None, ffmpeg_path: Optional[str] = None) -> None:
|
||||
self.yt_dlp_path = yt_dlp_path
|
||||
self.ffmpeg_path = ffmpeg_path
|
||||
|
||||
@staticmethod
|
||||
def build_format(max_download_quality) -> str:
|
||||
def parse_height_cap(value) -> int | None:
|
||||
if value is None:
|
||||
return 1080
|
||||
if isinstance(value, int):
|
||||
return value if value > 0 else None
|
||||
s = str(value).strip().lower()
|
||||
if not s:
|
||||
return 1080
|
||||
if s in {"best", "max", "auto"}:
|
||||
return None
|
||||
if s in {"none", "null"}:
|
||||
return 1080
|
||||
digits = "".join(ch for ch in s if ch.isdigit())
|
||||
if not digits:
|
||||
return None
|
||||
try:
|
||||
cap = int(digits)
|
||||
except Exception:
|
||||
return None
|
||||
return cap if cap > 0 else None
|
||||
|
||||
cap = parse_height_cap(max_download_quality)
|
||||
if cap is not None:
|
||||
#if the requested cap isn't available, we still download the best mp4.
|
||||
return f"best[ext=mp4][acodec!=none][vcodec!=none][height<={cap}]/best[ext=mp4][height<={cap}]/best[ext=mp4]"
|
||||
return "best[ext=mp4][acodec!=none][vcodec!=none]/best[ext=mp4]"
|
||||
|
||||
async def handle_job(self, job: DownloadJob):
|
||||
try:
|
||||
job.state = JobState.DOWNLOADING
|
||||
await self._download(job)
|
||||
# Optional local audio extraction when requested
|
||||
if job.mode == "video" and job.audio_output_path is not None:
|
||||
await self._extract_audio(job)
|
||||
# Remove the video if requested (audio-only mode)
|
||||
if not job.keep_video and job.output_path:
|
||||
try:
|
||||
job.output_path.unlink(missing_ok=True)
|
||||
except Exception:
|
||||
pass
|
||||
job.state = JobState.COMPLETED
|
||||
except Exception as exc: # pragma: no cover - environment dependent
|
||||
job.state = JobState.FAILED
|
||||
job.error = str(exc)
|
||||
|
||||
async def _download(self, job: DownloadJob):
|
||||
# Use yt-dlp Python API, executed in a worker thread
|
||||
import asyncio
|
||||
|
||||
def run():
|
||||
import yt_dlp # type: ignore
|
||||
|
||||
class _QuietLogger:
|
||||
def debug(self, msg):
|
||||
pass
|
||||
def warning(self, msg):
|
||||
pass
|
||||
def error(self, msg):
|
||||
# swallow inner repeats; errors are surfaced via exceptions
|
||||
pass
|
||||
def info(self, msg):
|
||||
pass
|
||||
|
||||
outtmpl = str(job.output_path)
|
||||
|
||||
fmt = self.build_format(getattr(job, "max_download_quality", None))
|
||||
|
||||
# All modes download a single muxed mp4 when possible.
|
||||
# This avoids any ffmpeg-driven merging during the download step, satisfying:
|
||||
# - video: "original file, no processing"
|
||||
# - audio/both: extraction is done separately after download
|
||||
ydl_opts = {
|
||||
"format": fmt,
|
||||
"outtmpl": outtmpl,
|
||||
"noplaylist": True,
|
||||
"quiet": True,
|
||||
"no_warnings": True,
|
||||
"logger": _QuietLogger(),
|
||||
}
|
||||
|
||||
with yt_dlp.YoutubeDL(ydl_opts) as ydl: # type: ignore[attr-defined]
|
||||
ydl.download([job.url])
|
||||
|
||||
await asyncio.to_thread(run)
|
||||
|
||||
async def _extract_audio(self, job: DownloadJob):
|
||||
import asyncio
|
||||
from shutil import which
|
||||
|
||||
src = job.output_path
|
||||
dst = job.audio_output_path
|
||||
if not src or not dst:
|
||||
return
|
||||
|
||||
def run():
|
||||
ffmpeg_exe = job.ffmpeg_path or self.ffmpeg_path or which("ffmpeg") or "ffmpeg"
|
||||
import subprocess
|
||||
cmd = [
|
||||
str(ffmpeg_exe),
|
||||
"-y",
|
||||
"-i",
|
||||
str(src),
|
||||
"-vn",
|
||||
"-codec:a",
|
||||
"libmp3lame",
|
||||
"-q:a",
|
||||
"0",
|
||||
str(dst),
|
||||
]
|
||||
subprocess.run(cmd, check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
|
||||
# Mark converting state only for local clarity; not published
|
||||
job.state = JobState.CONVERTING
|
||||
await asyncio.to_thread(run)
|
||||
@@ -0,0 +1,61 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from dataclasses import dataclass
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
from ..models import PlaylistItem
|
||||
|
||||
|
||||
class JobState(str, Enum):
|
||||
QUEUED = "Queued"
|
||||
DOWNLOADING = "Downloading"
|
||||
CONVERTING = "Converting"
|
||||
COMPLETED = "Completed"
|
||||
FAILED = "Failed"
|
||||
SKIPPED = "Skipped"
|
||||
CANCELLED = "Cancelled"
|
||||
|
||||
|
||||
@dataclass
|
||||
class DownloadJob:
|
||||
item: PlaylistItem
|
||||
output_path: Optional[Path] = None
|
||||
url: Optional[str] = None
|
||||
mode: str = "audio" # audio|video
|
||||
state: JobState = JobState.QUEUED
|
||||
error: Optional[str] = None
|
||||
ffmpeg_path: Optional[str] = None
|
||||
max_download_quality: Optional[str] = None
|
||||
audio_output_path: Optional[Path] = None # when mode=video and we also want mp3
|
||||
keep_video: bool = True
|
||||
|
||||
|
||||
class QueueManager:
|
||||
def __init__(self, concurrency: int = 2) -> None:
|
||||
self._queue: "asyncio.Queue[DownloadJob]" = asyncio.Queue()
|
||||
self._concurrency = max(1, concurrency)
|
||||
self._workers: list[asyncio.Task[None]] = []
|
||||
self._stopped = asyncio.Event()
|
||||
|
||||
async def start(self, worker_coro):
|
||||
async def runner(idx: int):
|
||||
while not self._stopped.is_set():
|
||||
job = await self._queue.get()
|
||||
try:
|
||||
await worker_coro(job)
|
||||
finally:
|
||||
self._queue.task_done()
|
||||
|
||||
self._workers = [asyncio.create_task(runner(i)) for i in range(self._concurrency)]
|
||||
|
||||
async def stop(self):
|
||||
self._stopped.set()
|
||||
for w in self._workers:
|
||||
w.cancel()
|
||||
self._workers.clear()
|
||||
|
||||
async def enqueue(self, job: DownloadJob):
|
||||
await self._queue.put(job)
|
||||
@@ -0,0 +1,17 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from .downloader import Downloader
|
||||
from .queue_manager import DownloadJob, JobState
|
||||
|
||||
|
||||
async def default_worker(job: DownloadJob, *, max_retries: int = 2, delay_seconds: float = 1.5):
|
||||
dl = Downloader(ffmpeg_path=job.ffmpeg_path)
|
||||
attempt = 0
|
||||
while attempt <= max_retries:
|
||||
await dl.handle_job(job)
|
||||
if job.state == JobState.COMPLETED:
|
||||
return
|
||||
attempt += 1
|
||||
if attempt <= max_retries:
|
||||
await asyncio.sleep(delay_seconds)
|
||||
@@ -0,0 +1,21 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from collections import defaultdict
|
||||
from typing import Any, Awaitable, Callable, DefaultDict, Dict, List
|
||||
|
||||
|
||||
EventHandler = Callable[[Dict[str, Any]], Awaitable[None]]
|
||||
|
||||
|
||||
class EventBus:
|
||||
"""Simple async pub/sub event bus used by backend and (later) GUI."""
|
||||
|
||||
def __init__(self) -> None:
|
||||
self._subs: DefaultDict[str, List[EventHandler]] = defaultdict(list)
|
||||
|
||||
def subscribe(self, event_name: str, handler: EventHandler) -> None:
|
||||
self._subs[event_name].append(handler)
|
||||
|
||||
async def publish(self, event_name: str, payload: Dict[str, Any]) -> None:
|
||||
for h in list(self._subs.get(event_name, [])):
|
||||
await h(payload)
|
||||
@@ -0,0 +1,56 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
|
||||
class DownloadMode(str, Enum):
|
||||
audio = "audio"
|
||||
video = "video"
|
||||
both = "both"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Playlist:
|
||||
id: str
|
||||
name: Optional[str]
|
||||
url: str
|
||||
path: Path
|
||||
mode: DownloadMode = DownloadMode.audio
|
||||
auto_sync: bool = False
|
||||
sync_interval_minutes: int = 0
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class PlaylistItem:
|
||||
playlist_id: str
|
||||
video_id: str
|
||||
title: str
|
||||
playlist_index: int
|
||||
local_filename: Optional[str] = None
|
||||
downloaded: bool = False
|
||||
|
||||
|
||||
class SyncActionType(str, Enum):
|
||||
DOWNLOAD = "DOWNLOAD"
|
||||
DELETE = "DELETE"
|
||||
RENAME = "RENAME"
|
||||
REORDER = "REORDER"
|
||||
SKIP = "SKIP"
|
||||
REPAIR = "REPAIR"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class SyncAction:
|
||||
type: SyncActionType
|
||||
item: Optional[PlaylistItem] = None
|
||||
from_name: Optional[str] = None
|
||||
to_name: Optional[str] = None
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class FilesystemEntry:
|
||||
name: str
|
||||
path: Path
|
||||
@@ -0,0 +1,54 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import List
|
||||
|
||||
from ..models import PlaylistItem
|
||||
|
||||
|
||||
class PlaylistScanner:
|
||||
"""
|
||||
Fetches remote playlist entries using yt-dlp (no downloads).
|
||||
|
||||
This class intentionally avoids strict dependencies at import time. If
|
||||
yt_dlp is unavailable, call sites should handle the raised ImportError.
|
||||
"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
pass
|
||||
|
||||
def scan(self, playlist_url: str, playlist_id: str) -> List[PlaylistItem]:
|
||||
try:
|
||||
import yt_dlp # type: ignore
|
||||
except Exception as exc: # pragma: no cover - environment dependent
|
||||
raise ImportError("yt_dlp is required to scan playlists") from exc
|
||||
|
||||
ydl_opts = {
|
||||
"extract_flat": True,
|
||||
"skip_download": True,
|
||||
"quiet": True,
|
||||
"dump_single_json": True,
|
||||
}
|
||||
|
||||
with yt_dlp.YoutubeDL(ydl_opts) as ydl: # type: ignore[attr-defined]
|
||||
info = ydl.extract_info(playlist_url, download=False)
|
||||
|
||||
entries = info.get("entries", []) if isinstance(info, dict) else []
|
||||
items: List[PlaylistItem] = []
|
||||
for idx, v in enumerate(entries, start=1):
|
||||
if not v:
|
||||
continue
|
||||
title = v.get("title") or "[Unknown]"
|
||||
if title in ("[Deleted video]", "[Private video]"):
|
||||
continue
|
||||
vid = v.get("id") or ""
|
||||
if not vid:
|
||||
continue
|
||||
items.append(
|
||||
PlaylistItem(
|
||||
playlist_id=playlist_id,
|
||||
video_id=vid,
|
||||
title=title,
|
||||
playlist_index=idx,
|
||||
)
|
||||
)
|
||||
return items
|
||||
@@ -0,0 +1,20 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from datetime import timedelta
|
||||
from typing import Awaitable, Callable
|
||||
|
||||
|
||||
class Scheduler:
|
||||
"""
|
||||
Lightweight placeholder for background scheduling. This can later be
|
||||
swapped for APScheduler without changing call sites.
|
||||
"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
self._jobs: list[tuple[timedelta, Callable[[], Awaitable[None]]]] = []
|
||||
|
||||
def every(self, interval: timedelta, coro_factory: Callable[[], Awaitable[None]]):
|
||||
self._jobs.append((interval, coro_factory))
|
||||
return self
|
||||
|
||||
# A full implementation will run an event loop and await jobs.
|
||||
@@ -0,0 +1,62 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Iterable, List, Mapping, Sequence
|
||||
|
||||
from ..models import FilesystemEntry, PlaylistItem, SyncAction, SyncActionType
|
||||
|
||||
|
||||
class DiffEngine:
|
||||
"""
|
||||
Compares remote playlist items, database state, and filesystem to
|
||||
produce a list of actions. Initial MVP computes DOWNLOAD/RENAME/REORDER
|
||||
based on simple filename scheme "0001 - Title.ext".
|
||||
"""
|
||||
|
||||
def compute_actions(
|
||||
self,
|
||||
remote: Sequence[PlaylistItem],
|
||||
db_index: Mapping[str, PlaylistItem],
|
||||
fs_entries: Iterable[FilesystemEntry],
|
||||
extension: str,
|
||||
) -> List[SyncAction]:
|
||||
actions: List[SyncAction] = []
|
||||
|
||||
desired_names = {
|
||||
item.video_id: f"{item.playlist_index:04d} - {item.title}{extension}"
|
||||
for item in remote
|
||||
}
|
||||
|
||||
fs_by_name = {e.name: e for e in fs_entries}
|
||||
|
||||
for item in remote:
|
||||
desired_name = desired_names[item.video_id]
|
||||
# If DB knows the current local filename and it already matches and exists -> nothing to do
|
||||
if item.local_filename == desired_name and desired_name in fs_by_name:
|
||||
continue
|
||||
|
||||
# If DB knows a different current filename and it exists -> plan a rename
|
||||
if item.local_filename and item.local_filename in fs_by_name and item.local_filename != desired_name:
|
||||
actions.append(
|
||||
SyncAction(
|
||||
SyncActionType.RENAME,
|
||||
item=item,
|
||||
from_name=item.local_filename,
|
||||
to_name=desired_name,
|
||||
)
|
||||
)
|
||||
continue
|
||||
|
||||
# If the desired file already exists on disk but DB doesn't reflect it -> skip (already correct)
|
||||
if desired_name in fs_by_name:
|
||||
actions.append(SyncAction(SyncActionType.SKIP, item=item, to_name=desired_name))
|
||||
continue
|
||||
|
||||
# Otherwise, we need to download
|
||||
actions.append(SyncAction(SyncActionType.DOWNLOAD, item=item, to_name=desired_name))
|
||||
|
||||
known_ids = {i.video_id for i in remote}
|
||||
for vid, db_item in db_index.items():
|
||||
if vid not in known_ids and db_item.local_filename:
|
||||
actions.append(SyncAction(SyncActionType.DELETE, item=db_item, from_name=db_item.local_filename))
|
||||
|
||||
return actions
|
||||
@@ -0,0 +1,246 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from typing import Iterable, List
|
||||
|
||||
from ..download.queue_manager import DownloadJob, QueueManager
|
||||
from ..download.workers import default_worker
|
||||
from ..models import SyncAction, SyncActionType
|
||||
from ..sync.reorder import safe_multi_rename
|
||||
from ..database.db import Database
|
||||
from ..utils.yt import extract_playlist_id
|
||||
from ..events.event_bus import EventBus
|
||||
from ..utils.deps import ensure_ffmpeg_available, ensure_yt_dlp_available
|
||||
|
||||
|
||||
class ActionExecutor:
|
||||
def __init__(self, db: Database, concurrency: int = 2, event_bus: EventBus | None = None) -> None:
|
||||
self.concurrency = max(1, concurrency)
|
||||
self.db = db
|
||||
self.bus = event_bus
|
||||
|
||||
async def execute(self, actions: Iterable[SyncAction], playlist_cfg: dict) -> None:
|
||||
self._preflight_dependencies(actions, playlist_cfg)
|
||||
|
||||
save_path = Path(playlist_cfg.get("save_path", "./downloads")).resolve()
|
||||
mode = playlist_cfg.get("download_mode", "video")
|
||||
|
||||
# Prepare roots
|
||||
audio_root = save_path / "audio"
|
||||
video_root = save_path / "video"
|
||||
audio_root.mkdir(parents=True, exist_ok=True)
|
||||
video_root.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# First, handle renames safely in batch per extension
|
||||
await self._apply_renames(actions, audio_root, video_root, playlist_cfg)
|
||||
|
||||
# Then, recycle deletions
|
||||
self._apply_deletions(actions, audio_root, video_root, playlist_cfg)
|
||||
|
||||
# Finally, perform downloads concurrently
|
||||
await self._apply_downloads(actions, mode, audio_root, video_root, playlist_cfg)
|
||||
|
||||
def _preflight_dependencies(self, actions: Iterable[SyncAction], playlist_cfg: dict) -> None:
|
||||
"""
|
||||
Fail fast on core runtime dependencies before doing any filesystem work.
|
||||
|
||||
This keeps errors consistent regardless of entrypoint (CLI, bootstrap, tests, etc.).
|
||||
"""
|
||||
needs_download = any(a.type == SyncActionType.DOWNLOAD for a in actions)
|
||||
if not needs_download:
|
||||
return
|
||||
|
||||
# yt-dlp is required for any download job (Python API usage)
|
||||
ensure_yt_dlp_available()
|
||||
|
||||
# ffmpeg is only required when we will extract audio (audio/both modes)
|
||||
needs_audio = any((a.to_name or "").lower().endswith(".mp3") for a in actions if a.type == SyncActionType.DOWNLOAD)
|
||||
if needs_audio:
|
||||
ffmpeg_hint = playlist_cfg.get("ffmpeg_path", "ffmpeg")
|
||||
ensure_ffmpeg_available(str(ffmpeg_hint) if ffmpeg_hint is not None else None)
|
||||
|
||||
async def _apply_renames(self, actions: Iterable[SyncAction], audio_root: Path, video_root: Path, playlist_cfg: dict) -> None:
|
||||
playlist_id = extract_playlist_id(playlist_cfg.get("url", "")) or playlist_cfg.get("url", "")
|
||||
audio_renames = []
|
||||
video_renames = []
|
||||
applied: List[SyncAction] = []
|
||||
for a in actions:
|
||||
if a.type != SyncActionType.RENAME or not a.from_name or not a.to_name:
|
||||
continue
|
||||
if a.to_name.endswith(".mp3"):
|
||||
audio_renames.append((audio_root / a.from_name, audio_root / a.to_name))
|
||||
elif a.to_name.endswith(".mp4"):
|
||||
video_renames.append((video_root / a.from_name, video_root / a.to_name))
|
||||
applied.append(a)
|
||||
|
||||
if audio_renames:
|
||||
safe_multi_rename(audio_renames)
|
||||
if video_renames:
|
||||
safe_multi_rename(video_renames)
|
||||
|
||||
# Update DB filenames after successful rename attempts
|
||||
for a in applied:
|
||||
if a.item and a.to_name:
|
||||
try:
|
||||
self.db.update_local_filename(playlist_id, a.item.video_id, a.to_name)
|
||||
except Exception:
|
||||
pass
|
||||
if self.bus:
|
||||
await self.bus.publish("RenameApplied", {"playlist_id": playlist_id, "video_id": a.item.video_id, "to": a.to_name})
|
||||
|
||||
def _apply_deletions(self, actions: Iterable[SyncAction], audio_root: Path, video_root: Path, playlist_cfg: dict) -> None:
|
||||
playlist_id = extract_playlist_id(playlist_cfg.get("url", "")) or playlist_cfg.get("url", "")
|
||||
recycle_audio = audio_root.parent / ".recycle" / "audio"
|
||||
recycle_video = video_root.parent / ".recycle" / "video"
|
||||
recycle_audio.mkdir(parents=True, exist_ok=True)
|
||||
recycle_video.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
for a in actions:
|
||||
if a.type != SyncActionType.DELETE or not a.from_name:
|
||||
continue
|
||||
if a.from_name.endswith(".mp3"):
|
||||
src = audio_root / a.from_name
|
||||
dst = recycle_audio / a.from_name
|
||||
else:
|
||||
src = video_root / a.from_name
|
||||
dst = recycle_video / a.from_name
|
||||
if src.exists():
|
||||
try:
|
||||
if dst.exists():
|
||||
dst.unlink()
|
||||
shutil.move(str(src), str(dst))
|
||||
except Exception:
|
||||
# fallback to delete if move fails
|
||||
try:
|
||||
src.unlink()
|
||||
except Exception:
|
||||
pass
|
||||
# Update DB to clear file state
|
||||
if a.item:
|
||||
try:
|
||||
self.db.clear_file_state(playlist_id, a.item.video_id)
|
||||
except Exception:
|
||||
pass
|
||||
if self.bus:
|
||||
asyncio.create_task(self.bus.publish("FileRecycled", {"playlist_id": playlist_id, "video_id": a.item.video_id, "name": a.from_name}))
|
||||
|
||||
async def _apply_downloads(self, actions: Iterable[SyncAction], mode: str, audio_root: Path, video_root: Path, playlist_cfg: dict) -> None:
|
||||
playlist_id = extract_playlist_id(playlist_cfg.get("url", "")) or playlist_cfg.get("url", "")
|
||||
queue = QueueManager(concurrency=self.concurrency)
|
||||
|
||||
async def worker(job: DownloadJob):
|
||||
if self.bus and job.item:
|
||||
await self.bus.publish("DownloadStarted", {"playlist_id": playlist_id, "video_id": job.item.video_id, "target": str(job.output_path)})
|
||||
await default_worker(job)
|
||||
|
||||
await queue.start(worker)
|
||||
try:
|
||||
jobs: List[DownloadJob] = []
|
||||
|
||||
# Collapse 'both' into single video download + local audio extraction
|
||||
# Build per-video desired outputs
|
||||
by_vid: dict[str, dict[str, str]] = {}
|
||||
for a in actions:
|
||||
if a.type != SyncActionType.DOWNLOAD or not a.item or not a.to_name:
|
||||
continue
|
||||
d = by_vid.setdefault(a.item.video_id, {})
|
||||
if a.to_name.endswith(".mp3"):
|
||||
d["audio"] = a.to_name
|
||||
elif a.to_name.endswith(".mp4"):
|
||||
d["video"] = a.to_name
|
||||
|
||||
ffmpeg_cfg = str(playlist_cfg.get("ffmpeg_path", "ffmpeg")) if playlist_cfg.get("ffmpeg_path") is not None else None
|
||||
max_quality_cfg = playlist_cfg.get("max_download_quality")
|
||||
temp_video_root = video_root / ".tmp"
|
||||
temp_video_root.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
for a in actions:
|
||||
if a.type != SyncActionType.DOWNLOAD or not a.item or not a.to_name:
|
||||
continue
|
||||
vid = a.item.video_id
|
||||
targets = by_vid.get(vid, {})
|
||||
|
||||
# If both audio and video requested for this video id, enqueue only video job with audio_output_path
|
||||
if targets.get("audio") and targets.get("video"):
|
||||
# only create job once, when encountering the video target
|
||||
if a.to_name.endswith(".mp4"):
|
||||
video_path = video_root / targets["video"]
|
||||
audio_path = audio_root / targets["audio"]
|
||||
for p in (video_path.parent, audio_path.parent):
|
||||
p.mkdir(parents=True, exist_ok=True)
|
||||
url = f"https://www.youtube.com/watch?v={vid}"
|
||||
job = DownloadJob(
|
||||
item=a.item,
|
||||
output_path=video_path,
|
||||
url=url,
|
||||
mode="video",
|
||||
ffmpeg_path=ffmpeg_cfg,
|
||||
max_download_quality=max_quality_cfg,
|
||||
audio_output_path=audio_path,
|
||||
)
|
||||
jobs.append(job)
|
||||
await queue.enqueue(job)
|
||||
# skip creating a separate audio job
|
||||
continue
|
||||
|
||||
# Normal single-output path
|
||||
is_audio = a.to_name.endswith(".mp3")
|
||||
url = f"https://www.youtube.com/watch?v={vid}"
|
||||
|
||||
if is_audio:
|
||||
# Audio-only: download video to temp, extract mp3, then delete video
|
||||
audio_path = audio_root / a.to_name
|
||||
audio_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
# build temp video filename from audio base
|
||||
temp_base = a.to_name.rsplit(".", 1)[0] + ".mp4"
|
||||
video_temp = temp_video_root / temp_base
|
||||
job = DownloadJob(
|
||||
item=a.item,
|
||||
output_path=video_temp,
|
||||
url=url,
|
||||
mode="video",
|
||||
ffmpeg_path=ffmpeg_cfg,
|
||||
max_download_quality=max_quality_cfg,
|
||||
audio_output_path=audio_path,
|
||||
keep_video=False,
|
||||
)
|
||||
jobs.append(job)
|
||||
await queue.enqueue(job)
|
||||
else:
|
||||
# Video-only
|
||||
video_path = video_root / a.to_name
|
||||
video_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
job = DownloadJob(
|
||||
item=a.item,
|
||||
output_path=video_path,
|
||||
url=url,
|
||||
mode="video",
|
||||
ffmpeg_path=ffmpeg_cfg,
|
||||
max_download_quality=max_quality_cfg,
|
||||
)
|
||||
jobs.append(job)
|
||||
await queue.enqueue(job)
|
||||
finally:
|
||||
await queue._queue.join() # wait for all jobs
|
||||
await queue.stop()
|
||||
|
||||
# Persist DB updates for completed jobs
|
||||
for job in locals().get("jobs", []):
|
||||
if job.item and job.output_path:
|
||||
try:
|
||||
if job.state.name == "COMPLETED":
|
||||
# Prefer audio filename if produced
|
||||
final_name = job.audio_output_path.name if job.audio_output_path is not None else job.output_path.name
|
||||
self.db.update_local_filename(playlist_id, job.item.video_id, final_name)
|
||||
self.db.mark_downloaded(playlist_id, job.item.video_id, True)
|
||||
if self.bus:
|
||||
await self.bus.publish("DownloadCompleted", {"playlist_id": playlist_id, "video_id": job.item.video_id, "target": str(job.audio_output_path or job.output_path)})
|
||||
else:
|
||||
# Ensure not marked as downloaded if failed
|
||||
self.db.mark_downloaded(playlist_id, job.item.video_id, False)
|
||||
if self.bus:
|
||||
await self.bus.publish("DownloadFailed", {"playlist_id": playlist_id, "video_id": job.item.video_id, "error": job.error or "unknown"})
|
||||
except Exception:
|
||||
pass
|
||||
@@ -0,0 +1,17 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Iterable, List, Sequence
|
||||
|
||||
from ..models import FilesystemEntry
|
||||
|
||||
|
||||
def list_files(root: Path, extensions: Sequence[str]) -> List[FilesystemEntry]:
|
||||
exts = {e.lower() for e in extensions}
|
||||
results: List[FilesystemEntry] = []
|
||||
if not root.exists():
|
||||
return results
|
||||
for p in root.glob("**/*"):
|
||||
if p.is_file() and p.suffix.lower() in exts:
|
||||
results.append(FilesystemEntry(name=p.name, path=p))
|
||||
return results
|
||||
@@ -0,0 +1,43 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Dict, Iterable, Tuple
|
||||
|
||||
|
||||
def safe_multi_rename(renames: Iterable[Tuple[Path, Path]]) -> None:
|
||||
"""
|
||||
Apply multiple renames safely using a two-pass strategy to avoid
|
||||
name collisions. Each item is a tuple (src_path, dst_path).
|
||||
"""
|
||||
temp_suffix = ".renametemp"
|
||||
planned = list(renames)
|
||||
existing_dests = {dst for _, dst in planned}
|
||||
|
||||
# Pass 1: move all sources that would collide to temporary names
|
||||
temps: Dict[Path, Path] = {}
|
||||
for src, dst in planned:
|
||||
if not src.exists():
|
||||
continue
|
||||
if src.name == dst.name:
|
||||
continue
|
||||
# If destination exists or another source will become destination, use temp
|
||||
if dst.exists() or dst in existing_dests:
|
||||
tmp = src.with_suffix(src.suffix + temp_suffix)
|
||||
# Ensure unique temp
|
||||
i = 0
|
||||
while tmp.exists():
|
||||
i += 1
|
||||
tmp = src.with_name(src.name + f".{i}" + temp_suffix)
|
||||
src.rename(tmp)
|
||||
temps[tmp] = dst
|
||||
else:
|
||||
# direct rename safe
|
||||
src.rename(dst)
|
||||
|
||||
# Pass 2: move all temp files to their final destinations
|
||||
for tmp, dst in temps.items():
|
||||
if not tmp.exists():
|
||||
continue
|
||||
if dst.exists():
|
||||
dst.unlink()
|
||||
tmp.rename(dst)
|
||||
@@ -0,0 +1,137 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import asdict
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
from ..database.db import Database
|
||||
from ..models import PlaylistItem, SyncAction
|
||||
from ..scanner.playlist_scanner import PlaylistScanner
|
||||
from ..sync.diff_engine import DiffEngine
|
||||
from ..sync.filesystem import list_files
|
||||
from ..utils.naming import make_filename, sanitize_title
|
||||
from ..utils.yt import extract_playlist_id
|
||||
|
||||
|
||||
class SyncService:
|
||||
def __init__(self, db: Database) -> None:
|
||||
self.db = db
|
||||
self.scanner = PlaylistScanner()
|
||||
self.diff = DiffEngine()
|
||||
|
||||
def _mode_to_extensions(self, mode: str) -> list[str]:
|
||||
if mode == "audio":
|
||||
return [".mp3"]
|
||||
if mode == "video":
|
||||
return [".mp4"]
|
||||
if mode == "both":
|
||||
return [".mp3", ".mp4"]
|
||||
return [".mp3"]
|
||||
|
||||
def sync_from_config(self, playlist_cfg: dict) -> List[SyncAction]:
|
||||
url: str = playlist_cfg.get("url")
|
||||
mode: str = playlist_cfg.get("download_mode", "audio")
|
||||
save_path = Path(playlist_cfg.get("save_path", "./downloads")).resolve()
|
||||
save_path.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
playlist_id = extract_playlist_id(url) or url
|
||||
# Ensure playlist row exists/updated
|
||||
self.db.upsert_playlist(
|
||||
id=playlist_id,
|
||||
name=playlist_cfg.get("name"),
|
||||
url=url,
|
||||
path=str(save_path),
|
||||
mode=mode,
|
||||
auto_sync=int(bool(playlist_cfg.get("auto_sync", False))),
|
||||
sync_interval_minutes=int(playlist_cfg.get("sync_interval_minutes", 0) or 0),
|
||||
)
|
||||
items = self.scanner.scan(url, playlist_id)
|
||||
|
||||
sanitized: List[PlaylistItem] = []
|
||||
for it in items:
|
||||
safe_title = sanitize_title(it.title, it.video_id)
|
||||
sanitized.append(
|
||||
PlaylistItem(
|
||||
playlist_id=it.playlist_id,
|
||||
video_id=it.video_id,
|
||||
title=safe_title,
|
||||
playlist_index=it.playlist_index,
|
||||
local_filename=None,
|
||||
downloaded=False,
|
||||
)
|
||||
)
|
||||
|
||||
rows = [
|
||||
(
|
||||
it.playlist_id,
|
||||
it.video_id,
|
||||
it.title,
|
||||
it.playlist_index,
|
||||
None,
|
||||
0,
|
||||
)
|
||||
for it in sanitized
|
||||
]
|
||||
self.db.upsert_playlist_items(rows)
|
||||
|
||||
db_index_rows = self.db.get_items_index(playlist_id)
|
||||
db_index: dict[str, PlaylistItem] = {}
|
||||
for vid, row in db_index_rows.items():
|
||||
db_index[vid] = PlaylistItem(
|
||||
playlist_id=row["playlist_id"],
|
||||
video_id=row["video_id"],
|
||||
title=row["title"],
|
||||
playlist_index=row["playlist_index"],
|
||||
local_filename=row["local_filename"],
|
||||
downloaded=bool(row["downloaded"]),
|
||||
)
|
||||
|
||||
# Augment remote items with DB-known filenames/download flags
|
||||
augmented: List[PlaylistItem] = []
|
||||
for it in sanitized:
|
||||
known = db_index.get(it.video_id)
|
||||
if known is None:
|
||||
augmented.append(it)
|
||||
else:
|
||||
augmented.append(
|
||||
PlaylistItem(
|
||||
playlist_id=it.playlist_id,
|
||||
video_id=it.video_id,
|
||||
title=it.title,
|
||||
playlist_index=it.playlist_index,
|
||||
local_filename=known.local_filename,
|
||||
downloaded=known.downloaded,
|
||||
)
|
||||
)
|
||||
|
||||
exts = self._mode_to_extensions(mode)
|
||||
merged_actions: List[SyncAction] = []
|
||||
|
||||
# Compute per-extension actions against respective roots
|
||||
for ext in exts:
|
||||
if ext == ".mp3":
|
||||
fs = list_files(save_path / "audio", [".mp3"])
|
||||
elif ext == ".mp4":
|
||||
fs = list_files(save_path / "video", [".mp4"])
|
||||
else:
|
||||
fs = list_files(save_path, [ext])
|
||||
actions = self.diff.compute_actions(augmented, db_index, fs, ext)
|
||||
merged_actions.extend(actions)
|
||||
|
||||
return merged_actions
|
||||
for ext in exts:
|
||||
mode_dir = "audio" if ext == ".mp3" else "video"
|
||||
fs_root = (save_path / mode_dir)
|
||||
fs_entries = list_files(fs_root, [ext])
|
||||
actions = self.diff.compute_actions(sanitized, db_index, fs_entries, ext)
|
||||
merged_actions.extend(actions)
|
||||
|
||||
return [
|
||||
{
|
||||
"type": a.type,
|
||||
"video_id": a.item.video_id if a.item else None,
|
||||
"from_name": a.from_name,
|
||||
"to_name": a.to_name,
|
||||
}
|
||||
for a in merged_actions
|
||||
]
|
||||
@@ -0,0 +1 @@
|
||||
"""Utility helpers for naming, parsing, etc."""
|
||||
@@ -0,0 +1,93 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
from shutil import which
|
||||
from typing import Optional, Tuple
|
||||
|
||||
|
||||
class DependencyError(RuntimeError):
|
||||
pass
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class DependencyStatus:
|
||||
yt_dlp_ok: bool
|
||||
yt_dlp_version: Optional[str]
|
||||
ffmpeg_ok: bool
|
||||
ffmpeg_path: Optional[str]
|
||||
ffprobe_ok: bool
|
||||
ffprobe_path: Optional[str]
|
||||
|
||||
|
||||
def get_yt_dlp_version() -> Optional[str]:
|
||||
try:
|
||||
import yt_dlp # type: ignore
|
||||
|
||||
# yt-dlp exposes version in different places depending on install
|
||||
return getattr(yt_dlp, "__version__", None) or getattr(getattr(yt_dlp, "version", None), "__version__", None)
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def ensure_yt_dlp_available() -> str:
|
||||
"""
|
||||
Ensures yt-dlp Python package is importable. Returns version string when known.
|
||||
"""
|
||||
try:
|
||||
import yt_dlp # noqa: F401 # type: ignore
|
||||
except Exception as exc:
|
||||
raise DependencyError("yt-dlp Python package is required. Install with: pip install -U yt-dlp") from exc
|
||||
return get_yt_dlp_version() or "unknown"
|
||||
|
||||
|
||||
def _resolve_tool_paths(tool_hint: Optional[str], exe_name: str) -> Tuple[Optional[str], Optional[str]]:
|
||||
"""
|
||||
Returns (resolved_exe_path, resolved_dir_hint).
|
||||
- If tool_hint is a file path, use it.
|
||||
- If tool_hint is a directory, append exe_name.
|
||||
- Otherwise, treat tool_hint as a command and fall back to PATH resolution.
|
||||
"""
|
||||
if tool_hint:
|
||||
hint_str = str(tool_hint).strip().strip('"').strip("'")
|
||||
hint = Path(hint_str)
|
||||
# Expand envvars (%FFMPEG%) etc.
|
||||
expanded = Path(os.path.expandvars(str(hint)))
|
||||
if expanded.is_dir():
|
||||
cand = expanded / exe_name
|
||||
if cand.exists():
|
||||
return str(cand), str(expanded)
|
||||
if expanded.exists():
|
||||
return str(expanded), str(expanded.parent)
|
||||
|
||||
# PATH lookup
|
||||
found = which(exe_name)
|
||||
if found:
|
||||
return found, str(Path(found).parent)
|
||||
return None, None
|
||||
|
||||
|
||||
def ensure_ffmpeg_available(ffmpeg_hint: Optional[str]) -> Tuple[str, str]:
|
||||
"""
|
||||
Ensures ffmpeg is runnable. Returns (ffmpeg_path, ffmpeg_path).
|
||||
|
||||
Note: ffprobe is intentionally not required. This project uses ffmpeg directly for
|
||||
audio extraction, and yt-dlp can still function for muxed downloads without ffprobe.
|
||||
"""
|
||||
ffmpeg_exe = "ffmpeg.exe" if sys.platform.startswith("win") else "ffmpeg"
|
||||
|
||||
ffmpeg_path, ffmpeg_dir = _resolve_tool_paths(ffmpeg_hint, ffmpeg_exe)
|
||||
if not ffmpeg_path:
|
||||
raise DependencyError("ffmpeg not found. Install ffmpeg or set 'ffmpeg_path' in config.")
|
||||
|
||||
# Smoke test (fast)
|
||||
try:
|
||||
subprocess.run([ffmpeg_path, "-version"], check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
except Exception as exc:
|
||||
raise DependencyError("ffmpeg exists but is not runnable. Check permissions/architecture/path.") from exc
|
||||
|
||||
# Keep return shape stable for existing callers
|
||||
return ffmpeg_path, ffmpeg_path
|
||||
@@ -0,0 +1,16 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
|
||||
|
||||
ILLEGAL_CHARS = '<>:"/\\|?*'
|
||||
|
||||
|
||||
def sanitize_title(title: str, fallback: str) -> str:
|
||||
table = str.maketrans({c: "-" for c in ILLEGAL_CHARS})
|
||||
safe = (title or "").translate(table).strip()
|
||||
return safe if safe else fallback
|
||||
|
||||
|
||||
def make_filename(index: int, title: str, ext: str, width: int = 4) -> str:
|
||||
return f"{index:0{width}d} - {title}{ext}"
|
||||
@@ -0,0 +1,14 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from urllib.parse import parse_qs, urlparse
|
||||
|
||||
|
||||
def extract_playlist_id(url: str) -> str | None:
|
||||
try:
|
||||
parsed = urlparse(url)
|
||||
qs = parse_qs(parsed.query)
|
||||
if "list" in qs and qs.get("list"):
|
||||
return qs.get("list", [None])[0]
|
||||
return None
|
||||
except Exception:
|
||||
return None
|
||||
@@ -0,0 +1,57 @@
|
||||
from __future__ import annotations
|
||||
|
||||
"""
|
||||
Entry point for the new backend (no GUI). For now, this only verifies
|
||||
that configuration and database setup work. Future iterations will wire
|
||||
up scanner, diff engine, queue, and scheduler.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from .config.settings import Settings
|
||||
from .core.database.db import Database
|
||||
from .core.sync.service import SyncService
|
||||
from .core.sync.executor import ActionExecutor
|
||||
from .core.models import SyncActionType
|
||||
from .core.utils.yt import extract_playlist_id
|
||||
from .core.utils.deps import DependencyError
|
||||
|
||||
|
||||
def bootstrap(db_path: Path | None = None) -> None:
|
||||
settings = Settings()
|
||||
db = Database((db_path or Path("app/data/app.db")).resolve())
|
||||
service = SyncService(db)
|
||||
executor = ActionExecutor(db)
|
||||
|
||||
# Iterate configured playlists and compute actions (no execution yet)
|
||||
for pl in settings.playlists:
|
||||
try:
|
||||
actions = service.sync_from_config(pl)
|
||||
# Apply actions now
|
||||
if actions:
|
||||
print(f"Applying {len(actions)} actions for: {pl.get('url')}")
|
||||
# Summarize before applying
|
||||
counts = {}
|
||||
for a in actions:
|
||||
counts[a.type] = counts.get(a.type, 0) + 1
|
||||
summary = ", ".join(f"{k.name}:{v}" for k, v in counts.items())
|
||||
print(f"Plan → {summary}")
|
||||
# Execute
|
||||
import asyncio
|
||||
try:
|
||||
asyncio.run(executor.execute(actions, pl))
|
||||
except DependencyError as e:
|
||||
print(f"ERROR: {e}")
|
||||
continue
|
||||
# Post summary (no DB readback yet)
|
||||
pid = extract_playlist_id(pl.get('url', '')) or pl.get('url', '')
|
||||
db.set_playlist_last_sync(pid)
|
||||
print("Applied actions.")
|
||||
else:
|
||||
print(f"No actions needed for: {pl.get('url')}")
|
||||
except Exception as exc: # keep bootstrap resilient during early dev
|
||||
print(f"Failed to sync playlist {pl.get('url')}: {exc}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
bootstrap()
|
||||
@@ -0,0 +1,15 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from src.app.core.download.downloader import Downloader
|
||||
|
||||
|
||||
def test_build_format_defaults_to_best_mp4():
|
||||
fmt = Downloader.build_format(None)
|
||||
assert "height<=1080" in fmt
|
||||
assert fmt.endswith("/best[ext=mp4]")
|
||||
|
||||
|
||||
def test_build_format_applies_height_cap():
|
||||
fmt = Downloader.build_format("720p")
|
||||
assert "height<=720" in fmt
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
from src.app.config.settings import Settings
|
||||
|
||||
|
||||
def test_settings_creates_root_config_if_missing(tmp_path, monkeypatch):
|
||||
monkeypatch.chdir(tmp_path)
|
||||
|
||||
cfg_path = tmp_path / "config" / "yt-playlist-config.json"
|
||||
assert not cfg_path.exists()
|
||||
|
||||
settings = Settings()
|
||||
assert settings.path == cfg_path.resolve()
|
||||
assert cfg_path.exists()
|
||||
|
||||
data = json.loads(cfg_path.read_text(encoding="utf-8"))
|
||||
assert "playlists" in data
|
||||
assert data.get("ffmpeg_path") == ("./bin/ffmpeg.exe" if os.name == "nt" else "./bin/ffmpeg")
|
||||
assert data["playlists"][0].get("download_mode") == "video"
|
||||
assert data["playlists"][0].get("max_download_quality") == "1080p"
|
||||
assert data["playlists"][0].get("save_path") == "./downloads"
|
||||
|
||||
|
||||
def test_settings_reads_config_from_default_location(tmp_path, monkeypatch):
|
||||
monkeypatch.chdir(tmp_path)
|
||||
|
||||
cfg_path = tmp_path / "config" / "yt-playlist-config.json"
|
||||
cfg_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
cfg_path.write_text(json.dumps({"playlists": [{"url": "X"}]}), encoding="utf-8")
|
||||
|
||||
settings = Settings()
|
||||
assert settings.path == cfg_path.resolve()
|
||||
assert settings.playlists and settings.playlists[0]["url"] == "X"
|
||||
assert settings.playlists[0]["download_mode"] == "video"
|
||||
assert settings.playlists[0]["max_download_quality"] == "1080p"
|
||||
assert settings.playlists[0]["save_path"] == "./downloads"
|
||||
@@ -1,524 +0,0 @@
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
import shutil
|
||||
import platform
|
||||
import time
|
||||
import subprocess
|
||||
from urllib.parse import urlparse, parse_qs
|
||||
from pathlib import Path
|
||||
from concurrent.futures import ThreadPoolExecutor, as_completed
|
||||
|
||||
os.chdir(os.path.dirname(os.path.abspath(sys.argv[0])))
|
||||
if platform.system() == "Windows":
|
||||
sys.stdout.reconfigure(encoding="utf-8") # type: ignore
|
||||
|
||||
OK = "✔"
|
||||
FAIL = "✘"
|
||||
WARN = "⚠"
|
||||
INFO = "ℹ"
|
||||
STEP = "➜"
|
||||
|
||||
def is_docker():
|
||||
return os.path.exists("/.dockerenv") or os.getenv("RUNNING_IN_DOCKER") == "true"
|
||||
|
||||
def update_yt_dlp(yt_dlp_path: str):
|
||||
try:
|
||||
subprocess.run(
|
||||
[yt_dlp_path, "-U"],
|
||||
check=True,
|
||||
stdout=subprocess.DEVNULL,
|
||||
stderr=subprocess.PIPE, # capture error output
|
||||
text=True
|
||||
)
|
||||
print(f"{OK} yt-dlp is up to date.")
|
||||
except subprocess.CalledProcessError:
|
||||
print(f"{WARN} Could not update yt-dlp: Internet unavailable or cannot reach update server")
|
||||
|
||||
|
||||
|
||||
class ConfigLoader:
|
||||
DEFAULT_CONFIG = {
|
||||
"playlists": [
|
||||
{
|
||||
"url": "https://www.youtube.com/playlist?list=YOUR_PLAYLIST_ID_HERE",
|
||||
"download_mode": "audio", # options: audio, video, both
|
||||
"max_video_quality": "1080p", # options: 720p, 1080p, 1440p, 2160p, best
|
||||
"save_path": "./downloads",
|
||||
"archive": "archive.txt"
|
||||
}
|
||||
],
|
||||
"yt_dlp_path": "yt-dlp" if is_docker() else ("./bin/yt-dlp.exe" if platform.system() == "Windows" else "./bin/yt-dlp"),
|
||||
"ffmpeg_path": "ffmpeg" if is_docker() else ("./bin/ffmpeg.exe" if platform.system() == "Windows" else "./bin/ffmpeg"),
|
||||
"aria2c_path": "aria2c" if is_docker() else ("./bin/aria2c.exe" if platform.system() == "Windows" else "./bin/aria2c"),
|
||||
"max_parallel_downloads": 10,
|
||||
"aria2c_connections": 8
|
||||
}
|
||||
|
||||
def __init__(self, config_path=None):
|
||||
config_dir = Path("./config")
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
if config_path is None:
|
||||
config_path = config_dir / "yt-playlist-config.json"
|
||||
else:
|
||||
config_path = Path(config_path)
|
||||
if not config_path.is_absolute():
|
||||
config_path = config_dir / config_path
|
||||
self.config_path = Path(config_path).resolve()
|
||||
if not self.config_path.exists():
|
||||
self._create_default_config()
|
||||
print(f"{INFO} Default config created at '{self.config_path}'. Please edit it and rerun.")
|
||||
sys.exit(0)
|
||||
|
||||
with self.config_path.open("r", encoding="utf-8") as f:
|
||||
self.data = json.load(f)
|
||||
|
||||
# Validate binaries
|
||||
self._check_binary(self.yt_dlp_path, "yt-dlp")
|
||||
self._check_binary(self.aria2c_path, "aria2c")
|
||||
# Only require ffmpeg if download_mode is audio or both
|
||||
if self.download_mode in ("audio", "both"):
|
||||
self._check_binary(self.ffmpeg_path, "ffmpeg")
|
||||
|
||||
def _create_default_config(self):
|
||||
with self.config_path.open("w", encoding="utf-8") as f:
|
||||
json.dump(self.DEFAULT_CONFIG, f, indent=2)
|
||||
|
||||
def _check_binary(self, path_str, name):
|
||||
# If path_str looks like a system binary (no slashes), check PATH only
|
||||
if os.sep not in path_str and '/' not in path_str:
|
||||
if shutil.which(path_str):
|
||||
return
|
||||
print(
|
||||
f"{WARN}[ERROR] {name} not found in system PATH.\n"
|
||||
f" Configured path: '{path_str}'\n"
|
||||
f"Please install or correct the path in yt-playlist-config.json ."
|
||||
)
|
||||
sys.exit(1)
|
||||
else:
|
||||
path = Path(path_str)
|
||||
if not path.is_absolute():
|
||||
script_dir = Path(__file__).resolve().parent
|
||||
path = (script_dir / path).resolve()
|
||||
if path.is_file() or shutil.which(str(path)):
|
||||
return
|
||||
print(
|
||||
f"{WARN}[ERROR] {name} not found.\n"
|
||||
f" Configured path: '{path_str}'\n"
|
||||
f" Resolved absolute path: '{path}'\n"
|
||||
f"Please correct the yt-playlist-config.json path."
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
@property
|
||||
def playlists(self):
|
||||
return self.data.get("playlists", [])
|
||||
|
||||
@property
|
||||
def yt_dlp_path(self):
|
||||
return self.data["yt_dlp_path"]
|
||||
|
||||
@property
|
||||
def ffmpeg_path(self):
|
||||
return self.data["ffmpeg_path"]
|
||||
|
||||
@property
|
||||
def aria2c_path(self):
|
||||
return self.data["aria2c_path"]
|
||||
|
||||
@property
|
||||
def download_mode(self):
|
||||
return self.data.get("download_mode", "audio")
|
||||
|
||||
@property
|
||||
def max_video_quality(self):
|
||||
return self.data.get("max_video_quality", "1080p")
|
||||
|
||||
@property
|
||||
def max_parallel_downloads(self):
|
||||
return self.data.get("max_parallel_downloads", 10)
|
||||
|
||||
@property
|
||||
def aria2c_connections(self):
|
||||
return self.data.get("aria2c_connections", 8)
|
||||
|
||||
|
||||
class PlaylistDownloader:
|
||||
illegal_chars = '<>:"/\\|?*'
|
||||
|
||||
def __init__(self, config: ConfigLoader, playlist: dict, index: int):
|
||||
|
||||
# Determine a friendly identifier for the playlist
|
||||
# playlist_id = playlist.get("url") or playlist.get("save_path") or f"playlist #{index+1}"
|
||||
|
||||
# Check for missing or empty URL and distinguish videos vs playlists
|
||||
self.url = playlist.get("url")
|
||||
self.skip = False
|
||||
if not self.url:
|
||||
print(f"{FAIL} Playlist #{index+1} has invalid or empty URL: '{self.url}' skipping")
|
||||
self.skip = True
|
||||
else:
|
||||
parsed = urlparse(self.url)
|
||||
qs = parse_qs(parsed.query)
|
||||
# If query contains 'list' it's a playlist URL
|
||||
if "list" in qs and qs.get("list"):
|
||||
self.skip = False
|
||||
else:
|
||||
# If URL contains a video id (v param) or is a youtu.be short link, treat as video and skip
|
||||
if "v" in qs or parsed.netloc.endswith("youtu.be") or parsed.path.startswith("/watch"):
|
||||
print(f"{WARN} URL for playlist #{index+1} looks like a video URL, not a playlist: '{self.url}' — skipping")
|
||||
self.skip = True
|
||||
else:
|
||||
# Not clearly a playlist or video — warn and attempt, but typically will fail
|
||||
print(f"{WARN} URL for playlist #{index+1} does not contain a playlist id: '{self.url}'. Attempting to fetch, but it may fail.")
|
||||
self.skip = False
|
||||
|
||||
# Continue with normal initialization
|
||||
self.download_mode = playlist.get("download_mode", config.download_mode)
|
||||
self.max_video_quality = playlist.get("max_video_quality", config.max_video_quality)
|
||||
|
||||
self.save_path = Path(playlist.get("save_path", "./music"))
|
||||
self.save_path.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Archive path
|
||||
self.archive = Path(playlist.get("archive", "archive.txt"))
|
||||
if not self.archive.is_absolute():
|
||||
self.archive = self.save_path / self.archive
|
||||
self.archive.touch(exist_ok=True)
|
||||
|
||||
self.yt_dlp = config.yt_dlp_path
|
||||
self.ffmpeg = config.ffmpeg_path
|
||||
self.aria2c = config.aria2c_path
|
||||
self.max_parallel = config.max_parallel_downloads
|
||||
self.aria2c_connections = config.aria2c_connections
|
||||
|
||||
|
||||
def sanitize_title(self, title, fallback_id):
|
||||
safe_title = title.translate(str.maketrans({c: '-' for c in self.illegal_chars})).strip()
|
||||
return safe_title if safe_title else fallback_id
|
||||
|
||||
def get_file_path(self, track_index, title):
|
||||
return self.save_path / f"{track_index:03d} - {title}.mp3"
|
||||
|
||||
def fetch_videos(self):
|
||||
if getattr(self, "skip", False) or not self.url:
|
||||
return [] # nothing to fetch
|
||||
|
||||
try:
|
||||
result = subprocess.run(
|
||||
[self.yt_dlp, "-J", "--flat-playlist", self.url],
|
||||
capture_output=True, text=True, check=True
|
||||
)
|
||||
data = json.loads(result.stdout)
|
||||
entries = data.get("entries", [])
|
||||
except subprocess.CalledProcessError as e:
|
||||
stderr = (e.stderr or "").lower()
|
||||
# Heuristics for private/unavailable playlists
|
||||
if any(k in stderr for k in ("private", "sign in", "login required", "403", "Authorization failed")):
|
||||
print(f"{WARN} Playlist appears to be private or requires authentication: '{self.url}'. Skipping.")
|
||||
self.skip = True
|
||||
return []
|
||||
# Unknown error — print and skip
|
||||
print(f"{FAIL} Failed to fetch playlist '{self.url}': {e.stderr.strip() if e.stderr else str(e)}")
|
||||
self.skip = True
|
||||
return []
|
||||
except json.JSONDecodeError:
|
||||
print(f"{FAIL} Failed to parse yt-dlp output for URL: '{self.url}'. Skipping.")
|
||||
self.skip = True
|
||||
return []
|
||||
|
||||
valid = []
|
||||
for v in entries:
|
||||
if not v:
|
||||
continue
|
||||
title = v.get("title", "")
|
||||
if title in ("[Deleted video]", "[Private video]"):
|
||||
print(f"[SKIP] {v['id']} - {title}")
|
||||
continue
|
||||
valid.append(v)
|
||||
return valid
|
||||
|
||||
def get_archive_ids(self):
|
||||
ids = set()
|
||||
with self.archive.open("r", encoding="utf-8") as f:
|
||||
for line in f:
|
||||
parts = line.strip().split()
|
||||
if len(parts) >= 2:
|
||||
ids.add(parts[1])
|
||||
return ids
|
||||
|
||||
def download_video(self, video, track_index):
|
||||
title = video.get("title", "[Unknown]")
|
||||
safe_title = self.sanitize_title(title, video["id"])
|
||||
video_url = f"https://www.youtube.com/watch?v={video['id']}"
|
||||
|
||||
def build_video_format(max_quality):
|
||||
mapping = {
|
||||
"720p": "bestvideo[height<=720]+bestaudio/best[height<=720]",
|
||||
"1080p": "bestvideo[height<=1080]+bestaudio/best[height<=1080]",
|
||||
"1440p": "bestvideo[height<=1440]+bestaudio/best[height<=1440]",
|
||||
"2160p": "bestvideo[height<=2160]+bestaudio/best[height<=2160]",
|
||||
"best": "bestvideo+bestaudio/best"
|
||||
}
|
||||
return mapping.get(max_quality.lower(), mapping["1080p"])
|
||||
|
||||
cmds = []
|
||||
|
||||
if self.download_mode == "audio":
|
||||
output_path = self.save_path / "audio" / f"{track_index:03d} - {safe_title}.mp3"
|
||||
output_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
args = [
|
||||
str(self.yt_dlp),
|
||||
"-f", "bestaudio",
|
||||
"--extract-audio",
|
||||
"--audio-format", "mp3",
|
||||
"--audio-quality", "0",
|
||||
]
|
||||
# Only pass --ffmpeg-location if ffmpeg is NOT available on PATH
|
||||
if not shutil.which(str(self.ffmpeg)):
|
||||
args += ["--ffmpeg-location", str(self.ffmpeg)]
|
||||
args += [
|
||||
"--download-archive", str(self.archive),
|
||||
"-o", str(output_path),
|
||||
"--external-downloader", str(self.aria2c),
|
||||
"--external-downloader-args",
|
||||
f"aria2c:-x {self.aria2c_connections} -s {self.aria2c_connections}",
|
||||
video_url
|
||||
]
|
||||
cmds.append((args, f"{track_index:03d} - {title} (audio)"))
|
||||
|
||||
elif self.download_mode == "video":
|
||||
output_path = self.save_path / "video" / f"{track_index:03d} - {safe_title}.mp4"
|
||||
output_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
fmt = build_video_format(self.max_video_quality)
|
||||
args = [
|
||||
str(self.yt_dlp),
|
||||
"-f", fmt,
|
||||
"--merge-output-format", "mp4",
|
||||
]
|
||||
if not shutil.which(str(self.ffmpeg)):
|
||||
args += ["--ffmpeg-location", str(self.ffmpeg)]
|
||||
args += [
|
||||
"--download-archive", str(self.archive),
|
||||
"-o", str(output_path),
|
||||
"--external-downloader", str(self.aria2c),
|
||||
"--external-downloader-args",
|
||||
f"aria2c:-x {self.aria2c_connections} -s {self.aria2c_connections}",
|
||||
video_url
|
||||
]
|
||||
cmds.append((args, f"{track_index:03d} - {title} (video)"))
|
||||
|
||||
elif self.download_mode == "both":
|
||||
# Download video first into video folder
|
||||
video_folder = self.save_path / "video"
|
||||
video_folder.mkdir(parents=True, exist_ok=True)
|
||||
video_output = video_folder / f"{track_index:03d} - {safe_title}.mp4"
|
||||
fmt = build_video_format(self.max_video_quality)
|
||||
video_args = [
|
||||
str(self.yt_dlp),
|
||||
"-f", fmt,
|
||||
"--merge-output-format", "mp4",
|
||||
"--download-archive", str(self.archive),
|
||||
"-o", str(video_output),
|
||||
"--external-downloader", str(self.aria2c),
|
||||
"--external-downloader-args", f"aria2c:-x {self.aria2c_connections} -s {self.aria2c_connections}",
|
||||
video_url,
|
||||
]
|
||||
if not shutil.which(str(self.ffmpeg)):
|
||||
# allow yt-dlp to find ffmpeg via --ffmpeg-location if configured as a path
|
||||
video_args.insert(0, str(self.yt_dlp))
|
||||
# if ffmpeg is an explicit path, yt-dlp will use it; we keep behavior consistent
|
||||
|
||||
try:
|
||||
subprocess.run(video_args, check=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
err = (e.stderr or "").strip()
|
||||
print(f"{FAIL} Video download failed: {title} — {err}")
|
||||
return False
|
||||
|
||||
# extract audio with ffmpeg into audio folder
|
||||
audio_folder = self.save_path / "audio"
|
||||
audio_folder.mkdir(parents=True, exist_ok=True)
|
||||
audio_output = audio_folder / f"{track_index:03d} - {safe_title}.mp3"
|
||||
# prefer configured ffmpeg path, fallback to system ffmpeg
|
||||
ffmpeg_exe = str(self.ffmpeg)
|
||||
if not (shutil.which(ffmpeg_exe) or Path(ffmpeg_exe).is_file()):
|
||||
ffmpeg_exe = shutil.which("ffmpeg") or ffmpeg_exe
|
||||
|
||||
if ffmpeg_exe:
|
||||
ffmpeg_cmd = [ffmpeg_exe, "-y", "-i", str(video_output), "-vn", "-codec:a", "libmp3lame", "-q:a", "0", str(audio_output)]
|
||||
try:
|
||||
subprocess.run(ffmpeg_cmd, check=True, capture_output=True, text=True)
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"{WARN} ffmpeg failed to extract audio for {title}: {(e.stderr or '').strip()}")
|
||||
else:
|
||||
print(f"{WARN} ffmpeg not found; audio not extracted for {title}.")
|
||||
|
||||
print(f"{OK} Downloaded video and extracted audio for: {track_index:03d} - {title}")
|
||||
return True
|
||||
|
||||
else:
|
||||
print(f"{FAIL} Invalid download_mode '{self.download_mode}', skipping")
|
||||
return False
|
||||
|
||||
# --- execute one or both downloads ---
|
||||
success = True
|
||||
for args, label in cmds:
|
||||
try:
|
||||
subprocess.run(args, check=True)
|
||||
print(f"{OK} Downloaded: {label}")
|
||||
except subprocess.CalledProcessError as e:
|
||||
err_msg = e.stderr.strip().splitlines()[-1] if e.stderr else "Unknown error"
|
||||
print(f"{FAIL} Download failed: {label} — {err_msg}")
|
||||
success = False
|
||||
|
||||
return success
|
||||
|
||||
|
||||
def renumber_all_tracks(self, playlist_entries):
|
||||
print(f"\n{STEP} Renumbering files according to playlist order")
|
||||
temp_suffix = ".renametemp"
|
||||
|
||||
# --- Build mapping of safe_title → correct filename ---
|
||||
final_map_audio = {}
|
||||
final_map_video = {}
|
||||
|
||||
for idx, video in enumerate(playlist_entries, start=1):
|
||||
title = video.get("title", "[Unknown]")
|
||||
safe_title = self.sanitize_title(title, video["id"])
|
||||
|
||||
if self.download_mode in ("audio", "both"):
|
||||
final_map_audio[safe_title] = f"{idx:03d} - {safe_title}.mp3"
|
||||
if self.download_mode in ("video", "both"):
|
||||
final_map_video[safe_title] = f"{idx:03d} - {safe_title}.mp4"
|
||||
|
||||
# --- Helper function to rename files in folder ---
|
||||
def rename_files(folder, mapping, ext):
|
||||
folder.mkdir(parents=True, exist_ok=True)
|
||||
for safe_title, correct_fname in mapping.items():
|
||||
matches = list(folder.glob(f"*{ext}"))
|
||||
# Find matching file
|
||||
for m in matches:
|
||||
if safe_title in m.name:
|
||||
if m.name != correct_fname:
|
||||
temp_path = m.with_suffix(m.suffix + temp_suffix)
|
||||
m.rename(temp_path)
|
||||
|
||||
for safe_title, correct_fname in mapping.items():
|
||||
temp_match = list(folder.glob(f"*{ext}{temp_suffix}"))
|
||||
for temp_path in temp_match:
|
||||
final_path = folder / correct_fname
|
||||
print(f"Renaming '{temp_path.name}' → '{final_path.name}'")
|
||||
temp_path.rename(final_path)
|
||||
|
||||
if self.download_mode in ("audio", "both"):
|
||||
rename_files(self.save_path / "audio", final_map_audio, ".mp3")
|
||||
if self.download_mode in ("video", "both"):
|
||||
rename_files(self.save_path / "video", final_map_video, ".mp4")
|
||||
|
||||
print(f"{OK} Renumbering complete.")
|
||||
|
||||
|
||||
def update(self):
|
||||
playlist_id = self.url or self.save_path or "unknown playlist"
|
||||
if getattr(self, "skip", False):
|
||||
print(f"{WARN} Skipping playlist '{playlist_id}': URL missing in the config.")
|
||||
return
|
||||
|
||||
print(f"{STEP} Updating playlist: {playlist_id}")
|
||||
playlist_entries = self.fetch_videos()
|
||||
archive_ids = self.get_archive_ids()
|
||||
new_videos = [v for v in playlist_entries if v["id"] not in archive_ids]
|
||||
|
||||
if not new_videos:
|
||||
print(f"{OK} No new items found.")
|
||||
else:
|
||||
print(f"{OK} Found {len(new_videos)} new item(s) to download.")
|
||||
|
||||
idx_map = {v["id"]: i+1 for i, v in enumerate(playlist_entries)}
|
||||
|
||||
with ThreadPoolExecutor(max_workers=self.max_parallel) as executor:
|
||||
futures = [executor.submit(self.download_video, v, idx_map[v["id"]]) for v in new_videos]
|
||||
for f in as_completed(futures):
|
||||
try:
|
||||
f.result()
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"{FAIL} Download failed: {e}")
|
||||
|
||||
self.renumber_all_tracks(playlist_entries)
|
||||
self.cleanup_removed_tracks(playlist_entries)
|
||||
|
||||
def cleanup_removed_tracks(self, playlist_entries):
|
||||
print(f"{STEP} Checking for files not in the playlist")
|
||||
valid_titles = set()
|
||||
for video in playlist_entries:
|
||||
title = video.get("title", "[Unknown]")
|
||||
safe_title = self.sanitize_title(title, video["id"])
|
||||
valid_titles.add(safe_title)
|
||||
|
||||
def clean_folder(folder, ext):
|
||||
to_delete = []
|
||||
folder.mkdir(parents=True, exist_ok=True)
|
||||
for file in folder.glob(f"*{ext}"):
|
||||
parts = file.name.split(" - ", 1)
|
||||
if len(parts) == 2:
|
||||
safe_title_in_file = parts[1][:-len(ext)]
|
||||
if safe_title_in_file not in valid_titles:
|
||||
to_delete.append(file)
|
||||
|
||||
if not to_delete:
|
||||
return
|
||||
|
||||
print(f"{WARN} The following files in '{folder}' are not in the playlist and will be deleted:")
|
||||
for f in to_delete:
|
||||
print(f" {f.name}")
|
||||
|
||||
try:
|
||||
confirm = input(f"{WARN} Delete these files? [y/N]: ").strip().lower()
|
||||
except EOFError:
|
||||
confirm = "n"
|
||||
|
||||
if confirm == "y":
|
||||
for f in to_delete:
|
||||
try:
|
||||
f.unlink()
|
||||
print(f"{OK} Deleted: {f.name}")
|
||||
except Exception as ex:
|
||||
print(f"{FAIL} Failed to delete {f.name}: {ex}")
|
||||
print(f"{OK} Cleanup complete in '{folder}'.")
|
||||
else:
|
||||
print(f"{OK} Cleanup aborted in '{folder}'. No files were deleted.")
|
||||
|
||||
if self.download_mode in ("audio", "both"):
|
||||
clean_folder(self.save_path / "audio", ".mp3")
|
||||
if self.download_mode in ("video", "both"):
|
||||
clean_folder(self.save_path / "video", ".mp4")
|
||||
|
||||
|
||||
|
||||
class PlaylistManager:
|
||||
def __init__(self, config: ConfigLoader):
|
||||
self.config = config
|
||||
self.playlists = [
|
||||
PlaylistDownloader(config, pl, idx)
|
||||
for idx, pl in enumerate(config.playlists)
|
||||
]
|
||||
|
||||
def run(self):
|
||||
total_connections = self.config.max_parallel_downloads * self.config.aria2c_connections
|
||||
if total_connections > 100:
|
||||
print("\033[91m"
|
||||
f"{WARN}[WARNING] Total connections ({self.config.max_parallel_downloads} × "
|
||||
f"{self.config.aria2c_connections} = {total_connections}) may overload your network! Pausing 5 seconds..."
|
||||
"\033[0m")
|
||||
time.sleep(5)
|
||||
|
||||
for playlist in self.playlists:
|
||||
playlist.update()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
cfg = ConfigLoader("yt-playlist-config.json")
|
||||
if not is_docker(): update_yt_dlp(cfg.yt_dlp_path) #update yt-dpl executable
|
||||
manager = PlaylistManager(cfg)
|
||||
manager.run()
|
||||
Reference in New Issue
Block a user