From c66261705ec23458908de0bc47d017db7c3c8935 Mon Sep 17 00:00:00 2001 From: Muhamed <110548351+oop7@users.noreply.github.com> Date: Thu, 26 Dec 2024 10:40:39 +0200 Subject: [PATCH] Update README.md --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 57 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b14511a..6266a31 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,25 @@ A modern YouTube downloader with a clean PyQt6 interface. Download videos in any ## Screenshots ### Main Interface -![Main Interface](https://github.com/user-attachments/assets/0dc04ecf-082e-458a-acfe-2c5482d36de2) + +![Screenshot1](https://github.com/user-attachments/assets/414ceb6b-957f-4dd6-bfa7-6a5d72818522) *Main interface with video metadata and thumbnail preview* +### Playlist download support with auto-detection + +![Screenshot2](https://github.com/user-attachments/assets/d889b659-6196-4e53-a4ea-ff81b698e7f3) + +*Playlist download with auto-detection* ### Audio Format Selection -![Format Selection](https://github.com/user-attachments/assets/d2f8a638-0b6b-49f1-990d-c9c4791902a6) +![Screenshot](https://github.com/user-attachments/assets/b40641a2-659e-4a9f-9002-57badc37916d) *Smart format selection with quality options* ### Subtitle Options -![Subtitle Options](https://github.com/user-attachments/assets/b001ceb5-5446-4b56-b00c-b578814e2cf0) +![Screenshot3](https://github.com/user-attachments/assets/0f356c89-9c8b-4050-ad74-fd006ebed22e) *Support for both manual and auto-generated subtitles* @@ -30,6 +36,15 @@ A modern YouTube downloader with a clean PyQt6 interface. Download videos in any - 🖼️ Thumbnail preview - 🎨 Clean, user-friendly interface - 🚀 Built on yt-dlp for robust downloading +- ⏯️ Download control (pause, resume, and cancel) +- 📊 Real-time progress tracking (speed, ETA, percentage) +- 📝 Built-in yt-dlp log viewer +- ⚙️ Custom yt-dlp command support +- 📋 Playlist download support with auto-detection +- 💾 Save download path memory +- 🔄 Automatic updates checker +- ⚠️ User-friendly error messages +- 🛠️ FFmpeg installation checker and guide ## Download @@ -37,15 +52,22 @@ You can download the latest executable from the [Releases](https://github.com/oo ### Pre-built Executables - Windows: `YTSage.exe` +- macOS: `YTSage.app` +- Linux: `YTSage.AppImage` - No installation required - just download and run! -## Build from Source +### PyPI Package +You can also install YTSage directly from PyPI: +```bash +pip install YTSage +``` + ### Installation 1. Clone the repository: ```bash -git clone https://github.com/yourusername/YTSage.git +git clone https://github.com/oop7/YTSage.git cd YTSage ``` @@ -60,25 +82,33 @@ python YTSage.py # Usage -1. Run the application -2. Paste a YouTube URL into the input field -3. Click "Analyze" to load video information -4. Select your desired format: - - Choose "Video" for video downloads (will automatically merge with best audio) - - Choose "Audio Only" for audio extraction -5. Enable subtitle download if needed -6. Select the output directory -7. Click "Download" to start +1. **Run the application** +2. **Paste a YouTube URL** into the input field +3. **Click "Analyze"** to load video information +4. **Select your desired format**: + - Choose **"Video"** for video downloads (will automatically merge with best audio) + - Choose **"Audio Only"** for audio extraction +5. **Enable subtitle download** if needed +6. **Select the output directory** +7. **Click "Download"** to start -### Build Executable +--- -#### Install PyInstaller if you haven't already +### Additional Steps for Playlist Download: -- Create the executable +1. **Paste the Playlist URL**: Instead of a single video URL, paste the URL of the entire YouTube playlist into the input field. +2. **Analyze the Playlist**: Click "Analyze" to load information for all videos in the playlist. +3. **Select Best Quality**: Ensure that the best quality option is selected for both video and audio. +4. **Download the Playlist**: Click "Download" to start downloading all videos in the playlist. The application should automatically handle the download queue. -```bash -pyinstaller --onefile --windowed --icon=icon.ico --name=YTSage YTSage.py -``` +--- + +### Note: +- **Best Quality**: Always select the highest available resolution (e.g., 1080p, 4K) for video and the best audio format (e.g., 320kbps) for the best experience. +- **Subtitle Download**: If you need subtitles, enable this option before starting the download. +- **Output Directory**: Choose a directory with enough storage space, especially for large playlists. + +By following these steps, you can efficiently download entire playlists in the best quality without encountering issues. ## Requirements @@ -87,6 +117,8 @@ pyinstaller --onefile --windowed --icon=icon.ico --name=YTSage YTSage.py - yt-dlp - Pillow - requests +- ffmpeg +- packaging ## Contributing @@ -106,6 +138,11 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file - [yt-dlp](https://github.com/yt-dlp/yt-dlp) for the powerful downloading engine - [PyQt6](https://www.riverbankcomputing.com/software/pyqt/) for the GUI framework +- [FFmpeg](https://ffmpeg.org/) for the audio and video processing +- [Pillow](https://pypi.org/project/Pillow/) for the image processing +- [requests](https://pypi.org/project/requests/) for the HTTP requests +- [packaging](https://pypi.org/project/packaging/) for the package management +- [PyInstaller](https://pypi.org/project/PyInstaller/) for the executable creation ## Disclaimer