Skip to main content

The MKV Episode Matcher is a tool for identifying TV series episodes from MKV files and renaming the files accordingly.

Project description

MKV Episode Matcher

Documentation Status PyPI version License: MIT

Automatically match and rename your MKV TV episodes using The Movie Database (TMDb).

Features

  • 🎯 Automatic Episode Matching: Uses TMDb to accurately identify episodes
  • 📝 Subtitle Extraction: Extracts subtitles from MKV files
  • 🔍 OCR Support: Handles image-based subtitles
  • 🚀 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

Quick Start

  1. Install the package:
pip install mkv-episode-matcher
  1. Run on your show directory:
mkv-match --show-dir "path/to/your/show" --season 1

Requirements

  • Python 3.8 or higher
  • TMDb API key
  • OpenSubtitles account (optional, for subtitle downloads)

Documentation

Full documentation is available at https://jsakkos.github.io/mkv-episode-matcher/

Basic Usage

from mkv_episode_matcher import process_show

# Process all seasons
process_show()

# Process specific season
process_show(season=1)

# Test run without making changes
process_show(season=1, dry_run=True)

# Process and download subtitles
process_show(get_subs=True)

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

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 for their excellent API
  • OpenSubtitles for subtitle integration
  • All contributors who have helped improve this project

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkv_episode_matcher-0.2.0.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

mkv_episode_matcher-0.2.0-py3-none-any.whl (234.2 kB view details)

Uploaded Python 3

File details

Details for the file mkv_episode_matcher-0.2.0.tar.gz.

File metadata

  • Download URL: mkv_episode_matcher-0.2.0.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mkv_episode_matcher-0.2.0.tar.gz
Algorithm Hash digest
SHA256 04b4342e433fa92b5b604749622525b9b23122a8d313b83d8369060c56c88c08
MD5 0aad07fcc92bcc46ccd0490c953e3b35
BLAKE2b-256 d3c4da81ede3c826be40d62608fb5ec2209a392bddb755a64d83bc3823008667

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkv_episode_matcher-0.2.0.tar.gz:

Publisher: python-publish.yml on Jsakkos/mkv-episode-matcher

Attestations:

File details

Details for the file mkv_episode_matcher-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkv_episode_matcher-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea1e372d8cc56e8134fd2a0735df499e617d98fb939732c85d2750d4abbdc596
MD5 b71aa3fbb3a22d606f885f1d9009d323
BLAKE2b-256 327958e8788f5f9cd0f8ed674ae8cb5e1a62115479b708958d0533eabf16af70

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkv_episode_matcher-0.2.0-py3-none-any.whl:

Publisher: python-publish.yml on Jsakkos/mkv-episode-matcher

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page