Ege Akman
commited on
Update README.md (#1140)
Browse filesCorrect typos, improve clarity, engagement, and delivery.
README.md
CHANGED
@@ -9,42 +9,33 @@
|
|
9 |
</p>
|
10 |
</div>
|
11 |
|
12 |
-
### Actively soliciting
|
13 |
|
14 |
-
Have ideas for how pytube can be improved? Feel free to open an issue or a pull
|
15 |
-
request!
|
16 |
|
17 |
# pytube
|
18 |
|
19 |
-
*pytube* is a
|
20 |
-
command-line utility) for downloading YouTube Videos.
|
21 |
|
22 |
## Documentation
|
23 |
|
24 |
-
Detailed documentation about
|
25 |
-
[pytube.io](https://pytube.io). This is recommended
|
26 |
-
for most use cases. If you just want to quickly download a single video,
|
27 |
-
the [quickstart](#Quickstart) guide below might be what you're looking for.
|
28 |
|
29 |
## Description
|
30 |
|
31 |
-
YouTube is the most popular video-sharing platform in the world and as a hacker
|
32 |
-
you may encounter a situation where you want to script something to download
|
33 |
-
videos. For this I present to you *pytube*.
|
34 |
|
35 |
-
*pytube* is a lightweight library written in Python. It has no third
|
36 |
dependencies and aims to be highly reliable.
|
37 |
|
38 |
-
*pytube* also makes pipelining easy, allowing you to specify callback functions
|
39 |
-
for different download events, such as ``on progress`` or ``on complete``.
|
40 |
|
41 |
-
|
42 |
-
download videos right from terminal.
|
43 |
|
44 |
## Features
|
45 |
|
46 |
- Support for both progressive & DASH streams
|
47 |
-
- Support for downloading complete playlist
|
48 |
- Easily register ``on_download_progress`` & ``on_download_complete`` callbacks
|
49 |
- Command-line interfaced included
|
50 |
- Caption track support
|
@@ -55,33 +46,27 @@ download videos right from terminal.
|
|
55 |
|
56 |
## Quickstart
|
57 |
|
58 |
-
This guide
|
59 |
-
detailed information, please refer to [pytube.io](https://pytube.io).
|
60 |
|
61 |
### Installation
|
62 |
|
63 |
-
Pytube requires an installation of
|
64 |
-
Pip is typically bundled with python installations, and you can find options
|
65 |
-
for how to install python at https://python.org.
|
66 |
|
67 |
-
To install from
|
68 |
|
69 |
```bash
|
70 |
$ python -m pip install pytube
|
71 |
```
|
72 |
|
73 |
-
|
74 |
-
source with pip:
|
75 |
|
76 |
```bash
|
77 |
$ python -m pip install git+https://github.com/pytube/pytube
|
78 |
```
|
79 |
|
80 |
-
### Using pytube in a
|
81 |
|
82 |
-
To download a video using the library in a script, you'll need to
|
83 |
-
the YouTube class from the library, and pass it an argument of the video url.
|
84 |
-
From there, you can access the streams and download them.
|
85 |
|
86 |
```python
|
87 |
>>> from pytube import YouTube
|
@@ -97,8 +82,7 @@ From there, you can access the streams and download them.
|
|
97 |
|
98 |
### Using the command-line interface
|
99 |
|
100 |
-
Using the CLI is
|
101 |
-
highest progressive quality, you can use the following command:
|
102 |
```bash
|
103 |
$ pytube https://youtube.com/watch?v=2lAe1cqCOXo
|
104 |
```
|
@@ -107,4 +91,3 @@ You can also do the same for a playlist:
|
|
107 |
```bash
|
108 |
$ pytube https://www.youtube.com/playlist?list=PLS1QulWo1RIaJECMeUT4LFwJ-ghgoSH6n
|
109 |
```
|
110 |
-
|
|
|
9 |
</p>
|
10 |
</div>
|
11 |
|
12 |
+
### Actively soliciting contributors!
|
13 |
|
14 |
+
Have ideas for how pytube can be improved? Feel free to open an issue or a pull request!
|
|
|
15 |
|
16 |
# pytube
|
17 |
|
18 |
+
*pytube* is a genuine, lightweight, dependency-free Python library (and command-line utility) for downloading YouTube videos.
|
|
|
19 |
|
20 |
## Documentation
|
21 |
|
22 |
+
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.
|
|
|
|
|
|
|
23 |
|
24 |
## Description
|
25 |
|
26 |
+
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*.
|
|
|
|
|
27 |
|
28 |
+
*pytube* is a lightweight library written in Python. It has no third-party
|
29 |
dependencies and aims to be highly reliable.
|
30 |
|
31 |
+
*pytube* also makes pipelining easy, allowing you to specify callback functions for different download events, such as ``on progress`` or ``on complete``.
|
|
|
32 |
|
33 |
+
Furthermore, *pytube* includes a command-line utility, allowing you to download videos right from the terminal.
|
|
|
34 |
|
35 |
## Features
|
36 |
|
37 |
- Support for both progressive & DASH streams
|
38 |
+
- Support for downloading the complete playlist
|
39 |
- Easily register ``on_download_progress`` & ``on_download_complete`` callbacks
|
40 |
- Command-line interfaced included
|
41 |
- Caption track support
|
|
|
46 |
|
47 |
## Quickstart
|
48 |
|
49 |
+
This guide covers the most basic usage of the library. For more detailed information, please refer to [pytube.io](https://pytube.io).
|
|
|
50 |
|
51 |
### Installation
|
52 |
|
53 |
+
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).)
|
|
|
|
|
54 |
|
55 |
+
To install from PyPI with pip:
|
56 |
|
57 |
```bash
|
58 |
$ python -m pip install pytube
|
59 |
```
|
60 |
|
61 |
+
Sometimes, the PyPI release becomes slightly outdated. To install from the source with pip:
|
|
|
62 |
|
63 |
```bash
|
64 |
$ python -m pip install git+https://github.com/pytube/pytube
|
65 |
```
|
66 |
|
67 |
+
### Using pytube in a Python script
|
68 |
|
69 |
+
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.
|
|
|
|
|
70 |
|
71 |
```python
|
72 |
>>> from pytube import YouTube
|
|
|
82 |
|
83 |
### Using the command-line interface
|
84 |
|
85 |
+
Using the CLI is remarkably straightforward as well. To download a video at the highest progressive quality, you can use the following command:
|
|
|
86 |
```bash
|
87 |
$ pytube https://youtube.com/watch?v=2lAe1cqCOXo
|
88 |
```
|
|
|
91 |
```bash
|
92 |
$ pytube https://www.youtube.com/playlist?list=PLS1QulWo1RIaJECMeUT4LFwJ-ghgoSH6n
|
93 |
```
|
|