webvtt-py 0.5.0__tar.gz

webvtt-py-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Alejandro Mendez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

webvtt-py-0.5.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.rst
+
+graft tests
+
+global-exclude __pycache__
+global-exclude *.py[co]

webvtt-py-0.5.0/PKG-INFO

@@ -0,0 +1,120 @@
+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

webvtt-py-0.5.0/README.rst

@@ -0,0 +1,95 @@
+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

webvtt-py-0.5.0/setup.cfg

@@ -0,0 +1,48 @@
+[metadata]
+description_file = README.rst
+
+[flake8]
+doctests = true
+radon-max-cc = 10
+
+[tox:tox]
+envlist = 
+	codestyle
+	py
+	coverage
+isolated_build = True
+
+[coverage:run]
+source = webvtt
+branch = true
+
+[coverage:report]
+fail_under = 100
+
+[testenv]
+deps = 
+	coverage
+description = run the tests and provide coverage metrics
+commands = 
+	coverage run -m unittest discover
+
+[testenv:codestyle]
+deps = 
+	flake8
+	flake8-docstrings
+	radon
+	mypy
+commands = 
+	flake8 webvtt setup.py
+	mypy webvtt
+
+[testenv:coverage]
+deps = coverage
+commands = 
+	coverage xml
+	coverage report
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

webvtt-py-0.5.0/setup.py

@@ -0,0 +1,50 @@
+"""webvtt-py setuptools configuration."""
+
+import re
+import pathlib
+
+from setuptools import setup, find_packages
+
+version, author, author_email = (
+    re.search(
+        rf'__{name}__ = \'(.*?)\'',
+        pathlib.Path('webvtt/__init__.py').read_text()
+        ).group(1)
+    for name in ('version', 'author', 'author_email')
+    )
+
+setup(
+    name='webvtt-py',
+    version=version,
+    description='WebVTT reader, writer and segmenter',
+    long_description=pathlib.Path('README.rst').read_text(),
+    long_description_content_type='text/x-rst',
+    author=author,
+    author_email=author_email,
+    url='https://github.com/glut23/webvtt-py',
+    packages=find_packages('.', exclude=['tests']),
+    include_package_data=True,
+    entry_points={
+        'console_scripts': [
+            'webvtt=webvtt.cli:main'
+        ]
+    },
+    license='MIT',
+    python_requires='>=3.7',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+    keywords='webvtt captions',
+)

webvtt-py-0.5.0/tests/samples/captions_with_bom.vtt

@@ -0,0 +1,13 @@
+WEBVTT
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:11.890
+Caption text #2
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3
+
+00:00:16.320 --> 00:00:21.580
+Caption text #4

webvtt-py-0.5.0/tests/samples/comments.vtt

@@ -0,0 +1,23 @@
+WEBVTT - Translation of that film I like
+
+NOTE
+This translation was done by Kyle so that
+some friends can watch it with their parents.
+
+1
+00:02:15.000 --> 00:02:20.000
+- Ta en kopp varmt te.
+- Det är inte varmt.
+
+2
+00:02:20.000 --> 00:02:25.000
+- Har en kopp te.
+- Det smakar som te.  
+
+NOTE This last line may not translate well.
+
+3
+00:02:25.000 --> 00:02:30.000
+- Ta en kopp
+
+NOTE end of file

webvtt-py-0.5.0/tests/samples/cue_tags.vtt

@@ -0,0 +1,10 @@
+WEBVTT
+
+00:16.500 --> 00:18.500
+When the moon <00:17.500>hits your eye
+
+00:00:18.500 --> 00:00:20.500
+Like a <00:19.000>big-a <00:19.500>pizza <00:20.000>pie
+
+00:00:20.500 --> 00:00:21.500
+That's <00:00:21.000><c.colorE5E5E5>amore</c>

webvtt-py-0.5.0/tests/samples/invalid.vtt

@@ -0,0 +1,20 @@
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:11.890
+Caption text #2
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3
+
+00:00:16.320 --> 00:00:21.580
+Caption text #4
+
+00:00:21.580 --> 00:00:23.880
+Caption text #5
+
+00:00:23.880 --> 00:00:27.280
+Caption text #6
+
+00:00:27.280 --> 00:00:30.280
+Caption text #7

webvtt-py-0.5.0/tests/samples/invalid_format.sbv

@@ -0,0 +1 @@
+some text

webvtt-py-0.5.0/tests/samples/invalid_format1.srt

@@ -0,0 +1 @@
+1

webvtt-py-0.5.0/tests/samples/invalid_format2.srt

@@ -0,0 +1 @@
+some text

webvtt-py-0.5.0/tests/samples/invalid_format3.srt

@@ -0,0 +1,2 @@
+1
+some text

webvtt-py-0.5.0/tests/samples/invalid_format4.srt

@@ -0,0 +1,2 @@
+some text
+00:00:00,500 --> 00:00:07,000

webvtt-py-0.5.0/tests/samples/invalid_timeframe.sbv

@@ -0,0 +1,14 @@
+0:00:00.378,0:00:11.378
+Caption text #1
+
+0:00:11.378,0:00:12.305
+Caption text #2
+
+0:00:13.f89,0:00:15.489
+Caption text #3
+
+0:00:15.489,0:00:16.234
+Caption text #4
+
+0:00:17.484,0:00:16.543
+Caption text #5

webvtt-py-0.5.0/tests/samples/invalid_timeframe.srt

@@ -0,0 +1,19 @@
+1
+00:00:00,500 --> 00:00:07,000
+Caption text #1
+
+2
+00:00:07,000 --> 00:00:11.890
+Caption text #2
+
+3
+00:00:11,890 --> 00:00:16,320
+Caption text #3
+
+4
+00:00:16,320 --> 00:00:21,580
+Caption text #4
+
+5
+00:00:21,580 --> 00:00:23,880
+Caption text #5

webvtt-py-0.5.0/tests/samples/invalid_timeframe.vtt

@@ -0,0 +1,22 @@
+WEBVTT
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:1d.890
+Caption text #2
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3
+
+00:00:16.320 --> 00:00:21.580
+Caption text #4
+
+00:00:21.580 --> 00:00:23.880
+Caption text #5
+
+00:00:23.880 --> 00:00:27.280
+Caption text #6
+
+00:00:27.280 --> 00:00:30.280
+Caption text #7

webvtt-py-0.5.0/tests/samples/invalid_timeframe_in_cue_text.vtt

@@ -0,0 +1,11 @@
+WEBVTT
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:10.890
+00:00:07.000 --> 00:00:10.890
+Caption text #2
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3

webvtt-py-0.5.0/tests/samples/metadata_headers.vtt

@@ -0,0 +1,9 @@
+WEBVTT
+Kind: captions
+Language: en
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:11.890
+Caption text #2

webvtt-py-0.5.0/tests/samples/metadata_headers_multiline.vtt

@@ -0,0 +1,13 @@
+WEBVTT
+Kind: captions
+Language: en
+Style:
+::cue(c.colorCCCCCC) { color: rgb(204, 204, 204);
+}
+##
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:11.890
+Caption text #2

webvtt-py-0.5.0/tests/samples/missing_caption_text.sbv

@@ -0,0 +1,13 @@
+0:00:00.378,0:00:11.378
+Caption text #1
+
+0:00:11.378,0:00:12.305
+
+0:00:13.489,0:00:15.489
+Caption text #3
+
+0:00:15.489,0:00:16.234
+Caption text #4
+
+0:00:17.484,0:00:16.543
+Caption text #5

webvtt-py-0.5.0/tests/samples/missing_caption_text.srt

@@ -0,0 +1,19 @@
+1
+00:00:00,500 --> 00:00:07,000
+Caption text #1
+
+2
+00:00:07,000 --> 00:00:11,890
+
+
+3
+00:00:11,890 --> 00:00:16,320
+Caption text #3
+
+4
+00:00:16,320 --> 00:00:21,580
+Caption text #4
+
+5
+00:00:21,580 --> 00:00:23,880
+Caption text #5

webvtt-py-0.5.0/tests/samples/missing_caption_text.vtt

@@ -0,0 +1,15 @@
+WEBVTT
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+00:00:07.000 --> 00:00:11.890
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3
+
+00:00:16.320 --> 00:00:21.580
+Caption text #4
+
+00:00:21.580 --> 00:00:23.880
+Caption text #5

webvtt-py-0.5.0/tests/samples/missing_timeframe.sbv

@@ -0,0 +1,13 @@
+0:00:00.378,0:00:11.378
+Caption text #1
+
+Caption text #2
+
+0:00:13.489,0:00:15.489
+Caption text #3
+
+0:00:15.489,0:00:16.234
+Caption text #4
+
+0:00:17.484,0:00:16.543
+Caption text #5

webvtt-py-0.5.0/tests/samples/missing_timeframe.srt

@@ -0,0 +1,18 @@
+1
+00:00:00,500 --> 00:00:07,000
+Caption text #1
+
+2
+Caption text #2
+
+3
+00:00:11,890 --> 00:00:16,320
+Caption text #3
+
+4
+00:00:16,320 --> 00:00:21,580
+Caption text #4
+
+5
+00:00:21,580 --> 00:00:23,880
+Caption text #5

webvtt-py-0.5.0/tests/samples/missing_timeframe.vtt

@@ -0,0 +1,21 @@
+WEBVTT
+
+00:00:00.500 --> 00:00:07.000
+Caption text #1
+
+Caption text #2
+
+00:00:11.890 --> 00:00:16.320
+Caption text #3
+
+00:00:16.320 --> 00:00:21.580
+Caption text #4
+
+00:00:21.580 --> 00:00:23.880
+Caption text #5
+
+00:00:23.880 --> 00:00:27.280
+Caption text #6
+
+00:00:27.280 --> 00:00:30.280
+Caption text #7