# vtt_to_srt3
Convert vtt files to srt subtitle format
> For Python 3.x
* [you can get a new version for Python 2.7 here](https://github.com/jsonzilla/vtt_to_srt2)
* [you can get the old version for Python 2.7 here](https://github.com/jansenicus/vtt-to-srt.py)
## Docs
[https://jsonzilla.github.io/vtt_to_srt3/](https://jsonzilla.github.io/vtt_to_srt3/)
## Installation
```shell
pip install vtt_to_srt3
```
```cmd
python -m pip install vtt_to_srt3
```
## Usage from terminal
```shell
usage: vtt_to_srt [-h] [-r] [-e ENCODING] [-rf] pathname
Convert vtt files to srt files
positional arguments:
pathname a file or directory with files to be converted
options:
-h, --help show this help message and exit
-r, --recursive walk path recursively
-e ENCODING, --encoding ENCODING
encoding format for input and output files
-rf, --remove_format remove the format tags like bold & italic from output files
```
## Usage as a lib
Convert vtt file
```python
from vtt_to_srt.vtt_to_srt import ConvertFile
convert_file = ConvertFile("input_utf8.vtt", "utf-8")
convert_file.convert()
```
Recursively convert all vtt files in directory
```python
from vtt_to_srt.vtt_to_srt import ConvertDirectories
recursive = False
convert_file = ConvertDirectories(".", recursive, "utf-8")
convert_file.convert()
```
## Manual build
Generate wheel
```shell
python -m pip install --upgrade setuptools wheel build
python -m build
```
## Generate documentation
Generate documentation
```shell
python -m pip install pdoc3
pdoc --html vtt_to_srt/vtt_to_srt.py -o docs
mv docs/vtt_to_srt.html docs/index.html
rm -rm docs/vtt_to_srt
```
Raw data
{
"_id": null,
"home_page": "https://github.com/jsonzilla/vtt_to_srt3",
"name": "vtt-to-srt3",
"maintainer": "Jeison Cardoso",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Jeison Cardoso",
"author_email": "j@jsonzilla.com",
"download_url": "https://files.pythonhosted.org/packages/63/c6/5207dbce856c59fefd9e242da4e2def68ec69a90153cc8219b0b0aad9cbd/vtt_to_srt3-0.2.0.4.tar.gz",
"platform": null,
"description": "# vtt_to_srt3\nConvert vtt files to srt subtitle format\n> For Python 3.x\n * [you can get a new version for Python 2.7 here](https://github.com/jsonzilla/vtt_to_srt2)\n * [you can get the old version for Python 2.7 here](https://github.com/jansenicus/vtt-to-srt.py)\n\n## Docs\n[https://jsonzilla.github.io/vtt_to_srt3/](https://jsonzilla.github.io/vtt_to_srt3/)\n\n\n## Installation\n```shell\npip install vtt_to_srt3\n```\n\n```cmd\npython -m pip install vtt_to_srt3\n```\n\n## Usage from terminal\n\n```shell\nusage: vtt_to_srt [-h] [-r] [-e ENCODING] [-rf] pathname\n\nConvert vtt files to srt files\n\npositional arguments:\n pathname a file or directory with files to be converted\n\noptions:\n -h, --help show this help message and exit\n -r, --recursive walk path recursively\n -e ENCODING, --encoding ENCODING\n encoding format for input and output files\n -rf, --remove_format remove the format tags like bold & italic from output files\n```\n\n## Usage as a lib\n\nConvert vtt file\n```python\nfrom vtt_to_srt.vtt_to_srt import ConvertFile\n\nconvert_file = ConvertFile(\"input_utf8.vtt\", \"utf-8\")\nconvert_file.convert()\n```\n\nRecursively convert all vtt files in directory\n```python\nfrom vtt_to_srt.vtt_to_srt import ConvertDirectories\n\nrecursive = False\nconvert_file = ConvertDirectories(\".\", recursive, \"utf-8\")\nconvert_file.convert()\n```\n\n## Manual build\n\nGenerate wheel\n```shell\npython -m pip install --upgrade setuptools wheel build\npython -m build\n```\n\n## Generate documentation\n\nGenerate documentation\n```shell\npython -m pip install pdoc3\npdoc --html vtt_to_srt/vtt_to_srt.py -o docs\nmv docs/vtt_to_srt.html docs/index.html\nrm -rm docs/vtt_to_srt\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "vtt to srt subtitles converter package",
"version": "0.2.0.4",
"project_urls": {
"Homepage": "https://github.com/jsonzilla/vtt_to_srt3"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7fd82930e9585f37c9afa9df817b6a3a66df0e6178734a2d38f507e9bfd40233",
"md5": "1c6e463da8601f5c86ea0af96cfc5870",
"sha256": "75dab9b55640b4d641b942d58a37e60a327121d0826a41fc214bb922574e0cab"
},
"downloads": -1,
"filename": "vtt_to_srt3-0.2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c6e463da8601f5c86ea0af96cfc5870",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9240,
"upload_time": "2024-09-07T09:33:36",
"upload_time_iso_8601": "2024-09-07T09:33:36.556375Z",
"url": "https://files.pythonhosted.org/packages/7f/d8/2930e9585f37c9afa9df817b6a3a66df0e6178734a2d38f507e9bfd40233/vtt_to_srt3-0.2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63c65207dbce856c59fefd9e242da4e2def68ec69a90153cc8219b0b0aad9cbd",
"md5": "3b73b1097e90506cfaf2f0ed820e086f",
"sha256": "ed1baea5fb1010752880cb877a1ab7ba10f9d7a248c4305f456ebba2651adf61"
},
"downloads": -1,
"filename": "vtt_to_srt3-0.2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "3b73b1097e90506cfaf2f0ed820e086f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10749,
"upload_time": "2024-09-07T09:33:37",
"upload_time_iso_8601": "2024-09-07T09:33:37.523346Z",
"url": "https://files.pythonhosted.org/packages/63/c6/5207dbce856c59fefd9e242da4e2def68ec69a90153cc8219b0b0aad9cbd/vtt_to_srt3-0.2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 09:33:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jsonzilla",
"github_project": "vtt_to_srt3",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vtt-to-srt3"
}
JSON
