hbmartin commited on
Commit
8cddc3f
·
1 Parent(s): 9f7599d

cleanup documentation

Browse files
Files changed (2) hide show
  1. README.md +9 -13
  2. setup.py +4 -1
README.md CHANGED
@@ -13,17 +13,21 @@
13
 
14
  # pytube3
15
 
16
- *pytube* is a lightweight library written in Python. It has no third party dependencies and aims to be highly reliable.
17
 
18
- *pytube* also makes pipelining easy, allowing you to specify callback functions for different download events, such as ``on progress`` or ``on complete``.
19
 
20
- Finally *pytube* also includes a command-line utility, allowing you to quickly download videos right from terminal.
 
 
 
21
 
22
- ### Behold, a perfect balance of simplicity versus flexibility:
23
 
 
24
  ```python
25
  >>> from pytube import YouTube
26
  >>> YouTube('https://youtu.be/9bZkp7q19f0').streams.first().download()
 
27
  >>> yt = YouTube('http://youtube.com/watch?v=9bZkp7q19f0')
28
  >>> yt.streams
29
  ... .filter(progressive=True, file_extension='mp4')
@@ -44,16 +48,8 @@ Finally *pytube* also includes a command-line utility, allowing you to quickly d
44
  - Extensively Documented Source Code
45
  - No Third-Party Dependencies
46
 
47
- ## Installation
48
-
49
- Download using pip via pypi.
50
-
51
- ```bash
52
- $ pip install pytube3 --upgrade
53
- ```
54
- Mac/homebrew users may need to use ``pip3``
55
 
56
- ## Getting started
57
 
58
  Let's begin with showing how easy it is to download a video with pytube:
59
 
 
13
 
14
  # pytube3
15
 
16
+ ## Installation
17
 
18
+ Download using pip via pypi.
19
 
20
+ ```bash
21
+ $ pip install pytube3 --upgrade
22
+ ```
23
+ (Mac/homebrew users may need to use ``pip3``)
24
 
 
25
 
26
+ ## Quick start
27
  ```python
28
  >>> from pytube import YouTube
29
  >>> YouTube('https://youtu.be/9bZkp7q19f0').streams.first().download()
30
+ >>>
31
  >>> yt = YouTube('http://youtube.com/watch?v=9bZkp7q19f0')
32
  >>> yt.streams
33
  ... .filter(progressive=True, file_extension='mp4')
 
48
  - Extensively Documented Source Code
49
  - No Third-Party Dependencies
50
 
 
 
 
 
 
 
 
 
51
 
52
+ ## Usage
53
 
54
  Let's begin with showing how easy it is to download a video with pytube:
55
 
setup.py CHANGED
@@ -49,6 +49,9 @@ setup(
49
  long_description=long_description,
50
  zip_safe=True,
51
  python_requires=">=3.5",
52
- project_urls={"Bug Reports": "https://github.com/hbmartin/pytube3/issues",},
 
 
 
53
  keywords=["youtube", "download", "video", "stream",],
54
  )
 
49
  long_description=long_description,
50
  zip_safe=True,
51
  python_requires=">=3.5",
52
+ project_urls={
53
+ "Bug Reports": "https://github.com/hbmartin/pytube3/issues",
54
+ "Read the Docs": "https://pytube3.readthedocs.io/en/latest/?badge=latest",
55
+ },
56
  keywords=["youtube", "download", "video", "stream",],
57
  )