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

{mkv_episode_matcher-0.6.0 → mkv_episode_matcher-0.7.1}/.github/workflows/tests.yml

@@ -11,24 +11,22 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version:
-          - "3.9"
-          - "3.10"
-          - "3.11"
-          - "3.12"
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+      fail-fast: false
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v5
         with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
-        run: |
-          uv venv
-          uv pip install -e .
+      - name: Install the project
+        run: uv sync --all-extras --dev
 
       - name: Run tests with pytest and coverage
         run: |

{mkv_episode_matcher-0.6.0 → mkv_episode_matcher-0.7.1}/CHANGELOG.md

@@ -5,7 +5,22 @@ 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
+## [0.7.0] - 2025-03-05
+
+### Added
+- Rich UI with color-coded output and progress indicators
+- Interactive season selection interface
+- Visual confirmation panels for operations
+- GPU support check command
+- Masked API key display for improved security
+- Verbose output option for detailed logging
+
+### Changed
+- Enhanced CLI interface with better visual feedback
+- Improved error messages with color coding
+- Updated documentation to reflect new UI features
+
+## [0.6.0] - 2025-03-02
 
 ### Added
 - Comprehensive documentation including installation, configuration, and CLI guides
@@ -31,5 +46,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - Removed unused code
 
+[0.7.0]: https://github.com/Jsakkos/mkv-episode-matcher/releases/tag/v0.7.0
 [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.6.0 → mkv_episode_matcher-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mkv-episode-matcher
-Version: 0.6.0
+Version: 0.7.1
 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
@@ -14,7 +14,7 @@ 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.9
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: configparser>=7.1.0
 Requires-Dist: ffmpeg>=1.4
@@ -23,6 +23,7 @@ Requires-Dist: openai-whisper>=20240930
 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: tmdb-client>=0.0.1
 Requires-Dist: torch>=2.5.1
 Requires-Dist: torchaudio>=2.5.1
@@ -46,16 +47,18 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 ## Features
 
 - 🎯 **Automatic Episode Matching**: Uses TMDb to accurately identify episodes
+- 🎨 **Rich User Interface**: Color-coded output and progress indicators
 - 📝 **Subtitle Extraction**: Extracts subtitles from MKV files
 - 🔊 **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
 - 🧪 **Dry Run Mode**: Test changes before applying
+- 🎮 **Interactive Mode**: User-friendly season selection and configuration
 
 ## Prerequisites
 
-- Python 3.9 or higher
+- Python 3.9-3.12
 - [FFmpeg](https://ffmpeg.org/download.html) installed and available in system PATH
 - TMDb API key (optional, for subtitle downloads)
 - OpenSubtitles account (optional, for subtitle downloads)

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

@@ -15,16 +15,18 @@ Automatically match and rename your MKV TV episodes using The Movie Database (TM
 ## Features
 
 - 🎯 **Automatic Episode Matching**: Uses TMDb to accurately identify episodes
+- 🎨 **Rich User Interface**: Color-coded output and progress indicators
 - 📝 **Subtitle Extraction**: Extracts subtitles from MKV files
 - 🔊 **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
 - 🧪 **Dry Run Mode**: Test changes before applying
+- 🎮 **Interactive Mode**: User-friendly season selection and configuration
 
 ## Prerequisites
 
-- Python 3.9 or higher
+- Python 3.9-3.12
 - [FFmpeg](https://ffmpeg.org/download.html) installed and available in system PATH
 - TMDb API key (optional, for subtitle downloads)
 - OpenSubtitles account (optional, for subtitle downloads)

{mkv_episode_matcher-0.6.0 → mkv_episode_matcher-0.7.1}/docs/api/index.md

@@ -4,25 +4,29 @@ This section contains the automatically generated API documentation for MKV Epis
 
 ## Core Modules
 
+::: mkv_episode_matcher.__main__
+    options:
+        show_root_heading: true
+        heading_level: 2
+        
 ::: mkv_episode_matcher.episode_matcher
     options:
         show_root_heading: true
         heading_level: 2
 
-## TMDB Client
-
-::: mkv_episode_matcher.tmdb_client
+::: mkv_episode_matcher.episode_identification
     options:
         show_root_heading: true
         heading_level: 2
 
-## MKV Converter
+## TMDB Client
 
-::: mkv_episode_matcher.mkv_to_srt
+::: mkv_episode_matcher.tmdb_client
     options:
         show_root_heading: true
         heading_level: 2
 
+
 ## Utilities
 
 ::: mkv_episode_matcher.utils

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

@@ -1,5 +1,7 @@
 # Command Line Interface
 
+The CLI features a rich, user-friendly interface with color-coded output and progress indicators.
+
 ## Basic Commands
 
 ### Process Show
@@ -29,13 +31,13 @@ mkv-match --show-dir "/path/to/show" --season 1
 ### Dry Run Mode
 
 ```bash
-mkv-match --show-dir "/path/to/show" --dry-run true
+mkv-match --show-dir "/path/to/show" --dry-run
 ```
 
 ### Download Subtitles
 
 ```bash
-mkv-match --show-dir "/path/to/show" --get-subs true
+mkv-match --show-dir "/path/to/show" --get-subs
 ```
 
 ### Set API Key
@@ -50,8 +52,8 @@ mkv-match --show-dir "/path/to/show" --tmdb-api-key "your_key"
 mkv-match \
   --show-dir "/path/to/show" \
   --season 1 \
-  --get-subs true \
-  --dry-run true
+  --get-subs \
+  --dry-run
 ```
 
 ## Logging

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

@@ -34,7 +34,7 @@ Find the appropriate CUDA version and upgrade Torch (e.g., for CUDA 12.4) from t
 pip install -U torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu124
 
 # Verify GPU availability
-mkv-match --check-gpu true
+mkv-match --check-gpu
 ```
 
 ### Development Installation
@@ -83,7 +83,7 @@ Verify your installation:
 mkv-match --version
 
 # Check GPU availability (if installed with GPU support)
-mkv-match --check-gpu true
+mkv-match --check-gpu
 ```
 
 ## Troubleshooting

mkv_episode_matcher-0.7.1/docs/quickstart.md

@@ -0,0 +1,88 @@
+# Quick Start Guide
+
+Get started with MKV Episode Matcher quickly and efficiently.
+
+## Basic Usage
+
+### 1. Interactive Mode
+
+Simply run:
+```bash
+mkv-match
+```
+The program will guide you through the setup interactively.
+
+### 2. Command Line Options
+
+Process a specific season:
+```bash
+mkv-match --show-dir "/path/to/show" --season 1
+```
+
+Process all seasons with subtitles:
+```bash
+mkv-match --show-dir "/path/to/show" --get-subs
+```
+
+Test run with detailed output:
+```bash
+mkv-match --show-dir "/path/to/show" --dry-run --verbose
+```
+
+## Key Features
+
+- Interactive setup
+- Progress bars with ETA
+- Detailed matching information
+- Confidence-based matching
+- Automatic subtitle downloads
+- GPU acceleration support
+
+## Directory Structure
+
+Expected TV show organization:
+```
+Show Name/
+├── Season 1/
+│   ├── episode1.mkv
+│   ├── episode2.mkv
+├── Season 2/
+│   ├── episode1.mkv
+│   └── episode2.mkv
+```
+
+## Configuration
+
+Configuration is stored at `~/.mkv-episode-matcher/config.ini`:
+```ini
+[Config]
+tmdb_api_key = your_tmdb_api_key
+show_dir = /path/to/show
+open_subtitles_api_key = your_opensubs_key
+open_subtitles_user_agent = your_user_agent
+open_subtitles_username = your_username
+open_subtitles_password = your_password
+```
+
+## Common Commands
+
+### Check GPU Support
+```bash
+mkv-match --check-gpu true
+```
+
+### Set Confidence Level
+```bash
+mkv-match --show-dir "/path/to/show" --confidence 0.8
+```
+
+### Enable Verbose Output
+```bash
+mkv-match --show-dir "/path/to/show" --verbose true
+```
+
+## Next Steps
+
+- Read [Installation Guide](installation.md) for setup details
+- Check [Tips and Tricks](tips.md) for advanced usage
+- See [API Reference](api/index.md) for development

mkv_episode_matcher-0.7.1/docs/tips.md

@@ -0,0 +1,97 @@
+# Tips and Tricks
+
+## Best Practices
+
+### Directory Organization
+
+Organize your files consistently:
+```
+TV Shows/
+├── Show Name/
+│   ├── Season 1/
+│   │   ├── episode1.mkv
+│   │   └── episode2.mkv
+│   └── Season 2/
+│       ├── episode1.mkv
+│       └── episode2.mkv
+```
+
+### Performance & Accuracy
+
+1. **Confidence Threshold**
+   ```bash
+   # Increase matching accuracy (default: 0.7)
+   mkv-match --show-dir "/path/to/show" --confidence 0.8
+   ```
+   Start with a higher value and decrease if needed. Lower values may result in false positives.
+
+2. **Batch Processing with Progress**
+   The tool now shows detailed progress for each season:
+   ```bash
+   mkv-match --show-dir "/path/to/show"
+   ```
+
+3. **Speech Recognition**
+   - Uses Whisper for audio analysis
+   - Processes files in parallel for speed
+   - Shows real-time progress with completion estimates
+
+
+## Advanced Usage
+
+### Testing Changes
+
+Always use dry-run first:
+```bash
+mkv-match --show-dir "/path/to/show" --dry-run true
+```
+
+### Debug Output
+
+Enable verbose logging:
+```bash
+mkv-match --show-dir "/path/to/show" -v
+```
+
+### Log Files
+
+Check the logs at:
+```
+~/.mkv-episode-matcher/logs/
+├── stdout.log  # General operation logs
+└── stderr.log  # Error and warning logs
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **File Permission Errors**
+   ```bash
+   # Check file permissions
+   chmod -R 644 "/path/to/show"
+   ```
+
+2. **API Rate Limits**
+   - 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
+
+
+4. **Low Confidence Matches**
+   - Increase confidence threshold
+   - Check reference subtitles for accuracy
+
+5. **No Matches Found**
+   - Verify file organization
+   - Check reference subtitles
+   - Enable verbose output
+
+6. **Performance Issues**
+   - Process one season at a time
+   - Check available disk space
+   - Monitor system resources