VttFormatter

Converts WEBVTT files into text removing timestamps and identifiers and formatting the text into paragraphs.

VTT_formatter is a python package that can be executed using python in the command line or through an interface such as a Jupyter Notebook either locally on a machine or using Azure Notebooks.

Full instructions on using VTT_formatter in a Jupyter Notebook, on either Azure Notebooks, or locally using Anaconda can be found on the wiki.

Example Input/Output

Input

WEBVTT

NOTE duration:"00:00:32.5820000"

NOTE language:en-us

NOTE Confidence: 0.69450831413269

ef04c7c2-a59e-463f-9d27-b5b1259d6777
00:00:03.300 --> 00:00:06.870
Hello.

NOTE Confidence: 0.621036410331726

8a017ebb-1722-4e7f-8984-fc6da39c3489
00:00:08.100 --> 00:00:09.620
Hi there.

NOTE Confidence: 0.713402450084686

d9a1567a-1ebe-40ce-983a-98436bcabcfe
00:00:19.240 --> 00:00:20.240
Can you hear me properly?

NOTE Confidence: 0.536461710929871

b8e0fa64-8c2f-4070-9b0f-922a50f3fcde
00:00:21.930 --> 00:00:23.490
Yeah.

NOTE Confidence: 0.889019846916199

88910870-8af9-48f5-bcc4-a501eda95d3f
00:00:24.670 --> 00:00:28.778
But now my headphones are playing
up, I can still hear you though.

NOTE Confidence: 0.889019846916199

7d633414-089b-4813-9617-9533f5f215c0
00:00:28.778 --> 00:00:32.570
Well, I mean it is crackling. It 
will still be recording the audio.

Output

Hello.

Hi there.

Can you hear me properly?

Yeah.

But now my headphones are playing up, I can still hear you though. Well, I mean 
it is crackling. It will still be recording the audio.

Simple useage

The screenshot belows shows the simple implementation of the VTT formatter in a jupyter notebook. This will read in the file defined and create a new .txt file in the same directory as the original.

Further information can be found in the notebook here

Installation

The simplest way to install this vttformatter is to use pip to install from PyPI

pip install vttformatter

Alternatively, you can download the latest release from GitHub, and install directly:

cd vttformatter
pip install -e .

which installs an editable (-e) version of pyscses in your userspace.

Or clone the latest version from GitHub with

git clone [email protected]:georgiewellock/VTT_formatter.git

and install the same way.

cd vttformatter
pip install -e .

Tests

Unit tests are available in the top tests directory. These can be run using

pytest

or

python -m unittest discover

in the top directory.

Contributing

Bugs reports and feature requests

If you think you have found a bug, please report it on the Issue Tracker. This is also the place to propose ideas for new features or ask questions about the design of the vtt formatter. Poor documentation is considered a bug, but please be as specific as possible when asking for improvements.