| Name | caption2text JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A lightweight Python module to convert VTT and SRT caption files into plain text transcripts. |
| upload_time | 2024-09-24 06:08:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2024 BlueBirdBack ✨ 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 |
captions
subtitles
vtt
srt
transcript
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Certainly! I'll help you update the README.md file for the caption2text project. Based on the current content and the project structure, I'll provide an expanded version of the README that includes more information about the project, its usage, and other relevant details.
Here's an updated version of the README.md:
````markdown:README.md
# caption2text
A lightweight Python module that converts VTT and SRT caption files into plain text transcripts.
## Features
- Convert WebVTT (.vtt) files to plain text transcripts
- Convert SubRip (.srt) files to plain text transcripts
- Easy-to-use Python API
- Command-line interface (CLI) for quick conversions
## Installation
You can install caption2text using pip:
```bash
pip install caption2text
````
## Usage
### Python API
```python
from caption2text import vtt_to_transcript, srt_to_transcript
# Convert VTT file to transcript
vtt_transcript = vtt_to_transcript('path/to/your/file.vtt')
print(vtt_transcript)
# Convert SRT file to transcript
srt_transcript = srt_to_transcript('path/to/your/file.srt')
print(srt_transcript)
```
### Command-line Interface
```bash
# Convert VTT file
caption2text convert path/to/your/file.vtt
# Convert SRT file
caption2text convert path/to/your/file.srt
# Specify output file
caption2text convert path/to/your/file.vtt -o output.txt
```
## Development
To set up the development environment:
1. Clone the repository
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment:
- On Windows: `venv\Scripts\activate`
- On macOS and Linux: `source venv/bin/activate`
4. Install development dependencies: `pip install -e .[dev]`
### Running Tests
To run the tests, use the following command:
```bash
python -m unittest discover tests
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Support
If you encounter any problems or have any questions, please open an issue on the GitHub repository.
```
This updated README.md provides a more comprehensive overview of the project, including installation instructions, usage examples for both the Python API and command-line interface, development setup, testing instructions, license information, and contribution guidelines.
You can further customize this README by adding more specific details about your project, such as:
1. Requirements or dependencies
2. More detailed examples or use cases
3. Troubleshooting section
4. Changelog or version history
5. Acknowledgements or credits
Let me know if you'd like to make any changes or additions to this updated README.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "caption2text",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "captions, subtitles, vtt, srt, transcript",
"author": null,
"author_email": "BlueBirdBack <avery@bluebirdback.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/31/de797f33db05958642aebe74bdeb182c0f2662a49696fc86df964e1e9d72/caption2text-0.1.2.tar.gz",
"platform": null,
"description": "Certainly! I'll help you update the README.md file for the caption2text project. Based on the current content and the project structure, I'll provide an expanded version of the README that includes more information about the project, its usage, and other relevant details.\r\n\r\nHere's an updated version of the README.md:\r\n\r\n````markdown:README.md\r\n# caption2text\r\n\r\nA lightweight Python module that converts VTT and SRT caption files into plain text transcripts.\r\n\r\n## Features\r\n\r\n- Convert WebVTT (.vtt) files to plain text transcripts\r\n- Convert SubRip (.srt) files to plain text transcripts\r\n- Easy-to-use Python API\r\n- Command-line interface (CLI) for quick conversions\r\n\r\n## Installation\r\n\r\nYou can install caption2text using pip:\r\n\r\n```bash\r\npip install caption2text\r\n````\r\n\r\n## Usage\r\n\r\n### Python API\r\n\r\n```python\r\nfrom caption2text import vtt_to_transcript, srt_to_transcript\r\n\r\n# Convert VTT file to transcript\r\nvtt_transcript = vtt_to_transcript('path/to/your/file.vtt')\r\nprint(vtt_transcript)\r\n\r\n# Convert SRT file to transcript\r\nsrt_transcript = srt_to_transcript('path/to/your/file.srt')\r\nprint(srt_transcript)\r\n```\r\n\r\n### Command-line Interface\r\n\r\n```bash\r\n# Convert VTT file\r\ncaption2text convert path/to/your/file.vtt\r\n\r\n# Convert SRT file\r\ncaption2text convert path/to/your/file.srt\r\n\r\n# Specify output file\r\ncaption2text convert path/to/your/file.vtt -o output.txt\r\n```\r\n\r\n## Development\r\n\r\nTo set up the development environment:\r\n\r\n1. Clone the repository\r\n2. Create a virtual environment: `python -m venv venv`\r\n3. Activate the virtual environment:\r\n - On Windows: `venv\\Scripts\\activate`\r\n - On macOS and Linux: `source venv/bin/activate`\r\n4. Install development dependencies: `pip install -e .[dev]`\r\n\r\n### Running Tests\r\n\r\nTo run the tests, use the following command:\r\n\r\n```bash\r\npython -m unittest discover tests\r\n```\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n## Support\r\n\r\nIf you encounter any problems or have any questions, please open an issue on the GitHub repository.\r\n\r\n```\r\n\r\nThis updated README.md provides a more comprehensive overview of the project, including installation instructions, usage examples for both the Python API and command-line interface, development setup, testing instructions, license information, and contribution guidelines.\r\n\r\nYou can further customize this README by adding more specific details about your project, such as:\r\n\r\n1. Requirements or dependencies\r\n2. More detailed examples or use cases\r\n3. Troubleshooting section\r\n4. Changelog or version history\r\n5. Acknowledgements or credits\r\n\r\nLet me know if you'd like to make any changes or additions to this updated README.\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 BlueBirdBack \u2728 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": "A lightweight Python module to convert VTT and SRT caption files into plain text transcripts.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/BlueBirdBack/caption2text"
},
"split_keywords": [
"captions",
" subtitles",
" vtt",
" srt",
" transcript"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cb16418649a6ed191ba5a85c9962cd8cce4bcd7d9b368623e50d40fead720d9",
"md5": "f59ac6bf87215738a70cc90b4f3061a3",
"sha256": "b4c91e8fd08f688ed604d2f37541f9f2aa02107400a3973db740cd50ad07bbee"
},
"downloads": -1,
"filename": "caption2text-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f59ac6bf87215738a70cc90b4f3061a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6034,
"upload_time": "2024-09-24T06:08:22",
"upload_time_iso_8601": "2024-09-24T06:08:22.546617Z",
"url": "https://files.pythonhosted.org/packages/5c/b1/6418649a6ed191ba5a85c9962cd8cce4bcd7d9b368623e50d40fead720d9/caption2text-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a31de797f33db05958642aebe74bdeb182c0f2662a49696fc86df964e1e9d72",
"md5": "4cff613b4d50f638a67abef59236bd10",
"sha256": "37d00bea944b39808cd2bdb9577bf5a11a4f7b799f5ccc0279721433cc415cd9"
},
"downloads": -1,
"filename": "caption2text-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "4cff613b4d50f638a67abef59236bd10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5460,
"upload_time": "2024-09-24T06:08:24",
"upload_time_iso_8601": "2024-09-24T06:08:24.025680Z",
"url": "https://files.pythonhosted.org/packages/8a/31/de797f33db05958642aebe74bdeb182c0f2662a49696fc86df964e1e9d72/caption2text-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 06:08:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBirdBack",
"github_project": "caption2text",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "caption2text"
}
