Skip to content

Repository files navigation

pysubs2 build master branch pysubs2 test code coverage Static Badge PyPI - Version PyPI - Status PyPI - Python Version PyPI - License GitHub Repo stars

pysubs2

pysubs2 is a Python library for editing subtitle files. It’s based on SubStation Alpha, the native format of Aegisub; it also supports SubRip (SRT), MicroDVD, MPL2, TMP, WebVTT, TTML and SAMI formats and OpenAI Whisper captions.

Goal of this library is to provide practical, robust handling for subtitle files found in the wild (with all their questionable syntax). Internally, everything is converted to a representation based on ASS, which is relevant if you want to process formatting. Support for production/broadcast subtitle formats (or subtitle features beyond what ASS can express) is not really a goal of the library; however, please open an issue if you have a use-case where using this library would make sense to you.

Based on code originally created in 2011, in development ever since. Thanks to all users and contributors over the years!


Quick links: Documentation · Issues · Contributing · Source code


Usage

For more information, please see the tutorial and API reference in the Documentation.

import pysubs2
subs = pysubs2.load("my_subtitles.ass", encoding="utf-8")
subs.shift(s=2.5)
for line in subs:
    line.text = "{\\be1}" + line.text
subs.save("my_subtitles_edited.ass")

There is also a small CLI tool for batch conversion and retiming.

pip install pysubs2
pysubs2 --shift 0.3s *.srt
pysubs2 --to srt *.ass

Installation

Simply uv add pysubs2 or pip install pysubs2.

The library itself is pure Python, with no additional dependencies.

Contributing

If you'd like to contribute code to the library, see CONTRIBUTING.md.

License

pysubs2 is licensed under the MIT license (see LICENSE.txt).

Releases

Used by

Contributors

Languages