PyCaptions, parser and converter for captions formats
Project description
PyCaptions
PyCaptions is a caption reading/writing library.Why LGPL-3.0? This is just to ensure that source code for the library is always under the same licence and cannot be closed-sourced. All the conditions for this licence only apply for the the library itself and it's modifications. We reccomend to just contribute to the project if you are making modifications, unless they are drastic and specific to your case.
Table of Contents
Installation
- PIP
pip install --upgrade pycaptions
- Source
git clone https://github.com/adfreelife/PyCaptions.git cd PyCaptions python setup.py install
Supported Formats
- SubRip (SRT) (reader + writer)
- MicroDVD (SUB) (reader + writer*)
- Timed Text Markup Language (TTML, DFXP, XML) (reader* + writer*)
- Web Video Text Tracks Format (VTT) (reader + writer*)
reader* - does not read styling/layout/metadata
writer* - does not write styling layout/metadata
Future plans
- add writers to all supported formats
- auto-fit lines into multilines or split captions blocks into two parts
- add support for more formats
- Synchronized Accessible Media Interchange (SAMI)
- Universal Subtitle Format (USF)
- LyRiCs (LRC)
- open an issue with "enhancement" label for more
Examples
Generic from file name
from pycaptions import Captions
with Captions("tests/test.en.srt") as captions:
captions.saveVTT("test")
Generic from file stream
with open("tests/test.en.srt", encoding="UTF-8") as f:
captions = Captions(f) # or captions = Captions()
# captions.read(f)
captions.saveVTT("test")
Generic from string
srt = """1
00:00:00,500 --> 00:00:02,000
This is a test file
"""
captions = Captions(srt) # or captions = Captions()
# captions.detect(srt)
captions.saveVTT("test")
Specific reader
Have the same functions as generic, except
from pycaptions import SubRip, detectSRT
with open("tests/test.en.srt", encoding="UTF-8") as f:
if detectSRT(f): # or SubRip.detect(f)
captions = SubRip().read(f)
captions.saveVTT("test")
Multilingual
from pycaptions import Captions
# if the format supports multiple languages
with Captions("tests/test.ttml") as captions:
# first line will be in english, second one in spanish
captions.saveSRT("test", ["en","es"])
# if you have multiple files and you want to make multilingual one
with Captions("tests/test.en.srt") as captions:
with Captions("tests/test.es.srt") as captions2:
# only subtitle text and comments (if format supports them) are added
captions+=captions2
# first line will be in english, second one in spanish
captions.save("test", ["en","es"])
Combine files
with Captions("tests/test.en.srt") as captions:
captions.joinFile("tests/test.en.srt", add_end_time=True)
captions.save("test")
Changelog
v0.5.1
Release date: 2024-01-23
Commit: TBA
Changes:
- Added
fromLegacyJson
to parse json saved before version v0.5.0 - Added
identifier: pycaptions
andversion
to json if something changes in the future. Block
of typeBlockType.STYLE
now parsesoptions.style
if it's a string by default when initialized, otherwise usestyling.cssParser
orcssutils.CSSParser
to parse css beforehand.- You can now change save extensions globaly by
save_extensions.{format} = {str}
Fixes:
- Fixed
toJson
not saving correctly due to atribute rename - Fixed
cssutils.css.CSSStyleSheet
causing error when usingtoJson
- Fixed
CaptionsFormat.getLayout
not returningBlock
- Fixed
CaptionsFormat.getStyle
not returningBlock
- Fixed
CaptionsFormat.getMetadata
not returningBlock
Read past changes here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycaptions-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be49ed752771f614a3cf83317c3beeeae4d907884cd7f499c36ba03b857591c9 |
|
MD5 | 4e9e4b6c1fbe32a638300a943b1bbaa4 |
|
BLAKE2b-256 | c8e9e1bd377349975506c51a541b06e5635e11f8162eb765de38eedb685604a4 |