nficano commited on
Commit
12d8cde
·
1 Parent(s): 6513d40

updated readme + docs

Browse files
Files changed (2) hide show
  1. README.rst +4 -4
  2. docs/index.rst +35 -14
README.rst CHANGED
@@ -10,14 +10,14 @@ pytube
10
  :alt: Build status
11
  :target: https://travis-ci.org/nficano/pytube
12
 
13
- .. image:: https://coveralls.io/repos/nficano/pytube/badge.svg?branch=master&service=github
14
- :alt: Coverage
15
- :target: https://coveralls.io/github/nficano/pytube?branch=master
16
-
17
  .. image:: https://readthedocs.org/projects/python-pytube/badge/?version=latest
18
  :target: http://python-pytube.readthedocs.io/en/latest/?badge=latest
19
  :alt: Documentation Status
20
 
 
 
 
 
21
  *pytube* is a lightweight, dependency-free Python library (and command-line utility) for downloading YouTube Videos.
22
 
23
  Description
 
10
  :alt: Build status
11
  :target: https://travis-ci.org/nficano/pytube
12
 
 
 
 
 
13
  .. image:: https://readthedocs.org/projects/python-pytube/badge/?version=latest
14
  :target: http://python-pytube.readthedocs.io/en/latest/?badge=latest
15
  :alt: Documentation Status
16
 
17
+ .. image:: https://coveralls.io/repos/nficano/pytube/badge.svg?branch=master&service=github
18
+ :alt: Coverage
19
+ :target: https://coveralls.io/github/nficano/pytube?branch=master
20
+
21
  *pytube* is a lightweight, dependency-free Python library (and command-line utility) for downloading YouTube Videos.
22
 
23
  Description
docs/index.rst CHANGED
@@ -3,28 +3,49 @@
3
  You can adapt this file completely to your liking, but it should at least
4
  contain the root `toctree` directive.
5
 
6
- Welcome to pytube
7
- =================
 
8
 
9
- pytube is a lightweight, dependency-free Python library (and command-line utility) for downloading YouTube Videos.
 
 
10
 
11
- Installation
12
- ------------
 
13
 
14
- .. code-block:: bash
 
 
15
 
16
- pip install pytube
 
 
17
 
18
- Getting started
19
- ---------------
20
 
21
- Coming soon.
22
 
23
- API Reference
24
- -------------
25
 
26
- If you are looking for information on a specific function, class or
27
- method, this part of the documentation is for you.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
  .. toctree::
30
  :maxdepth: 2
 
3
  You can adapt this file completely to your liking, but it should at least
4
  contain the root `toctree` directive.
5
 
6
+ pytube
7
+ ======
8
+ Release v\ |version|. (:ref:`Installation <install>`)
9
 
10
+ .. image:: https://img.shields.io/pypi/v/pytube.svg
11
+ :alt: Pypi
12
+ :target: https://pypi.python.org/pypi/pytube/
13
 
14
+ .. image:: https://travis-ci.org/nficano/pytube.svg?branch=master
15
+ :alt: Build status
16
+ :target: https://travis-ci.org/nficano/pytube
17
 
18
+ .. image:: https://readthedocs.org/projects/python-pytube/badge/?version=latest
19
+ :target: http://python-pytube.readthedocs.io/en/latest/?badge=latest
20
+ :alt: Documentation Status
21
 
22
+ .. image:: https://coveralls.io/repos/nficano/pytube/badge.svg?branch=master&service=github
23
+ :alt: Coverage
24
+ :target: https://coveralls.io/github/nficano/pytube?branch=master
25
 
26
+ **pytube** is a lightweight, Pythonic, dependency-free, library (and command-line utility) for downloading YouTube Videos.
 
27
 
28
+ -------------------
29
 
30
+ **Behold, the balance of simplicity versus flexibility of pytube**::
 
31
 
32
+ >>> YouTube('http://youtube.com/watch?v=9bZkp7q19f0').streams.first().download()
33
+ >>> yt = YouTube('http://youtube.com/watch?v=9bZkp7q19f0')
34
+ >>> yt.streams
35
+ .filter(progressive=True, subtype='mp4')
36
+ .order_by('resolution')
37
+ .desc()
38
+ .first()
39
+ .download()
40
+
41
+ The User Guide
42
+ --------------
43
+ This part of the documentation begins with some background information about the project, then focuses on step-by-step instructions for getting the most out of pytube.
44
+
45
+ The API Documentation / Guide
46
+ -----------------------------
47
+
48
+ If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
49
 
50
  .. toctree::
51
  :maxdepth: 2