mkv-episode-matcher 0.4.5__tar.gz → 0.6.0__tar.gz

mkv_episode_matcher-0.6.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.0] - 2025-02-24
+
+### Added
+- Comprehensive documentation including installation, configuration, and CLI guides
+- Quick start guide with common usage examples
+- Tips and tricks documentation with best practices
+- Detailed changelog structure
+
+### Changed
+- Improved project metadata and description
+- Updated version number in setup.cfg
+
+### Removed
+- Removed OCR support and Tesseract dependency
+- Removed unused code
+
+## [0.5.0] - 2025-02-23
+
+### Changed
+- Try to use tiny version of OpenAI Whisper for initial matching
+- Fall back to base model if tiny model fails
+- Progressive matching in 30s intervals (was 300s)
+
+### Removed
+- Removed unused code
+
+[0.6.0]: https://github.com/Jsakkos/mkv-episode-matcher/releases/tag/v0.6.0
+[0.5.0]: https://github.com/Jsakkos/mkv-episode-matcher/releases/tag/v0.5.0

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkv-episode-matcher
-Version: 0.4.5
+Version: 0.6.0
 Summary: The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly.
 Home-page: https://github.com/Jsakkos/mkv-episode-matcher
 Author: Jonathan Sakkos
@@ -21,7 +21,6 @@ Requires-Dist: ffmpeg>=1.4
 Requires-Dist: loguru>=0.7.2
 Requires-Dist: openai-whisper>=20240930
 Requires-Dist: opensubtitlescom>=0.1.5
-Requires-Dist: pytesseract>=0.3.13
 Requires-Dist: rapidfuzz>=3.10.1
 Requires-Dist: requests>=2.32.3
 Requires-Dist: tmdb-client>=0.0.1
@@ -29,14 +28,6 @@ Requires-Dist: torch>=2.5.1
 Requires-Dist: torchaudio>=2.5.1
 Requires-Dist: torchvision>=0.20.1
 Requires-Dist: wave>=0.0.2
-Provides-Extra: cpu
-Requires-Dist: torch>=2.5.1; extra == "cpu"
-Requires-Dist: torchvision>=0.20.1; extra == "cpu"
-Requires-Dist: torchaudio>=2.5.1; extra == "cpu"
-Provides-Extra: cu124
-Requires-Dist: torch>=2.5.1; extra == "cu124"
-Requires-Dist: torchvision>=0.20.1; extra == "cu124"
-Requires-Dist: torchaudio>=2.5.1; extra == "cu124"
 
 # MKV Episode Matcher
 
@@ -48,7 +39,7 @@ Requires-Dist: torchaudio>=2.5.1; extra == "cu124"
 [![GitHub last commit](https://img.shields.io/github/last-commit/Jsakkos/mkv-episode-matcher)](https://github.com/Jsakkos/mkv-episode-matcher/commits/main)
 [![GitHub issues](https://img.shields.io/github/issues/Jsakkos/mkv-episode-matcher)](https://github.com/Jsakkos/mkv-episode-matcher/issues)
 [![Tests](https://github.com/Jsakkos/mkv-episode-matcher/actions/workflows/tests.yml/badge.svg)](https://github.com/Jsakkos/mkv-episode-matcher/actions/workflows/tests.yml)
-[![codecov](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/branch/main/graph/badge.svg)](https://codecov.io/gh/Jsakkos/mkv-episode-matcher)
+[![codecov](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/branch/main/graph/badge.svg)](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/)
 
 Automatically match and rename your MKV TV episodes using The Movie Database (TMDb).
 
@@ -56,7 +47,7 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 
 - 🎯 **Automatic Episode Matching**: Uses TMDb to accurately identify episodes
 - 📝 **Subtitle Extraction**: Extracts subtitles from MKV files
-- 🔍 **OCR Support**: Handles image-based subtitles
+- 🔊 **Speech Recognition**: Uses Whisper for accurate episode identification
 - 🚀 **Multi-threaded**: Fast processing of multiple files
 - ⬇️ **Subtitle Downloads**: Integration with OpenSubtitles
 - ✨ **Bulk Processing**: Handle entire seasons at once
@@ -66,7 +57,6 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 
 - Python 3.9 or higher
 - [FFmpeg](https://ffmpeg.org/download.html) installed and available in system PATH
-- [Tesseract OCR](https://github.com/UB-Mannheim/tesseract/wiki) installed (required for image-based subtitle processing)
 - TMDb API key (optional, for subtitle downloads)
 - OpenSubtitles account (optional, for subtitle downloads)
 
@@ -135,3 +125,7 @@ Distributed under the MIT License. See `LICENSE` for more information.
 ## Documentation
 
 Full documentation is available at [https://jsakkos.github.io/mkv-episode-matcher/](https://jsakkos.github.io/mkv-episode-matcher/)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/README.md

@@ -8,7 +8,7 @@
 [![GitHub last commit](https://img.shields.io/github/last-commit/Jsakkos/mkv-episode-matcher)](https://github.com/Jsakkos/mkv-episode-matcher/commits/main)
 [![GitHub issues](https://img.shields.io/github/issues/Jsakkos/mkv-episode-matcher)](https://github.com/Jsakkos/mkv-episode-matcher/issues)
 [![Tests](https://github.com/Jsakkos/mkv-episode-matcher/actions/workflows/tests.yml/badge.svg)](https://github.com/Jsakkos/mkv-episode-matcher/actions/workflows/tests.yml)
-[![codecov](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/branch/main/graph/badge.svg)](https://codecov.io/gh/Jsakkos/mkv-episode-matcher)
+[![codecov](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/branch/main/graph/badge.svg)](https://codecov.io/gh/Jsakkos/mkv-episode-matcher/)
 
 Automatically match and rename your MKV TV episodes using The Movie Database (TMDb).
 
@@ -16,7 +16,7 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 
 - 🎯 **Automatic Episode Matching**: Uses TMDb to accurately identify episodes
 - 📝 **Subtitle Extraction**: Extracts subtitles from MKV files
-- 🔍 **OCR Support**: Handles image-based subtitles
+- 🔊 **Speech Recognition**: Uses Whisper for accurate episode identification
 - 🚀 **Multi-threaded**: Fast processing of multiple files
 - ⬇️ **Subtitle Downloads**: Integration with OpenSubtitles
 - ✨ **Bulk Processing**: Handle entire seasons at once
@@ -26,7 +26,6 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 
 - Python 3.9 or higher
 - [FFmpeg](https://ffmpeg.org/download.html) installed and available in system PATH
-- [Tesseract OCR](https://github.com/UB-Mannheim/tesseract/wiki) installed (required for image-based subtitle processing)
 - TMDb API key (optional, for subtitle downloads)
 - OpenSubtitles account (optional, for subtitle downloads)
 
@@ -95,3 +94,7 @@ Distributed under the MIT License. See `LICENSE` for more information.
 ## Documentation
 
 Full documentation is available at [https://jsakkos.github.io/mkv-episode-matcher/](https://jsakkos.github.io/mkv-episode-matcher/)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.

mkv_episode_matcher-0.6.0/docs/changelog.md

@@ -0,0 +1,36 @@
+# Changelog
+
+For a complete list of changes, see [CHANGELOG.md](../CHANGELOG.md) in the repository root.
+
+## Latest Changes
+
+## [0.6.0] - 2025-02-24
+
+### Added
+- Comprehensive documentation including installation, configuration, and CLI guides
+- Quick start guide with common usage examples
+- Tips and tricks documentation with best practices
+- Detailed changelog structure
+
+### Changed
+- Improved project metadata and description
+- Updated version number in setup.cfg
+
+### Removed
+- Removed OCR support and Tesseract dependency
+- Removed unused code
+
+## [0.5.0] - 2025-02-23
+
+### Changed
+- Try to use tiny version of OpenAI Whisper for initial matching
+- Fall back to base model if tiny model fails
+- Progressive matching in 30s intervals (was 300s)
+
+### Removed
+- Removed unused code
+
+[0.6.0]: https://github.com/Jsakkos/mkv-episode-matcher/releases/tag/v0.6.0
+[0.5.0]: https://github.com/Jsakkos/mkv-episode-matcher/releases/tag/v0.5.0
+
+For older versions and complete changelog history, please visit our [GitHub releases page](https://github.com/Jsakkos/mkv-episode-matcher/releases).

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/docs/cli.md

@@ -16,14 +16,13 @@ mkv-match --show-dir "/path/to/show" --season 1
 
 ## Command Options
 
-| Option             | Description                 | Default    |
-| ------------------ | --------------------------- | ---------- |
-| `--show-dir`       | Show directory path         | None       |
-| `--season`         | Season number to process    | None (all) |
-| `--dry-run`        | Test without making changes | False      |
-| `--get-subs`       | Download subtitles          | False      |
-| `--tmdb-api-key`   | TMDb API key                | None       |
-| `--tesseract-path` | Path to Tesseract           | None       |
+| Option           | Description                 | Default    |
+| ---------------- | --------------------------- | ---------- |
+| `--show-dir`     | Show directory path         | None       |
+| `--season`       | Season number to process    | None (all) |
+| `--dry-run`      | Test without making changes | False      |
+| `--get-subs`     | Download subtitles          | False      |
+| `--tmdb-api-key` | TMDb API key                | None       |
 
 ## Examples
 

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/docs/configuration.md

@@ -21,7 +21,6 @@ open_subtitles_api_key = your_opensubs_key
 open_subtitles_user_agent = your_user_agent
 open_subtitles_username = your_username
 open_subtitles_password = your_password
-tesseract_path = /path/to/tesseract
 ```
 
 ## Command Line Configuration
@@ -34,8 +33,7 @@ mkv-match \
   --show-dir "/path/to/shows" \
   --season 1 \
   --dry-run true \
-  --get-subs true \
-  --tesseract-path "/path/to/tesseract"
+  --get-subs true
 ```
 
 ## Environment Variables
@@ -94,16 +92,3 @@ Adjust based on your system's capabilities:
 - Default: 4 threads
 - Minimum: 1 thread
 - Maximum: Number of CPU cores
-
-### OCR Configuration
-
-```ini
-[Config]
-tesseract_path = /path/to/tesseract
-```
-
-Required for processing image-based subtitles. Common paths:
-- Windows: `C:\Program Files\Tesseract-OCR\tesseract.exe`
-- Linux/macOS: `/usr/bin/tesseract`
-
-Make sure Tesseract OCR is properly installed before using this feature.

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/docs/installation.md

@@ -10,13 +10,7 @@
    - macOS: `brew install ffmpeg`
    - Verify installation: `ffmpeg -version`
 
-2. **Tesseract OCR**
-   - Windows: Install from [UB-Mannheim](https://github.com/UB-Mannheim/tesseract/wiki)
-   - Linux: `sudo apt install tesseract-ocr` or equivalent
-   - macOS: `brew install tesseract`
-   - Verify installation: `tesseract --version`
-
-Make sure both FFmpeg and Tesseract are added to your system PATH.
+Make sure FFmpeg is added to your system PATH.
 
 ## Basic Installation
 
@@ -43,7 +37,6 @@ pip install -U torch torchvision torchaudio --index-url https://download.pytorch
 mkv-match --check-gpu true
 ```
 
-
 ### Development Installation
 
 For contributing or development:
@@ -80,6 +73,7 @@ uv sync --dev
 
 ### For CPU-Only
 - No special requirements beyond Python 3.9+
+- Note: Speech recognition will be slower on CPU
 
 ## Verification
 

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/docs/tips.md

@@ -21,7 +21,7 @@ TV Shows/
 1. **Thread Configuration**
    ```ini
    [Config]
-   max_threads = 4  # Adjust based on CPU cores
+   max_threads = 4  # Adjust based on CPU/GPU capability
    ```
 
 2. **Batch Processing**
@@ -32,6 +32,12 @@ TV Shows/
    done
    ```
 
+3. **Speech Recognition**
+   - Uses OpenAI Whisper for audio analysis
+   - Tiny model is tried first for speed
+   - Falls back to base model if needed
+   - Works with both DVD and Blu-ray sources
+
 ### Error Handling
 
 1. Always use dry-run first:
@@ -87,6 +93,11 @@ process_show(
    - Use rate limiting in configuration
    - Implement exponential backoff
 
+3. **Speech Recognition**
+   - GPU recommended for faster processing
+   - Processing happens in 30s intervals
+   - More accurate than OCR-based methods
+
 3. **Memory Usage**
    - Reduce max_threads
    - Process seasons separately
@@ -97,8 +108,8 @@ process_show(
 
 1. Remove temporary files:
    ```python
-   from mkv_episode_matcher.utils import cleanup_ocr_files
-   cleanup_ocr_files(show_dir)
+   from mkv_episode_matcher.utils import cleanup_temp_files
+   cleanup_temp_files(show_dir)
    ```
 
 2. Clear cache:

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/mkv_episode_matcher/__init__.py

@@ -1,9 +1,9 @@
 """MKV Episode Matcher package."""
-from importlib.metadata import version, PackageNotFoundError
+
+from importlib.metadata import PackageNotFoundError, version
 
 try:
     __version__ = version("mkv-episode-matcher")
 except PackageNotFoundError:
     # package is not installed
     __version__ = "unknown"
-

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/mkv_episode_matcher/__main__.py

@@ -1,9 +1,9 @@
 # __main__.py
 import argparse
 import os
-import sys
 
 from loguru import logger
+
 from mkv_episode_matcher import __version__
 from mkv_episode_matcher.config import get_config, set_config
 
@@ -34,7 +34,7 @@ if not os.path.exists(log_dir):
 logger.add(
     os.path.join(log_dir, "stdout.log"),
     format="{time} {level} {message}",
-    level="DEBUG",
+    level="INFO",
     rotation="10 MB",
 )
 
@@ -56,7 +56,6 @@ def main():
     --season: The season number to be processed. If not provided, all seasons will be processed.
     --dry-run: A boolean flag indicating whether to perform a dry run (i.e., not rename any files). If not provided, the function will rename files.
     --get-subs: A boolean flag indicating whether to download subtitles for the show. If not provided, the function will not download subtitles.
-    --tesseract-path: The path to the tesseract executable. If not provided, the function will try to get it from the cache or prompt the user to input it.
 
     The function logs its progress to two separate log files: one for standard output and one for errors.
     """
@@ -67,7 +66,7 @@ def main():
         "--version",
         action="version",
         version=f"%(prog)s {__version__}",
-        help="Show the version number and exit"
+        help="Show the version number and exit",
     )
     parser.add_argument("--tmdb-api-key", help="TMDb API key")
     parser.add_argument("--show-dir", help="Main directory of the show")
@@ -92,13 +91,6 @@ def main():
         nargs="?",
         help="Download subtitles for the show (default: None)",
     )
-    parser.add_argument(
-        "--tesseract-path",
-        type=str,
-        default=None,
-        nargs="?",
-        help="Path to the tesseract executable (default: None)",
-    )
     parser.add_argument(
         "--check-gpu",
         type=bool,
@@ -108,7 +100,8 @@ def main():
     )
     args = parser.parse_args()
     if args.check_gpu:
-        from mkv_episode_matcher.speech_to_text import check_gpu_support
+        from mkv_episode_matcher.utils import check_gpu_support
+
         check_gpu_support()
         return
     logger.debug(f"Command-line arguments: {args}")
@@ -118,17 +111,17 @@ def main():
 
     # Get TMDb API key
     tmdb_api_key = args.tmdb_api_key or config.get("tmdb_api_key")
-    if not tmdb_api_key:
-        tmdb_api_key = input("Enter your TMDb API key: ")
-    logger.debug(f"TMDb API Key: {tmdb_api_key}")
-    
+
     logger.debug("Getting OpenSubtitles API key")
     open_subtitles_api_key = config.get("open_subtitles_api_key")
     open_subtitles_user_agent = config.get("open_subtitles_user_agent")
     open_subtitles_username = config.get("open_subtitles_username")
     open_subtitles_password = config.get("open_subtitles_password")
-    
+
     if args.get_subs:
+        if not tmdb_api_key:
+            tmdb_api_key = input("Enter your TMDb API key: ")
+        logger.debug(f"TMDb API Key: {tmdb_api_key}")
         if not open_subtitles_api_key:
             open_subtitles_api_key = input("Enter your OpenSubtitles API key: ")
         if not open_subtitles_user_agent:
@@ -137,24 +130,17 @@ def main():
             open_subtitles_username = input("Enter your OpenSubtitles Username: ")
         if not open_subtitles_password:
             open_subtitles_password = input("Enter your OpenSubtitles Password: ")
-    
-    # Use config for show directory and tesseract path
+
+    # Use config for show directory
     show_dir = args.show_dir or config.get("show_dir")
     if not show_dir:
         show_dir = input("Enter the main directory of the show:")
     logger.info(f"Show Directory: {show_dir}")
     if not show_dir:
         show_dir = os.getcwd()
-    
-    if not args.tesseract_path:
-        tesseract_path = config.get("tesseract_path")
-        if not tesseract_path:
-            tesseract_path = input(r"Enter the path to the tesseract executable: ['C:\Program Files\Tesseract-OCR\tesseract.exe']")
-    else:
-        tesseract_path = args.tesseract_path
-    logger.debug(f"Teesseract Path: {tesseract_path}")
+
     logger.debug(f"Show Directory: {show_dir}")
-    
+
     # Set the configuration
     set_config(
         tmdb_api_key,
@@ -164,7 +150,6 @@ def main():
         open_subtitles_password,
         show_dir,
         CONFIG_FILE,
-        tesseract_path=tesseract_path,
     )
     logger.info("Configuration set")
 

{mkv_episode_matcher-0.4.5 → mkv_episode_matcher-0.6.0}/mkv_episode_matcher/config.py

@@ -27,7 +27,6 @@ def set_config(
     open_subtitles_password,
     show_dir,
     file,
-    tesseract_path=None,
 ):
     """
     Sets the configuration values and writes them to a file.
@@ -40,7 +39,6 @@ def set_config(
         open_subtitles_password (str): The password for OpenSubtitles.
         show_dir (str): The directory where the TV show episodes are located.
         file (str): The path to the configuration file.
-        tesseract_path (str, optional): The path to the Tesseract OCR executable.
 
     Returns:
         None
@@ -54,7 +52,6 @@ def set_config(
         "open_subtitles_user_agent": str(open_subtitles_user_agent),
         "open_subtitles_username": str(open_subtitles_username),
         "open_subtitles_password": str(open_subtitles_password),
-        "tesseract_path": str(tesseract_path),
     }
     logger.info(
         f"Setting config with API:{tmdb_api_key}, show_dir: {show_dir}, and max_threads: {MAX_THREADS}"