<div align="center">
<p>
<a href="#"><img src="https://assets.nickficano.com/gh-pytube.min.svg" width="456" height="143" alt="pytube logo" /></a>
</p>
<p align="center">
<a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/dm/pytube?style=flat-square" alt="pypi"/></a>
<a href="https://pytube.io/en/latest/"><img src="https://readthedocs.org/projects/python-pytube/badge/?version=latest&style=flat-square" /></a>
<a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/v/pytube?style=flat-square" /></a>
</p>
</div>
### Actively soliciting contributors!
Have ideas for how pytube can be improved? Feel free to open an issue or a pull request!
# pytube
*pytube* is a genuine, lightweight, dependency-free Python library (and command-line utility) for downloading YouTube videos.
## Documentation
Detailed documentation about the usage of the library can be found at [pytube.io](https://pytube.io). This is recommended for most cases. If you want to hastily download a single video, the [quick start](#Quickstart) guide below might be what you're looking for.
## Description
YouTube is the most popular video-sharing platform in the world and as a hacker, you may encounter a situation where you want to script something to download videos. For this, I present to you: *pytube*.
*pytube* is a lightweight library written in Python. It has no third-party
dependencies and aims to be highly reliable.
*pytube* also makes pipelining easy, allowing you to specify callback functions for different download events, such as ``on progress`` or ``on complete``.
Furthermore, *pytube* includes a command-line utility, allowing you to download videos right from the terminal.
## Features
- Support for both progressive & DASH streams
- Support for downloading the complete playlist
- Easily register ``on_download_progress`` & ``on_download_complete`` callbacks
- Command-line interfaced included
- Caption track support
- Outputs caption tracks to .srt format (SubRip Subtitle)
- Ability to capture thumbnail URL
- Extensively documented source code
- No third-party dependencies
## Quickstart
This guide covers the most basic usage of the library. For more detailed information, please refer to [pytube.io](https://pytube.io).
### Installation
Pytube requires an installation of Python 3.6 or greater, as well as pip. (Pip is typically bundled with Python [installations](https://python.org/downloads).)
To install from PyPI with pip:
```bash
$ python -m pip install pytube
```
Sometimes, the PyPI release becomes slightly outdated. To install from the source with pip:
```bash
$ python -m pip install git+https://github.com/pytube/pytube
```
### Using pytube in a Python script
To download a video using the library in a script, you'll need to import the YouTube class from the library and pass an argument of the video URL. From there, you can access the streams and download them.
```python
>>> from pytube import YouTube
>>> YouTube('https://youtu.be/2lAe1cqCOXo').streams.first().download()
>>> yt = YouTube('http://youtube.com/watch?v=2lAe1cqCOXo')
>>> yt.streams
... .filter(progressive=True, file_extension='mp4')
... .order_by('resolution')
... .desc()
... .first()
... .download()
```
### Using the command-line interface
Using the CLI is remarkably straightforward as well. To download a video at the highest progressive quality, you can use the following command:
```bash
$ pytube https://youtube.com/watch?v=2lAe1cqCOXo
```
You can also do the same for a playlist:
```bash
$ pytube https://www.youtube.com/playlist?list=PLS1QulWo1RIaJECMeUT4LFwJ-ghgoSH6n
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pytube-for-sim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "youtube, download, video, stream",
"author": "Hang Seob Sim",
"author_email": "simhs93@naver.com",
"download_url": "https://files.pythonhosted.org/packages/fa/7b/e665a3f62ad6ac863a3df2fc0c39bc609ec62ba82665d1075c815a3288f8/pytube_for_sim-0.0.1.tar.gz",
"platform": null,
"description": "\r\n<div align=\"center\">\r\n\r\n <p>\r\n\r\n <a href=\"#\"><img src=\"https://assets.nickficano.com/gh-pytube.min.svg\" width=\"456\" height=\"143\" alt=\"pytube logo\" /></a>\r\n\r\n </p>\r\n\r\n <p align=\"center\">\r\n\r\n\t<a href=\"https://pypi.org/project/pytube/\"><img src=\"https://img.shields.io/pypi/dm/pytube?style=flat-square\" alt=\"pypi\"/></a>\r\n\r\n\t<a href=\"https://pytube.io/en/latest/\"><img src=\"https://readthedocs.org/projects/python-pytube/badge/?version=latest&style=flat-square\" /></a>\r\n\r\n\t<a href=\"https://pypi.org/project/pytube/\"><img src=\"https://img.shields.io/pypi/v/pytube?style=flat-square\" /></a>\r\n\r\n </p>\r\n\r\n</div>\r\n\r\n\r\n\r\n### Actively soliciting contributors!\r\n\r\n\r\n\r\nHave ideas for how pytube can be improved? Feel free to open an issue or a pull request!\r\n\r\n\r\n\r\n# pytube\r\n\r\n\r\n\r\n*pytube* is a genuine, lightweight, dependency-free Python library (and command-line utility) for downloading YouTube videos.\r\n\r\n\r\n\r\n## Documentation\r\n\r\n\r\n\r\nDetailed documentation about the usage of the library can be found at [pytube.io](https://pytube.io). This is recommended for most cases. If you want to hastily download a single video, the [quick start](#Quickstart) guide below might be what you're looking for.\r\n\r\n\r\n\r\n## Description\r\n\r\n\r\n\r\nYouTube is the most popular video-sharing platform in the world and as a hacker, you may encounter a situation where you want to script something to download videos. For this, I present to you: *pytube*.\r\n\r\n\r\n\r\n*pytube* is a lightweight library written in Python. It has no third-party\r\n\r\ndependencies and aims to be highly reliable.\r\n\r\n\r\n\r\n*pytube* also makes pipelining easy, allowing you to specify callback functions for different download events, such as ``on progress`` or ``on complete``.\r\n\r\n\r\n\r\nFurthermore, *pytube* includes a command-line utility, allowing you to download videos right from the terminal.\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\n- Support for both progressive & DASH streams\r\n\r\n- Support for downloading the complete playlist\r\n\r\n- Easily register ``on_download_progress`` & ``on_download_complete`` callbacks\r\n\r\n- Command-line interfaced included\r\n\r\n- Caption track support\r\n\r\n- Outputs caption tracks to .srt format (SubRip Subtitle)\r\n\r\n- Ability to capture thumbnail URL\r\n\r\n- Extensively documented source code\r\n\r\n- No third-party dependencies\r\n\r\n\r\n\r\n## Quickstart\r\n\r\n\r\n\r\nThis guide covers the most basic usage of the library. For more detailed information, please refer to [pytube.io](https://pytube.io).\r\n\r\n\r\n\r\n### Installation\r\n\r\n\r\n\r\nPytube requires an installation of Python 3.6 or greater, as well as pip. (Pip is typically bundled with Python [installations](https://python.org/downloads).)\r\n\r\n\r\n\r\nTo install from PyPI with pip:\r\n\r\n\r\n\r\n```bash\r\n\r\n$ python -m pip install pytube\r\n\r\n```\r\n\r\n\r\n\r\nSometimes, the PyPI release becomes slightly outdated. To install from the source with pip:\r\n\r\n\r\n\r\n```bash\r\n\r\n$ python -m pip install git+https://github.com/pytube/pytube\r\n\r\n```\r\n\r\n\r\n\r\n### Using pytube in a Python script\r\n\r\n\r\n\r\nTo download a video using the library in a script, you'll need to import the YouTube class from the library and pass an argument of the video URL. From there, you can access the streams and download them.\r\n\r\n\r\n\r\n```python\r\n\r\n >>> from pytube import YouTube\r\n\r\n >>> YouTube('https://youtu.be/2lAe1cqCOXo').streams.first().download()\r\n\r\n >>> yt = YouTube('http://youtube.com/watch?v=2lAe1cqCOXo')\r\n\r\n >>> yt.streams\r\n\r\n ... .filter(progressive=True, file_extension='mp4')\r\n\r\n ... .order_by('resolution')\r\n\r\n ... .desc()\r\n\r\n ... .first()\r\n\r\n ... .download()\r\n\r\n```\r\n\r\n\r\n\r\n### Using the command-line interface\r\n\r\n\r\n\r\nUsing the CLI is remarkably straightforward as well. To download a video at the highest progressive quality, you can use the following command:\r\n\r\n```bash\r\n\r\n$ pytube https://youtube.com/watch?v=2lAe1cqCOXo\r\n\r\n```\r\n\r\n\r\n\r\nYou can also do the same for a playlist:\r\n\r\n```bash\r\n\r\n$ pytube https://www.youtube.com/playlist?list=PLS1QulWo1RIaJECMeUT4LFwJ-ghgoSH6n\r\n\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": "The Unlicense (Unlicense)",
"summary": "Python 3 library for downloading YouTube Videos.",
"version": "0.0.1",
"project_urls": {
"Bug Reports": "https://github.com/pytube/pytube/issues",
"Read the Docs": "https://pytube.io"
},
"split_keywords": [
"youtube",
" download",
" video",
" stream"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "febb3a7d1718ba6ef89d9b0feda870e7b15780504a4bd442404b53bc399c6f50",
"md5": "d8b3c3d95073a99683027e8f1ee6d4cc",
"sha256": "5aaa59d67e238bda9ac805f25fa64f57a4e1db8a644c71c7e482a44e6e09a27a"
},
"downloads": -1,
"filename": "pytube_for_sim-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8b3c3d95073a99683027e8f1ee6d4cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 58121,
"upload_time": "2024-07-13T03:17:41",
"upload_time_iso_8601": "2024-07-13T03:17:41.591757Z",
"url": "https://files.pythonhosted.org/packages/fe/bb/3a7d1718ba6ef89d9b0feda870e7b15780504a4bd442404b53bc399c6f50/pytube_for_sim-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa7be665a3f62ad6ac863a3df2fc0c39bc609ec62ba82665d1075c815a3288f8",
"md5": "26c85904a9ac0a3cbedbedd0037cd5fb",
"sha256": "38a313efe8c0d27d0f5c2328ae726f32ac232b4ff4567feebff1fde7aa0c8a26"
},
"downloads": -1,
"filename": "pytube_for_sim-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "26c85904a9ac0a3cbedbedd0037cd5fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 69363,
"upload_time": "2024-07-13T03:17:43",
"upload_time_iso_8601": "2024-07-13T03:17:43.712712Z",
"url": "https://files.pythonhosted.org/packages/fa/7b/e665a3f62ad6ac863a3df2fc0c39bc609ec62ba82665d1075c815a3288f8/pytube_for_sim-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 03:17:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pytube",
"github_project": "pytube",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytube-for-sim"
}
JSON
