Merge pull request #5 from MPZ-00/feature-cli-and-abort

CLI and Abort Improvements (v1.8.0)

Author: MPZ-00

CHANGELOG.md

@@ -4,6 +4,30 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [v1.8.0] - CLI and Abort Improvements
+**Release Date**: 2025-11-19
+
+### Added
+- Custom filename generation system with `--name` flag
+- Episode tagging support with `--numbering` flag (extracts S##E## from URLs or generates sequential numbering)
+- Dry-run mode with `--dry-run` flag to test downloads without actually downloading
+- Graceful abort handling with Ctrl+C (SIGINT signal handler)
+- Interactive cleanup prompt on abort: choose to keep or delete `.part` files
+- Progress hooks in yt-dlp downloads to respect abort signals
+- Thread-safe argument passing for parallel downloads
+
+### Changed
+- Improved multi-threaded download coordination with global stop event
+- Enhanced executor shutdown to properly cancel pending futures on abort
+- Mutually exclusive `-u` and `-l` arguments for better CLI validation
+- Better responsiveness to abort signals during active downloads
+
+### Fixed
+- Ctrl+C now properly stops all download threads immediately
+- Fixed `PermissionError` when cleaning up `.part` files during active downloads
+- Fixed `CancelledError` tracebacks by catching them silently
+- Thread-safe operations by using `copy.deepcopy()` for argument objects
+
 ## [v1.7.4] - Dependency Cleanup
 **Release Date**: 2025-06-15
 

README.md

@@ -87,12 +87,49 @@ Run:
 voe-dl -l links.txt
 ```
 
-### Optional: Parallel Downloads
-You can add the `-w` option to set number of parallel workers:
+### Setting Title in List File
+You can specify a custom title for all files by adding a special comment at the start of your list file:
+```
+#: My Series Title
+https://voe.sx/xxxxxxx
+https://voe.sx/yyyyyyy
+```
+This title will be used when combined with `--numbering` instead of the `--name` argument.
+
+### Custom File Naming
+Set a custom name for downloaded files:
+```bash
+voe-dl -u https://voe.sx/yourvideo --name "MyVideo"
+```
+
+With episode numbering (extracts S##E## from URL or numbers sequentially):
+```bash
+voe-dl -l links.txt --name "ShowName" --numbering
+```
+This creates files like: `ShowName_S01E01.mp4`, `ShowName_S01E02.mp4`, etc.
+
+If you use `--numbering` without `--name`, it defaults to "Episode":
+```bash
+voe-dl -l links.txt --numbering
+```
+Creates: `Episode_S01E01.mp4`, `Episode_S01E02.mp4`, etc.
+
+### Parallel Downloads
+Set the number of parallel workers (default is 4):
 ```bash
 voe-dl -l links.txt -w 8
 ```
-(Default is 4)
+
+### Dry Run Mode
+Test the download process without actually downloading:
+```bash
+voe-dl -l links.txt --dry-run
+```
+
+### Aborting Downloads
+Press `Ctrl+C` to gracefully abort downloads. You'll be prompted to either:
+- **Keep** `.part` files to resume later
+- **Delete** `.part` files to start fresh next time
 
 ---
 
@@ -128,7 +165,17 @@ Run:
 ```bash
 voe-dl -h
 ```
-This will print all available options, arguments, and descriptions.
+This will print all available options:
+
+```
+-h, --help              Show help message and exit
+-u, --url               Download single video from URL
+-l, --list              Download videos from a text file (one URL per line)
+-w, --workers           Number of parallel download threads (default: 4)
+--name                  Custom filename for downloaded videos
+--numbering             Enable episode numbering (S##E## format)
+--dry-run               Test download process without actually downloading
+```
 
 ---