Skip to main content

Subtitle processing toolkit: merge, sync, fix overlaps, and apply corrections

Project description

SubtitleKit - Subtitle Processing Toolkit

PyPI version Python 3.8+ License: MIT

Comprehensive Python library and desktop application for subtitle processing, synchronization, and correction.

✨ Features

  • Merge & Sync: Combine subtitle files with automatic synchronization
  • Fix Overlaps: Detect and correct timing issues and overlaps
  • Apply Corrections: Apply text corrections from JSON files
  • LLM Integration: Generate optimized JSON for translation workflows
  • Desktop App: Cross-platform GUI (Windows, macOS, Linux)
  • Colab Ready: Works seamlessly in Google Colab notebooks

🚀 Quick Start

Installation

pip install subtitlekit

Google Colab

Open In Colab

# Install
!pip install subtitlekit

# Launch UI
from subtitlekit.ui import show_ui
show_ui(lang='en')  # or 'el' for Greek

As a Library

from subtitlekit import merge_subtitles, fix_overlaps, apply_corrections

# Merge subtitle files
merge_subtitles("original.srt", ["helper.srt"], "output.json")

# Fix timing overlaps
fix_overlaps("input.srt", "reference.srt", "fixed.srt")

# Apply corrections from JSON
apply_corrections("input.srt", "corrections.json", "output.srt")

CLI Usage

# Merge subtitles
subtitlekit merge --original original.srt --helper helper.srt --output output.json

# Fix overlaps
subtitlekit overlaps --input input.srt --reference ref.srt --output fixed.srt

# Apply corrections
subtitlekit corrections --input input.srt --corrections fixes.json --output corrected.srt

Desktop App

Download the standalone application from Releases.

Or launch programmatically:

python -m subtitlekit.ui.desktop

📖 Documentation

Merge Subtitles

Combines original subtitle file with one or more helper files (different languages) to create JSON output optimized for LLM translation workflows.

subtitlekit merge \
  --original movie.srt \
  --helper helpful_en.srt \
  --helper helpful_pt.srt \
  --output for_translation.json \
  --skip-sync  # optional: skip ffsubsync

Output format:

{
  "id": 1,
  "t": "00:00:11,878 --> 00:00:16,130",
  "trans": "Original text to translate",
  "h1": "Helper text (language 1)",
  "h2": "Helper text (language 2)"
}

Fix Overlaps

Detects and corrects timing issues:

  • Overlapping timestamps
  • Out-of-order entries
  • Unreasonable durations
  • Duplicate timings
subtitlekit overlaps \
  --input problematic.srt \
  --reference correct_timings.srt \
  --output fixed.srt \
  --window 5

Apply Corrections

Apply text corrections from JSON file:

subtitlekit corrections \
  --input subtitle.srt \
  --corrections fixes.json \
  --output corrected.srt

Corrections JSON format:

[
  {
    "id": 1,
    "rx": "text to find",
    "sb": "replacement text",
    "rate": 8,
    "type": "grammar"
  }
]

🌍 I18n Support

Desktop and Colab UIs support:

  • 🇬🇧 English
  • 🇬🇷 Greek (Ελληνικά)

📦 Development

# Clone repository
git clone https://github.com/angelospk/subtitlekit.git
cd subtitlekit

# Install in development mode
pip install -e .

# Run tests
pytest -v

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - see LICENSE file.

🙏 Credits

Built by angelospk

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

subtitlekit-0.1.6.tar.gz (59.1 kB view details)

Uploaded Source

Built Distribution

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

subtitlekit-0.1.6-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file subtitlekit-0.1.6.tar.gz.

File metadata

  • Download URL: subtitlekit-0.1.6.tar.gz
  • Upload date:
  • Size: 59.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for subtitlekit-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d397c405ea080519f1b8f8b783b2676b1ddd3b3d41fe0e52b4f1cba5a6c60117
MD5 ccd973a289e84177bd9ade817c6f30de
BLAKE2b-256 f446699b5cdcc29732e2081a621efc0c37a0e1567da333af77882c0cb09ccfcf

See more details on using hashes here.

File details

Details for the file subtitlekit-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: subtitlekit-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for subtitlekit-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 143a2c1040b421a40d766da5f381729dc5300d67d61741478c48eab015561935
MD5 8dca1e5e82136c1e8b7145c4974540b1
BLAKE2b-256 92261c862b25f79a275d3f7b8db785cac94f3ae67d2674496137e95b837bf373

See more details on using hashes here.

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