mirror of
https://github.com/darkzoul5/YoutubePlaylistSync.git
synced 2026-07-04 04:53:58 +03:00
Update README for accuracy in usage instructions. fix typos
This commit is contained in:
@@ -3,12 +3,10 @@
|
|||||||
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/build_v2.yml)
|
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/build_v2.yml)
|
||||||
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/unit-tests.yml)
|
[](https://github.com/darkzoul5/YoutubePlaylistDownloader/actions/workflows/unit-tests.yml)
|
||||||
|
|
||||||
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 Gitea CI/CD workflow for packaging and releasing Windows and Linux binaries.
|
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 [aria2](https://github.com/aria2/aria2). Includes Gitea CI/CD workflow for packaging and releasing Windows and Linux binaries.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Download full YouTube playlists** as high-quality MP3 (audio), MP4 (video), or both.
|
- **Download full YouTube playlists** as high-quality MP3 (audio), MP4 (video), or both.
|
||||||
@@ -21,14 +19,10 @@ Supports audio, video, or both download modes, music and videos are numbered as
|
|||||||
- **Cross-platform:** Windows and Linux support.
|
- **Cross-platform:** Windows and Linux support.
|
||||||
- **GitHub Actions CI/CD workflow** for automated packaging and release.
|
- **GitHub Actions CI/CD workflow** for automated packaging and release.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Python 3.8+
|
- Python 3.8+
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Quick Start
|
### Quick Start
|
||||||
@@ -46,12 +40,12 @@ Supports audio, video, or both download modes, music and videos are numbered as
|
|||||||
|
|
||||||
- Open `yt-playlist-config.json` and adjust paths, playlist URLs, download mode, and quality as needed.
|
- Open `yt-playlist-config.json` and adjust paths, playlist URLs, download mode, and quality as needed.
|
||||||
|
|
||||||
1. **Run the downloader:**
|
1. **Run ytpld:**
|
||||||
|
|
||||||
- On Windows:
|
- On Windows:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python yt-playlist-main.py
|
yt-playlist-main.exe
|
||||||
```
|
```
|
||||||
|
|
||||||
- On Linux:
|
- On Linux:
|
||||||
@@ -60,8 +54,6 @@ Supports audio, video, or both download modes, music and videos are numbered as
|
|||||||
python3 yt-playlist-main.py
|
python3 yt-playlist-main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
@@ -98,9 +90,8 @@ Edit `yt-playlist-config.json` to specify playlists, paths, and options:
|
|||||||
|
|
||||||
### Running
|
### Running
|
||||||
|
|
||||||
- Just run the script with Python:
|
- On Windows: `yt-playlist-main.exe`
|
||||||
- On Windows: `python yt-playlist-main.py`
|
- On Linux: `python3 yt-playlist-main.py`
|
||||||
- On Linux: `python3 yt-playlist-main.py`
|
|
||||||
|
|
||||||
- The downloader will:
|
- The downloader will:
|
||||||
- Check for required tools and update yt-dlp automatically
|
- Check for required tools and update yt-dlp automatically
|
||||||
@@ -110,18 +101,16 @@ Edit `yt-playlist-config.json` to specify playlists, paths, and options:
|
|||||||
- Avoid re-downloading files you've already downloaded
|
- Avoid re-downloading files you've already downloaded
|
||||||
- Offer to clean up files that are no longer in the playlist
|
- Offer to clean up files that are no longer in the playlist
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## CLI flags
|
## CLI flags
|
||||||
|
|
||||||
When running the script locally (for example `python yt-playlist-main.py`), you can pass the following flags:
|
When running the script via python (for example `python yt-playlist-main.py`), you can pass the following flags:
|
||||||
|
|
||||||
- `-c, --config <path>` — Path to a configuration file (relative to the repository `config/` directory by default)
|
- `-c, --config <path>` — Path to a configuration file (relative to the repository `config/` directory by default)
|
||||||
- `-d, --debug` — Show verbose subprocess output (yt-dlp, ffmpeg, aria2c)
|
- `-d, --debug` — Show verbose subprocess output (yt-dlp, ffmpeg, aria2c)
|
||||||
- `-p, --prune` — Run with pruning (deleting files not present in playlists)
|
- `-p, --prune` — Run with pruning (deleting files not present in playlists)
|
||||||
- `-y, --yes, --non-interactive` — Auto-confirm prompts (used only with `--prune`at the moment)
|
- `-y, --yes, --non-interactive` — Auto-confirm prompts (used only with `--prune`at the moment)
|
||||||
|
|
||||||
Examples (local):
|
Examples:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
# Run with debug output
|
# Run with debug output
|
||||||
@@ -134,8 +123,6 @@ python yt-playlist-main.py --prune --yes
|
|||||||
python yt-playlist-main.py --config custom-config.json
|
python yt-playlist-main.py --config custom-config.json
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Docker Usage
|
## Docker Usage
|
||||||
|
|
||||||
You can run YouTube Playlist Downloader using the official Docker image.
|
You can run YouTube Playlist Downloader using the official Docker image.
|
||||||
@@ -160,7 +147,7 @@ Create a `docker-compose.yml` with the following content (replace the host paths
|
|||||||
```yaml
|
```yaml
|
||||||
services:
|
services:
|
||||||
yt-downloader:
|
yt-downloader:
|
||||||
image: ghcr.io/dark_zoul/ytpld:latest
|
image: ghcr.io/dark_zoul5/ytpld:latest
|
||||||
container_name: yt-downloader
|
container_name: yt-downloader
|
||||||
restart: no
|
restart: no
|
||||||
volumes:
|
volumes:
|
||||||
@@ -215,4 +202,4 @@ See [LICENSE](LICENSE).
|
|||||||
|
|
||||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
|
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
|
||||||
- [ffmpeg](https://ffmpeg.org/)
|
- [ffmpeg](https://ffmpeg.org/)
|
||||||
- [aria2c](https://github.com/aria2/aria2)
|
- [aria2](https://github.com/aria2/aria2)
|
||||||
|
|||||||
Reference in New Issue
Block a user