| Name | srt-to-vtt JSON |
| Version |
1.3.1
JSON |
| download |
| home_page | None |
| Summary | Python package to enable easy conversion of .srt files to .vtt files. |
| upload_time | 2024-04-28 18:50:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Joshua Hamilton 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. |
| keywords |
subtitle
subtitles
convert
srt
vtt
webvtt
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/srt-to-vtt/) [](https://github.com/psf/black)
# srt-to-vtt
Python package to enable easy conversion of .srt files to .vtt files.
## Install
srt-to-vtt is available on [PyPI](https://pypi.org/project/srt-to-vtt/) and you can install the latest version with
```
pip install srt-to-vtt
```
## Basic usage
```python
from srt_to_vtt import srt_to_vtt
path_to_my_srt_file = "example.srt"
path_to_converted_vtt_file = "output.vtt"
# converts example.srt into output.vtt
srt_to_vtt(path_to_my_srt_file, path_to_converted_vtt_file)
```
## Develop
Clone this repo and then, at the root, install the package in ediable mode with
```
pip install -e .
```
You can now make changes to the package source code found in `srt-to-vtt/srt_to_vtt/` and see them reflected immediately.
## Format, build, test and distribute
Before doing anything else, make sure to bump the version number under `[project]` in `pyproject.toml`. Please use [semantic versioning](https://semver.org/).
Then, install the build requirements with
```
pip install -r build_requirements.txt
```
### Format
This project adheres to the [Black](https://github.com/psf/black) code style. You can automatically refomat your code to Black by executing the following in the root directory of this repo:
```
black .
```
### Build
Then, to build, run
```
python -m build
```
### Test
After building the package, install it with
```
pip install dist/srt_to_vtt-#.#.#-py3-none-any.whl
```
You may now run the tests by simply executing
```
pytest
```
### Distribute
Assuming that all the tests are passing, the package is now ready to be released on PyPI!
Open a pull request on the main branch and, if approved and merged, the package will be automatically updated on PyPI after the next Release is published on GitHub.
Raw data
{
"_id": null,
"home_page": null,
"name": "srt-to-vtt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "subtitle, subtitles, convert, srt, vtt, webvtt",
"author": null,
"author_email": "Joshua Hamilton <hamiltonjoshuadavid@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/02/2d/17f6fec4ca0b1e9e79f20ccf594643fd400f556b586d364d2df124b1fc84/srt_to_vtt-1.3.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/srt-to-vtt/) [](https://github.com/psf/black)\n\n# srt-to-vtt\n\nPython package to enable easy conversion of .srt files to .vtt files.\n\n## Install\n\nsrt-to-vtt is available on [PyPI](https://pypi.org/project/srt-to-vtt/) and you can install the latest version with\n```\npip install srt-to-vtt\n```\n\n## Basic usage\n\n```python\nfrom srt_to_vtt import srt_to_vtt\n\npath_to_my_srt_file = \"example.srt\"\npath_to_converted_vtt_file = \"output.vtt\"\n\n# converts example.srt into output.vtt\nsrt_to_vtt(path_to_my_srt_file, path_to_converted_vtt_file)\n\n```\n\n## Develop\n\nClone this repo and then, at the root, install the package in ediable mode with\n```\npip install -e .\n```\nYou can now make changes to the package source code found in `srt-to-vtt/srt_to_vtt/` and see them reflected immediately.\n\n## Format, build, test and distribute\n\nBefore doing anything else, make sure to bump the version number under `[project]` in `pyproject.toml`. Please use [semantic versioning](https://semver.org/).\n\n\n\nThen, install the build requirements with\n```\npip install -r build_requirements.txt\n```\n\n### Format\n\nThis project adheres to the [Black](https://github.com/psf/black) code style. You can automatically refomat your code to Black by executing the following in the root directory of this repo:\n```\nblack .\n```\n\n### Build\nThen, to build, run\n```\npython -m build\n```\n\n### Test\n\nAfter building the package, install it with\n\n```\npip install dist/srt_to_vtt-#.#.#-py3-none-any.whl\n```\n\nYou may now run the tests by simply executing\n```\npytest\n```\n\n### Distribute\n\nAssuming that all the tests are passing, the package is now ready to be released on PyPI!\n\nOpen a pull request on the main branch and, if approved and merged, the package will be automatically updated on PyPI after the next Release is published on GitHub.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Joshua Hamilton 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.",
"summary": "Python package to enable easy conversion of .srt files to .vtt files.",
"version": "1.3.1",
"project_urls": {
"homepage": "https://github.com/joshdavham/srt-to-vtt"
},
"split_keywords": [
"subtitle",
" subtitles",
" convert",
" srt",
" vtt",
" webvtt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25bffa258886db70d0f5b36794927cdf94ae3720cfe96eb0c7cae14ddff0989b",
"md5": "d03b303cc2c5f859fdbced0a5efa2c77",
"sha256": "d47f971ea6f4938041a19530da3f8ddff198c053e09a5b587867e8a9ba4ca1d9"
},
"downloads": -1,
"filename": "srt_to_vtt-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d03b303cc2c5f859fdbced0a5efa2c77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4192,
"upload_time": "2024-04-28T18:50:11",
"upload_time_iso_8601": "2024-04-28T18:50:11.095007Z",
"url": "https://files.pythonhosted.org/packages/25/bf/fa258886db70d0f5b36794927cdf94ae3720cfe96eb0c7cae14ddff0989b/srt_to_vtt-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "022d17f6fec4ca0b1e9e79f20ccf594643fd400f556b586d364d2df124b1fc84",
"md5": "fcd1e174159b74323adf4b02765ab243",
"sha256": "3c93154f36c5529ba0f865d00167a494aad3ac9dad110a656f91f29df758ec32"
},
"downloads": -1,
"filename": "srt_to_vtt-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "fcd1e174159b74323adf4b02765ab243",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3654,
"upload_time": "2024-04-28T18:50:12",
"upload_time_iso_8601": "2024-04-28T18:50:12.587537Z",
"url": "https://files.pythonhosted.org/packages/02/2d/17f6fec4ca0b1e9e79f20ccf594643fd400f556b586d364d2df124b1fc84/srt_to_vtt-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 18:50:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joshdavham",
"github_project": "srt-to-vtt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "srt-to-vtt"
}
