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

Uploaded Source

Built Distribution

mkv_episode_matcher-0.3.2-py3-none-any.whl (238.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkv_episode_matcher-0.3.2.tar.gz
  • Upload date:
  • Size: 315.3 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.2.tar.gz
Algorithm Hash digest
SHA256 2e444617b041bf84a4d3d8089b61aa30f09ca91fc45c704c9cf8c6085dcb707a
MD5 f8feaddb0274b7a8bc4679e208d0d07f
BLAKE2b-256 d86e8dedafceee04cc7775312e6085272a7ab5054f661f9bd5b4c3b65671f3cc

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

File hashes

Hashes for mkv_episode_matcher-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 15e5f719a249b6e251753a44a9ad7efb0a887742bca50ec7bdfb3d4e249b3450
MD5 6b8a02e7bb150150a74dd86245fdc0c8
BLAKE2b-256 e5dbfebb61497f7814b8f4c085389dbe8f018b4000b1658b76a7501f8060bf53

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkv_episode_matcher-0.3.2-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