documentation

.gitignore

@@ -31,3 +31,8 @@ doc/aws_hostname.1
 .cache
 _run.py
 _devfiles/*
+
+_build
+_static
+_templates
+_autosummary

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = pytube
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,66 @@
+.. _api:
+
+API
+===
+
+.. module:: pytube
+
+
+YouTube Object
+--------------
+
+.. autoclass:: YouTube
+   :members:
+   :inherited-members:
+
+Stream Object
+-------------
+
+.. autoclass:: pytube.Stream
+   :members:
+   :inherited-members:
+
+StreamQuery Object
+------------------
+
+.. autoclass:: pytube.query.StreamQuery
+   :members:
+   :inherited-members:
+
+Extract
+-------
+
+.. automodule:: pytube.extract
+    :members:
+
+Cipher
+------
+
+.. automodule:: pytube.cipher
+    :members:
+
+Exceptions
+----------
+
+.. automodule:: pytube.exceptions
+    :members:
+
+Mixins
+------
+
+.. automodule:: pytube.mixins
+    :members:
+
+
+Helpers
+-------
+
+.. automodule:: pytube.helpers
+    :members:
+
+
+Request
+-------
+
+.. automodule:: pytube.request
+    :members:

docs/conf.py

@@ -0,0 +1,185 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# pytube documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct  9 02:11:41 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import os
+import sys
+
+import sphinx_rtd_theme
+
+sys.path.insert(0, os.path.abspath('../'))
+# -- General configuration ------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.todo',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+]
+
+autosummary_generate = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'pytube'
+copyright = '2017, Nick Ficano'
+author = 'Nick Ficano'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '7.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '7.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+}
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ],
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pytubedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc, 'pytube.tex', 'pytube Documentation',
+        'Nick Ficano', 'manual',
+    ),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc, 'pytube', 'pytube Documentation',
+        [author], 1,
+    ),
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc, 'pytube', 'pytube Documentation',
+        author, 'pytube', 'One line description of project.',
+        'Miscellaneous',
+    ),
+]

docs/index.rst

@@ -0,0 +1,40 @@
+.. pytube documentation master file, created by
+   sphinx-quickstart on Mon Oct  9 02:11:41 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pytube
+=================
+
+pytube is a lightweight, dependency-free Python library (and command-line utility) for downloading YouTube Videos.
+
+Installation
+------------
+
+.. code-block:: bash
+
+   pip install pytube
+
+Getting started
+---------------
+
+Coming soon.
+
+API Reference
+-------------
+
+If you are looking for information on a specific function, class or
+method, this part of the documentation is for you.
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pytube/cipher.py

@@ -53,15 +53,17 @@ def get_transform_plan(js):
         The contents of the base.js asset file.
 
     Sample Output:
-    ~~~~~~~~~~~~~~
-    ['DE.AJ(a,15)',
-     'DE.VR(a,3)',
-     'DE.AJ(a,51)',
-     'DE.VR(a,3)',
-     'DE.kT(a,51)',
-     'DE.kT(a,8)',
-     'DE.VR(a,3)',
-     'DE.kT(a,21)']
+
+    .. code-block:: python
+
+       ['DE.AJ(a,15)',
+       'DE.VR(a,3)',
+       'DE.AJ(a,51)',
+       'DE.VR(a,3)',
+       'DE.kT(a,51)',
+       'DE.kT(a,8)',
+       'DE.VR(a,3)',
+       'DE.kT(a,21)']
 
     """
     name = re.escape(get_initial_function_name(js))
@@ -85,10 +87,12 @@ def get_transform_object(js, var):
         that descrambles the signature.
 
     Sample Output:
-    ~~~~~~~~~~~~~~
-    ['AJ:function(a){a.reverse()}',
-     'VR:function(a,b){a.splice(0,b)}',
-     'kT:function(a,b){var c=a[0];a[0]=a[b%a.length];a[b]=c}']
+
+    .. code-block:: python
+
+       ['AJ:function(a){a.reverse()}',
+        'VR:function(a,b){a.splice(0,b)}',
+        'kT:function(a,b){var c=a[0];a[0]=a[b%a.length];a[b]=c}']
 
     """
     pattern = r'var %s={(.*?)};' % re.escape(var)
@@ -127,7 +131,11 @@ def get_transform_map(js, var):
 def reverse(arr, b):
     """Reverse elements in a list.
 
-    This function is equivalent to: function(a, b) { a.reverse() }.
+    This function is equivalent to:
+
+    .. code-block:: javascript
+
+       function(a, b) { a.reverse() }.
 
     This method takes an unused ``b`` variable as their transform functions
     universally sent two arguments.
@@ -143,7 +151,11 @@ def reverse(arr, b):
 def splice(arr, b):
     """Add/remove items to/from a list.
 
-    This function is equivalent to: function(a, b) { a.splice(0, b) }.
+    This function is equivalent to:
+
+    .. code-block:: javascript
+
+       function(a, b) { a.splice(0, b) }.
 
     Example usage:
     ~~~~~~~~~~~~~~
@@ -157,7 +169,10 @@ def swap(arr, b):
     """Swap positions at b modulus the list length.
 
     This function is equivalent to:
-    function(a, b) { var c=a[0];a[0]=a[b%a.length];a[b]=c }.
+
+    .. code-block:: javascript
+
+       function(a, b) { var c=a[0];a[0]=a[b%a.length];a[b]=c }.
 
     Example usage:
     ~~~~~~~~~~~~~~
@@ -199,13 +214,17 @@ def parse_function(js_func):
     Break a JavaScript transform function down into a two element tuple
     containing the function name and some integer-based argument.
 
-    Sample Input:
-    ~~~~~~~~~~~~~
-    DE.AJ(a,15)
+    Sample input:
+
+    .. code-block:: javascript
+
+       DE.AJ(a,15)
 
     Sample Output:
-    ~~~~~~~~~~~~~~
-    ('AJ', 15)
+
+    .. code-block:: python
+
+       ('AJ', 15)
 
     :param str js_func:
         The JavaScript version of the transform function.

pytube/request.py

@@ -41,7 +41,7 @@ def get(
 
 
 def stream_response(response, chunk_size=8 * 1024):
-    """Read the :module:`urlopen` response in chunks."""
+    """Read the response in chunks."""
     while True:
         buf = response.read(chunk_size)
         if not buf:

tests/requirements.txt

@@ -6,3 +6,5 @@ pre-commit==0.15.0
 pytest==3.1.3
 pytest-cov==2.4.0
 pytest-sugar==0.9.0
+sphinx==1.6.4
+sphinx-rtd-theme==0.2.4