updated docs
Browse files- docs/index.rst +17 -0
- docs/user/install.rst +29 -0
docs/index.rst
CHANGED
@@ -42,10 +42,27 @@ Release v\ |version|. (:ref:`Installation <install>`)
|
|
42 |
... .first()
|
43 |
... .download()
|
44 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
45 |
The User Guide
|
46 |
--------------
|
47 |
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.
|
48 |
|
|
|
|
|
|
|
|
|
|
|
49 |
The API Documentation / Guide
|
50 |
-----------------------------
|
51 |
|
|
|
42 |
... .first()
|
43 |
... .download()
|
44 |
|
45 |
+
Features
|
46 |
+
--------
|
47 |
+
|
48 |
+
- Support for Both Progressive & DASH Streams
|
49 |
+
- Easily Register ``on_download_progress`` & ``on_download_complete`` callbacks
|
50 |
+
- Command-line Interfaced Included
|
51 |
+
- Caption Track Support
|
52 |
+
- Outputs Caption Tracks to SRT format (SubRip Subtitle)
|
53 |
+
- Ability to Capture Thumbnail URL.
|
54 |
+
- Extensively Documented Source Code
|
55 |
+
- No Third-Party Dependencies
|
56 |
+
|
57 |
The User Guide
|
58 |
--------------
|
59 |
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.
|
60 |
|
61 |
+
.. toctree::
|
62 |
+
:maxdepth: 2
|
63 |
+
|
64 |
+
user/install
|
65 |
+
|
66 |
The API Documentation / Guide
|
67 |
-----------------------------
|
68 |
|
docs/user/install.rst
ADDED
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
.. _install:
|
2 |
+
|
3 |
+
Installation of pytube
|
4 |
+
======================
|
5 |
+
|
6 |
+
This part of the documentation covers the installation of pytube.
|
7 |
+
|
8 |
+
To install pytube, run the following command in your terminal::
|
9 |
+
|
10 |
+
$ pip install pytube
|
11 |
+
|
12 |
+
Get the Source Code
|
13 |
+
-------------------
|
14 |
+
|
15 |
+
pytube is actively developed on GitHub, where the source is `available <https://github.com/nficano/pytube>`_.
|
16 |
+
|
17 |
+
You can either clone the public repository::
|
18 |
+
|
19 |
+
$ git clone git://github.com/nficano/pytube.git
|
20 |
+
|
21 |
+
Or, download the `tarball <https://github.com/nficano/pytube/tarball/master>`_::
|
22 |
+
|
23 |
+
$ curl -OL https://github.com/nficano/pytube/tarball/master
|
24 |
+
# optionally, zipball is also available (for Windows users).
|
25 |
+
|
26 |
+
Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages by running::
|
27 |
+
|
28 |
+
$ cd pytube
|
29 |
+
$ pip install .
|