Project: webvtt-py

WebVTT reader, writer and segmenter

Project Details

Latest version
0.4.6
Home Page
https://github.com/glut23/webvtt-py
PyPI Page
https://pypi.org/project/webvtt-py/

Project Popularity

PageRank
0.001729886979167746
Number of downloads
205922

webvtt-py

.. image:: https://img.shields.io/pypi/v/webvtt-py.svg :target: https://pypi.python.org/pypi/webvtt-py

.. image:: https://travis-ci.org/glut23/webvtt-py.svg?branch=master :target: https://travis-ci.org/glut23/webvtt-py

.. image:: https://readthedocs.org/projects/webvtt-py/badge/?version=latest :target: http://webvtt-py.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

webvtt-py is a Python module for reading/writing WebVTT_ caption files. It also features caption segmentation useful when captioning HLS videos_.

Requires Python 3.4+.

Documentation is available at http://webvtt-py.readthedocs.io.

.. _WebVTT: http://dev.w3.org/html5/webvtt/ .. _HLS videos: https://tools.ietf.org/html/draft-pantos-http-live-streaming-19

Installation

::

$ pip install webvtt-py

Usage

.. code-block:: python

import webvtt

for caption in webvtt.read('captions.vtt'): print(caption.start) print(caption.end) print(caption.text)

Segmenting for HLS

.. code-block:: python

import webvtt

webvtt.segment('captions.vtt', 'output/path')

Converting captions from other formats

Supported formats:

  • SubRip (.srt)
  • YouTube SBV (.sbv)

.. code-block:: python

import webvtt

webvtt = webvtt.from_srt('captions.srt') webvtt.save()

one liner if we just need to convert without editing

webvtt.from_sbv('captions.sbv').save()

CLI

Caption segmentation is also available from the command line: ::

$ webvtt segment captions.vtt --output destination/directoy

License

Licensed under the MIT License.