Metadata-Version: 2.1
Name: webvtt-py
Version: 0.5.0
Summary: WebVTT reader, writer and segmenter
Home-page: https://github.com/glut23/webvtt-py
Author: Alejandro Mendez
Author-email: amendez23@gmail.com
License: MIT
Description: webvtt-py
        =========
        
        |pypi| |pyversions| |license| |coverage| |build-status| |docs-status| |downloads|
        
        ``webvtt-py`` is a Python module for reading/writing WebVTT_ caption files. It also features caption segmentation useful when captioning `HLS videos`_.
        
        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 output/path
        
        License
        -------
        
        Licensed under the MIT License.
        
        .. |pypi| image:: https://img.shields.io/pypi/v/webvtt-py.svg
            :target: https://pypi.python.org/pypi/webvtt-py
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/webvtt-py.svg
            :alt: Supported Python versions
            :target: https://pypi.python.org/pypi/webvtt-py
        
        .. |license| image:: https://img.shields.io/pypi/l/webvtt-py.svg
            :alt: MIT License
            :target: https://opensource.org/licenses/MIT
        
        .. |coverage| image:: https://codecov.io/gh/glut23/webvtt-py/graph/badge.svg?branch=master
            :target: https://codecov.io/gh/glut23/webvtt-py
        
        .. |build-status| image:: https://github.com/glut23/webvtt-py/actions/workflows/ci.yml/badge.svg?branch=master
            :target: https://github.com/glut23/webvtt-py/actions/workflows/ci.yml
        
        .. |docs-status| image:: https://readthedocs.org/projects/webvtt-py/badge/?version=latest
            :target: http://webvtt-py.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. |downloads| image:: https://static.pepy.tech/badge/webvtt-py
            :target: https://pepy.tech/project/webvtt-py
            :alt: Downloads
Keywords: webvtt captions
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
