mkv-episode-matcher 0.3.3__py3-none-any.whl → 1.0.0__py3-none-any.whl

mkv_episode_matcher-1.0.0.dist-info/METADATA

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: mkv-episode-matcher
+Version: 1.0.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
+Author-email: Jsakkos <jonathansakkos@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Jonathan Sakkos
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Documentation, https://github.com/Jsakkos/mkv-episode-matcher#readme
+Project-URL: Issues, https://github.com/Jsakkos/mkv-episode-matcher/issues
+Project-URL: Source, https://github.com/Jsakkos/mkv-episode-matcher
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: chardet>=5.2.0
+Requires-Dist: configparser>=7.1.0
+Requires-Dist: ffmpeg>=1.4
+Requires-Dist: librosa>=0.10.2
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: nemo-toolkit[asr]>=2.0.0
+Requires-Dist: opensubtitlescom>=0.1.5
+Requires-Dist: rapidfuzz>=3.10.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich[jupyter]>=13.9.4
+Requires-Dist: soundfile>=0.12.1
+Requires-Dist: tmdb-client>=0.0.1
+Requires-Dist: torch>=2.5.1
+Requires-Dist: torchaudio>=2.5.1
+Requires-Dist: torchvision>=0.20.1
+Requires-Dist: typer>=0.9.0
+Requires-Dist: flet[all]>=0.80.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: ty>=0.0.7
+Provides-Extra: cu128
+Requires-Dist: torch>=2.9.1; sys_platform != "darwin" and extra == "cu128"
+Requires-Dist: torchvision>=0.24.1; sys_platform != "darwin" and extra == "cu128"
+Provides-Extra: nemo
+Requires-Dist: nemo_toolkit[asr]>=2.0.0; extra == "nemo"
+Dynamic: license-file
+
+# MKV Episode Matcher
+
+[![Development Status](https://img.shields.io/pypi/status/mkv-episode-matcher)](https://pypi.org/project/mkv-episode-matcher/)
+[![PyPI version](https://img.shields.io/pypi/v/mkv-episode-matcher.svg)](https://pypi.org/project/mkv-episode-matcher/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Documentation Status](https://img.shields.io/github/actions/workflow/status/Jsakkos/mkv-episode-matcher/documentation.yml?label=docs)](https://jsakkos.github.io/mkv-episode-matcher/)
+[![Downloads](https://static.pepy.tech/badge/mkv-episode-matcher)](https://pepy.tech/project/mkv-episode-matcher)
+[![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/)
+
+Automatically match and rename your MKV TV episodes using advanced speech recognition and subtitle matching.
+
+## ✨ Key Features
+
+- 🖥️ **Modern Desktop GUI**: Cross-platform Flet-based graphical interface with real-time progress tracking
+- 🤖 **Advanced Speech Recognition**: NVIDIA Parakeet ASR for highly accurate episode identification
+- 🎯 **Intelligent Matching**: Multi-segment analysis with confidence scoring and fallback strategies
+- ⬇️ **Smart Subtitle Integration**: Automatic subtitle downloads from OpenSubtitles with local caching
+- ✨ **Bulk Processing**: Handle entire libraries with automatic series/season detection
+- 🧪 **Dry Run Mode**: Preview matches before making any changes
+- 📊 **Rich Progress Tracking**: Real-time progress indicators and detailed match results
+- ⚡ **Performance Optimized**: Caching, background model loading, and efficient processing
+- 🌐 **Cross-Platform**: Available as desktop applications for Windows, macOS, and Linux
+
+## Prerequisites
+
+- Python 3.10-3.12
+- [FFmpeg](https://ffmpeg.org/download.html) installed and available in system PATH
+- TMDb API key (optional, for episode matching)
+- OpenSubtitles.com account (required for subtitle downloads)
+
+## 🚀 Quick Start
+
+### 1. Install MKV Episode Matcher
+
+**Option A: Using uv (Recommended)**
+```bash
+# Install with CUDA support for GPU acceleration
+uv sync --extra cu128
+
+# Or basic installation
+uv sync
+```
+
+**Option B: Using pip**
+```bash
+pip install mkv-episode-matcher
+```
+
+**Option C: Download Standalone Desktop Apps**
+- [Windows Executable](https://github.com/Jsakkos/mkv-episode-matcher/releases/latest/download/MKVEpisodeMatcher-windows.zip)
+- [macOS Application](https://github.com/Jsakkos/mkv-episode-matcher/releases/latest/download/MKVEpisodeMatcher-macos.zip)
+- [Linux AppImage](https://github.com/Jsakkos/mkv-episode-matcher/releases/latest/download/mkv-episode-matcher-linux.AppImage)
+
+### 2. Launch the Application
+
+**🖥️ GUI Mode (Recommended)**
+Launches the modern desktop interface with real-time progress tracking:
+```bash
+uv run mkv-match gui
+```
+
+**💻 CLI Mode**  
+For automation and advanced users:
+```bash
+uv run mkv-match match "/path/to/your/show"
+```
+
+**⚙️ Configuration**
+```bash
+uv run mkv-match config
+```
+
+### 3. Alternative Launch Methods
+```bash
+# GUI
+python -m mkv_episode_matcher gui
+
+# CLI
+python -m mkv_episode_matcher match "/path/to/show"
+```
+## 🖥️ Desktop GUI Features
+
+The modern Flet-based desktop interface provides:
+
+- **🎨 Theme-Adaptive Interface**: Automatically adapts to your system's light/dark theme
+- **📂 Folder Browser**: Easy directory selection with visual folder picker
+- **⏱️ Real-time Progress**: Live progress bars showing "Processing file X of Y"
+- **🔄 Background Model Loading**: Non-blocking ASR model initialization with status indicators  
+- **🧪 Dry Run Preview**: Test matches without making changes, with preview functionality
+- **⚙️ Comprehensive Settings**: Built-in configuration dialog for all options
+- **📊 Detailed Results**: Color-coded success/failure results with confidence scores
+- **🚀 Performance Indicators**: Model loading status and processing statistics
+
+## ⚙️ Configuration
+
+### GUI Configuration
+The desktop app includes a built-in settings dialog accessible via the gear icon. Configure all options including:
+- Cache directory and confidence thresholds
+- ASR and subtitle provider settings  
+- OpenSubtitles API credentials
+- TMDb integration (optional)
+
+### CLI Configuration
+For command-line users:
+```bash
+mkv-match config  # Interactive configuration
+mkv-match --onboard  # First-time setup wizard
+```
+
+**Required API Keys:**
+- **OpenSubtitles API Key**: Required for subtitle downloads ([Get one here](https://www.opensubtitles.com/consumers))
+- **TMDb API Key**: Optional, for enhanced episode metadata ([Get one here](https://www.themoviedb.org/settings/api))
+
+**OpenSubtitles Setup:**
+- Username and password (recommended for better rate limits)
+- API key from the OpenSubtitles developer console
+
+## Directory Structure
+
+MKV Episode Matcher expects your TV shows to be organized as follows:
+
+```
+Show Name/
+├── Season 1/
+│   ├── episode1.mkv
+│   ├── episode2.mkv
+├── Season 2/
+│   ├── episode1.mkv
+│   └── episode2.mkv
+```
+
+## Reference Subtitle File Structure
+
+Subtitle files that are not automatically downloaded using the `--get-subs` flag should be named as follows:
+
+```
+
+~/.mkv-episode-matcher/cache/data/Show Name/
+├── Show Name - S01E01.srt
+├── Show Name - S01E02.srt
+└── ...
+```
+
+On Windows, the cache directory is located at `C:\Users\{username}\.mkv-episode-matcher\cache\data\`
+
+Reference subtitle files should follow this naming pattern:
+`{show_name} - S{season:02d}E{episode:02d}.srt`
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Acknowledgments
+
+- [TMDb](https://www.themoviedb.org/) for their excellent API
+- [OpenSubtitles](https://www.opensubtitles.com/) for subtitle integration
+- All contributors who have helped improve this project
+
+## 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-1.0.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+mkv_episode_matcher/.gitattributes,sha256=Gh2-F2vCM7SZ01pX23UT8pQcmauXWfF3gwyRSb6ZAFs,66
+mkv_episode_matcher/__init__.py,sha256=u3yZcpuK0ICeUjxYKePvW-zS61E5ss5q2AvqnSHuz9E,240
+mkv_episode_matcher/__main__.py,sha256=GB1fwuAaDzpYnr-XWG9pL9O5g_MRDeDVAEDsO8T5IXI,104
+mkv_episode_matcher/asr_models.py,sha256=zydUzO2vPfUbBgbRStr3rECz7oi_0Lw1hRz84ASa3Ns,17067
+mkv_episode_matcher/cli.py,sha256=x5ZOKHy-ut4XWkJe1i6KPgZYq2RfBJRQB-YPHS2Z_-E,17923
+mkv_episode_matcher/episode_identification.py,sha256=dN_uwkLlP4_75bBHNjI7zFmQx8F20LMTdmUnfe8IEzM,21785
+mkv_episode_matcher/subtitle_utils.py,sha256=3n5msR9H6PQj5gQDTHDhX-pN1GffK8zXzlVsGhY26BY,2521
+mkv_episode_matcher/tmdb_client.py,sha256=7DraZs7-pdGJu9LgzJ2H3cct_Eiayhm_2oC9JDZVVZQ,5674
+mkv_episode_matcher/utils.py,sha256=2EfMz9u2sfhAVJBpmImOn_LjI9ixHDNCRujLDcYN8PI,18699
+mkv_episode_matcher/core/config_manager.py,sha256=q9_qwP6guVEgA01NrXCQ-TcmSlOi9arUOXzCoNYU_VQ,3567
+mkv_episode_matcher/core/engine.py,sha256=4y659ElJ1B0yFUJujdX9cYXCf7ZCo80B4V0m61tZWAs,22046
+mkv_episode_matcher/core/matcher.py,sha256=6_4_tex5UAf2df8afCSqIARCxypN2Q_IcdmABONMQns,8217
+mkv_episode_matcher/core/models.py,sha256=gJ0QuIj_On1ilNQ-Nxt8J3muEC2R4owlTCnuJQc5JDs,2233
+mkv_episode_matcher/core/utils.py,sha256=KU90CiF2H49ELV_6VwRQKOTa61ehfOf34siusoafuyk,4536
+mkv_episode_matcher/core/providers/asr.py,sha256=7ATCBRuWYYaPAys69mSam1UK2E4fC532eHoF_KEzeXs,2405
+mkv_episode_matcher/core/providers/subtitles.py,sha256=5IPTRkTvWYBsJkdQqKuKgUb7Tzmv3kl7NVH4Xj-lRKY,12339
+mkv_episode_matcher/ui/flet_app.py,sha256=WgZXHf9UrbIsG8mP6b5D2aiBiE4tMozNapiSofpMvxw,28236
+mkv_episode_matcher-1.0.0.dist-info/licenses/LICENSE,sha256=ScBvQ_sUEpaRMDYp01qmMDELT1nTknFP2w-VRAS54TY,1071
+mkv_episode_matcher-1.0.0.dist-info/METADATA,sha256=ituP5GyTvTrT2xfKrRq6xtXRIMuIko70ZcX4UekSZkM,10005
+mkv_episode_matcher-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mkv_episode_matcher-1.0.0.dist-info/entry_points.txt,sha256=IglJ43SuCZq2eQ3shMFILCkmQASJHnDCI3ogohW2Hn4,64
+mkv_episode_matcher-1.0.0.dist-info/top_level.txt,sha256=XRLbd93HUaedeWLtkyTvQjFcE5QcBRYa3V-CfHrq-OI,20
+mkv_episode_matcher-1.0.0.dist-info/RECORD,,

{mkv_episode_matcher-0.3.3.dist-info → mkv_episode_matcher-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mkv_episode_matcher-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jonathan Sakkos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkv_episode_matcher/config.py

@@ -1,82 +0,0 @@
-# config.py
-import configparser
-import multiprocessing
-import os
-
-from loguru import logger
-
-MAX_THREADS = 4
-
-
-def get_total_threads():
-    return multiprocessing.cpu_count()
-
-
-total_threads = get_total_threads()
-
-if total_threads < MAX_THREADS:
-    MAX_THREADS = total_threads
-logger.info(f"Total available threads: {total_threads} -> Setting max to {MAX_THREADS}")
-
-
-def set_config(
-    tmdb_api_key,
-    open_subtitles_api_key,
-    open_subtitles_user_agent,
-    open_subtitles_username,
-    open_subtitles_password,
-    show_dir,
-    file,
-    tesseract_path=None,
-):
-    """
-    Sets the configuration values and writes them to a file.
-
-    Args:
-        tmdb_api_key (str): The API key for TMDB (The Movie Database).
-        open_subtitles_api_key (str): The API key for OpenSubtitles.
-        open_subtitles_user_agent (str): The user agent for OpenSubtitles.
-        open_subtitles_username (str): The username for OpenSubtitles.
-        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
-    """
-    config = configparser.ConfigParser()
-    config["Config"] = {
-        "tmdb_api_key": str(tmdb_api_key),
-        "show_dir": show_dir,
-        "max_threads": int(MAX_THREADS),
-        "open_subtitles_api_key": str(open_subtitles_api_key),
-        "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}"
-    )
-    with open(file, "w") as configfile:
-        config.write(configfile)
-
-
-def get_config(file):
-    """
-    Read and return the configuration from the specified file.
-
-    Args:
-        file (str): The path to the configuration file.
-
-    Returns:
-        dict: The configuration settings as a dictionary.
-
-    """
-    logger.info(f"Loading config from {file}")
-    config = configparser.ConfigParser()
-    if os.path.exists(file):
-        config.read(file)
-        return config["Config"] if "Config" in config else None
-    return {}

mkv_episode_matcher/episode_matcher.py

@@ -1,100 +0,0 @@
-# mkv_episode_matcher/episode_matcher.py
-
-from pathlib import Path
-import shutil
-import glob
-import os
-from loguru import logger
-import re
-from mkv_episode_matcher.__main__ import CONFIG_FILE, CACHE_DIR
-from mkv_episode_matcher.config import get_config
-from mkv_episode_matcher.mkv_to_srt import convert_mkv_to_srt
-from mkv_episode_matcher.tmdb_client import fetch_show_id
-from mkv_episode_matcher.utils import (
-    check_filename,
-    clean_text,
-    cleanup_ocr_files,
-    get_subtitles,
-    process_reference_srt_files,
-    process_srt_files,
-    compare_and_rename_files,get_valid_seasons,rename_episode_file
-)
-from mkv_episode_matcher.speech_to_text import process_speech_to_text
-from mkv_episode_matcher.episode_identification import EpisodeMatcher
-
-def process_show(season=None, dry_run=False, get_subs=False):
-    """Process the show using streaming speech recognition with OCR fallback."""
-    config = get_config(CONFIG_FILE)
-    show_dir = config.get("show_dir")
-    show_name = clean_text(os.path.basename(show_dir))
-    matcher = EpisodeMatcher(CACHE_DIR, show_name)
-    
-    season_paths = get_valid_seasons(show_dir)
-    if not season_paths:
-        logger.warning(f"No seasons with .mkv files found")
-        return
-
-    if season is not None:
-        season_path = os.path.join(show_dir, f"Season {season}")
-        if season_path not in season_paths:
-            logger.warning(f"Season {season} has no .mkv files to process")
-            return
-        season_paths = [season_path]
-
-    for season_path in season_paths:
-        mkv_files = [f for f in glob.glob(os.path.join(season_path, "*.mkv"))
-                    if not check_filename(f)]
-        
-        if not mkv_files:
-            logger.info(f"No new files to process in {season_path}")
-            continue
-
-        season_num = int(re.search(r'Season (\d+)', season_path).group(1))
-        temp_dir = Path(season_path) / "temp"
-        ocr_dir = Path(season_path) / "ocr"
-        temp_dir.mkdir(exist_ok=True)
-        ocr_dir.mkdir(exist_ok=True)
-
-        try:
-            if get_subs:
-                show_id = fetch_show_id(matcher.show_name)
-                if show_id:
-                    get_subtitles(show_id, seasons={season_num})
-                    
-            unmatched_files = []
-            for mkv_file in mkv_files:
-                logger.info(f"Attempting speech recognition match for {mkv_file}")
-                match = matcher.identify_episode(mkv_file, temp_dir, season_num)
-                
-                if match:
-                    new_name = f"{matcher.show_name} - S{match['season']:02d}E{match['episode']:02d}.mkv"
-                    new_path = os.path.join(season_path, new_name)
-                    
-                    logger.info(f"Speech matched {os.path.basename(mkv_file)} to {new_name} "
-                              f"(confidence: {match['confidence']:.2f})")
-                    
-                    if not dry_run:
-                        logger.info(f"Renaming {mkv_file} to {new_name}")
-                        rename_episode_file(mkv_file, new_name)
-                else:
-                    logger.info(f"Speech recognition match failed for {mkv_file}, trying OCR")
-                    unmatched_files.append(mkv_file)
-
-            # OCR fallback for unmatched files
-            if unmatched_files:
-                logger.info(f"Attempting OCR matching for {len(unmatched_files)} unmatched files")
-                convert_mkv_to_srt(season_path, unmatched_files)
-                
-                reference_text_dict = process_reference_srt_files(matcher.show_name)
-                srt_text_dict = process_srt_files(str(ocr_dir))
-                
-                compare_and_rename_files(
-                    srt_text_dict, 
-                    reference_text_dict, 
-                    dry_run=dry_run,
-                )
-
-        finally:
-            if not dry_run:
-                shutil.rmtree(temp_dir)
-                cleanup_ocr_files(show_dir)

mkv_episode_matcher/libraries/pgs2srt/.gitignore

@@ -1,2 +0,0 @@
-__pycache__/
-.DS_Store