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

Development Status PyPI version License: MIT Documentation Status Downloads GitHub last commit GitHub issues Tests codecov

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.3.3.tar.gz (320.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkv_episode_matcher-0.3.3-py3-none-any.whl (237.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkv_episode_matcher-0.3.3.tar.gz
  • Upload date:
  • Size: 320.7 kB
  • 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.3.3.tar.gz
Algorithm Hash digest
SHA256 5cbd1f2f809f35371f6eaa81fc3f86a1f97ddd08f985835b8274ae2d4d30f520
MD5 4dbc46545283c412b7166a0a13f8d899
BLAKE2b-256 5759c7646d9ca907196dfe3b1f9475c4fd9ff066eaf92bfbf48036b96313efbe

See more details on using hashes here.

Provenance

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

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for mkv_episode_matcher-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ab0af0d5974fed451e55fe9c948a9e614b1ef026f9020af96536fa44584b5a
MD5 d7abed1b088ef00fb1ec6f0bf8dd5112
BLAKE2b-256 b8482b6c4a3ff6ba82659854c5eae36f2b3ec225111dc20fd2d5405f553d21ce

See more details on using hashes here.

Provenance

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

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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