[](https://badge.fury.io/py/tube_scriptor)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/tube_scriptor)
# Tube Scriptor
`tube_scriptor` is a Python package designed to fetch and generate transcripts from YouTube videos in various formats including XML, JSON, Python lists, or plain text. It simplifies the process of obtaining video transcripts, making it accessible for data analysis, content generation, and accessibility features.
## Installation
To install `tube_scriptor`, you can use pip:
```bash
pip install tube_scriptor
```
## Usage
Using `tube_scriptor` is straightforward. Below are examples demonstrating how to fetch a video transcript in various formats and using both a YouTube URL and a direct video ID.
### Fetching Transcript as a List
```python
from tube_scriptor import fetch_transcript
# Using a YouTube URL
youtube_url = "https://www.youtube.com/watch?v=exampleVideoId"
transcript_list = fetch_transcript(youtube_url, 'list')
print(transcript_list)
# Using a YouTube video ID
youtube_id = "exampleVideoId"
transcript_list = fetch_transcript(youtube_id, 'list')
print(transcript_list)
```
### Fetching Transcript as a JSON String
```python
# Using a YouTube video ID
youtube_id = "exampleVideoId"
transcript_json = fetch_transcript(youtube_id, 'json')
print(transcript_json)
```
### Fetching Transcript as Plain Text
```python
# Using a YouTube video ID
youtube_id = "exampleVideoId"
transcript_text = fetch_transcript(youtube_id, 'string')
print(transcript_text)
```
### Fetching Transcript as XML
```python
# Using a YouTube video ID
youtube_id = "exampleVideoId"
transcript_xml = fetch_transcript(youtube_id, 'xml')
print(transcript_xml)
```
These examples illustrate the flexibility of `tube_scriptor` in handling different formats and inputs. Choose the format that best suits your needs, whether it's for further processing, display, or storage.
## Features
- Support for fetching transcripts in XML, JSON, Python list, or plain string format.
- Easy integration into Python projects.
- Flexible input with support for both YouTube video URLs and video IDs.
- Lightweight with minimal dependencies.
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/tube_scriptor/issues).
## License
This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/tube_scriptor",
"name": "tube-scriptor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/47/7e/5d122d82a9f3b8b73646a109984b356bd7125a9c9965f71f74c1c54824cc/tube_scriptor-0.1.1.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/tube_scriptor)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/tube_scriptor)\n\n# Tube Scriptor\n\n`tube_scriptor` is a Python package designed to fetch and generate transcripts from YouTube videos in various formats including XML, JSON, Python lists, or plain text. It simplifies the process of obtaining video transcripts, making it accessible for data analysis, content generation, and accessibility features.\n\n## Installation\n\nTo install `tube_scriptor`, you can use pip:\n\n```bash\npip install tube_scriptor\n```\n\n## Usage\n\nUsing `tube_scriptor` is straightforward. Below are examples demonstrating how to fetch a video transcript in various formats and using both a YouTube URL and a direct video ID.\n\n### Fetching Transcript as a List\n\n```python\nfrom tube_scriptor import fetch_transcript\n\n# Using a YouTube URL\nyoutube_url = \"https://www.youtube.com/watch?v=exampleVideoId\"\ntranscript_list = fetch_transcript(youtube_url, 'list')\nprint(transcript_list)\n\n# Using a YouTube video ID\nyoutube_id = \"exampleVideoId\"\ntranscript_list = fetch_transcript(youtube_id, 'list')\nprint(transcript_list)\n```\n\n### Fetching Transcript as a JSON String\n\n```python\n# Using a YouTube video ID\nyoutube_id = \"exampleVideoId\"\ntranscript_json = fetch_transcript(youtube_id, 'json')\nprint(transcript_json)\n```\n\n### Fetching Transcript as Plain Text\n\n```python\n# Using a YouTube video ID\nyoutube_id = \"exampleVideoId\"\ntranscript_text = fetch_transcript(youtube_id, 'string')\nprint(transcript_text)\n```\n\n### Fetching Transcript as XML\n\n```python\n# Using a YouTube video ID\nyoutube_id = \"exampleVideoId\"\ntranscript_xml = fetch_transcript(youtube_id, 'xml')\nprint(transcript_xml)\n```\n\nThese examples illustrate the flexibility of `tube_scriptor` in handling different formats and inputs. Choose the format that best suits your needs, whether it's for further processing, display, or storage.\n\n## Features\n\n- Support for fetching transcripts in XML, JSON, Python list, or plain string format.\n- Easy integration into Python projects.\n- Flexible input with support for both YouTube video URLs and video IDs.\n- Lightweight with minimal dependencies.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/tube_scriptor/issues).\n\n## License\n\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for generating transcripts from YouTube videos in various formats",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/chigwell/tube_scriptor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbc81f48a43d461ccc32ccd1de3610a1f12a5dfa89aa183af9e14bbacf853489",
"md5": "249c753ffe9b9a4f3d4b8afa266cce47",
"sha256": "748c74906cc016206cf64d40bb24c402478e297194e171852ad77ee31c17f7bd"
},
"downloads": -1,
"filename": "tube_scriptor-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "249c753ffe9b9a4f3d4b8afa266cce47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4994,
"upload_time": "2024-04-01T12:19:37",
"upload_time_iso_8601": "2024-04-01T12:19:37.934003Z",
"url": "https://files.pythonhosted.org/packages/fb/c8/1f48a43d461ccc32ccd1de3610a1f12a5dfa89aa183af9e14bbacf853489/tube_scriptor-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "477e5d122d82a9f3b8b73646a109984b356bd7125a9c9965f71f74c1c54824cc",
"md5": "d96d96422b3288c82fc57986302af2f3",
"sha256": "b25abb0522c9adc0dabae41210a2a1763ce7303dc4fc983b601b45f24eedba39"
},
"downloads": -1,
"filename": "tube_scriptor-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d96d96422b3288c82fc57986302af2f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4312,
"upload_time": "2024-04-01T12:19:39",
"upload_time_iso_8601": "2024-04-01T12:19:39.678294Z",
"url": "https://files.pythonhosted.org/packages/47/7e/5d122d82a9f3b8b73646a109984b356bd7125a9c9965f71f74c1c54824cc/tube_scriptor-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 12:19:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "tube_scriptor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tube-scriptor"
}
JSON
