Metadata-Version: 2.0
Name: webvtt-py
Version: 0.1
Summary: WebVTT reader, writer and segmenter
Home-page: https://github.com/glut23/webvtt-py
Author: Alejandro Mendez
Author-email: amendez23@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules

webvtt-py
=========

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

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

.. _`WebVTT`: http://dev.w3.org/html5/webvtt/
.. _`HLS videos`: https://tools.ietf.org/html/draft-pantos-http-live-streaming-19

Usage
-----

.. code-block:: python

  from webvtt import WebVTT

  webvtt = WebVTT().read('captions.vtt')
  for c in webvtt.captions:
      print(c.start)
      print(c.end)
      print(c.text)

Segmenting for HLS
------------------

.. code-block:: python

  from webvtt import WebVTTSegmenter

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

Converting SRT captions
-----------------------

.. code-block:: python

  from webvtt import WebVTT

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


