From 93af278d6170cb38eeb189fe8deb957b98d20876 Mon Sep 17 00:00:00 2001 From: Christopher Rosell Date: Fri, 24 Aug 2012 02:28:42 +0200 Subject: Add some docs. --- .gitignore | 2 + docs/Makefile | 153 ++++++++++++++++++++++ docs/conf.py | 243 +++++++++++++++++++++++++++++++++++ docs/index.rst | 95 ++++++++++++++ src/livestreamer/__init__.py | 27 ++++ src/livestreamer/plugins/__init__.py | 14 ++ src/livestreamer/stream.py | 12 +- 7 files changed, 545 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/.gitignore b/.gitignore index 13609a5..e180bf3 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,5 @@ dist *.pyc *.pyo *.tmp* +*.swp +docs/_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..7a0b70d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/livestreamer.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/livestreamer.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/livestreamer" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/livestreamer" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..1853098 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,243 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# livestreamer documentation build configuration file, created by +# sphinx-quickstart on Fri Aug 24 00:12:10 2012. +# +# 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. + +import sys, os + +# 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. +#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'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'livestreamer' +copyright = '2012, Christopher Rosell' + +# 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 = '1.2.0' +# The full version, including alpha/beta/rc tags. +release = '1.2.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- 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 = 'default' + +# 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 themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'livestreamerdoc' + + +# -- 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': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'livestreamer.tex', 'livestreamer Documentation', + 'Christopher Rosell', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'livestreamer', 'livestreamer Documentation', + ['Christopher Rosell'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- 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 = [ + ('index', 'livestreamer', 'livestreamer Documentation', + 'Christopher Rosell', 'livestreamer', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..1797f76 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,95 @@ +.. livestreamer documentation master file, created by + sphinx-quickstart on Fri Aug 24 00:12:10 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +livestreamer documentation +================================== + +Livestreamer is a library that can be used to retrieve information and stream data from +various livestreaming services, such as Twitch, Own3D or UStream. + + +.. automodule:: livestreamer + +Exceptions +---------- + +The :mod:`livstreamer` module defines four exceptions: + +.. exception:: PluginError + + Common base class for the plugin related exceptions. It inherits + :exc:`Exception`. + +.. exception:: NoStreamsError + + This exception is triggered when no streams can be found by a plugin. + It inherits :exc:`PluginError`. + +.. exception:: NoPluginError + + This exception is triggered when no plugin can found when calling :meth:`Livestreamer.resolve_url`. + It inherits :exc:`PluginError`. + +.. exception:: StreamError + + Common base class for stream related exceptions. It inherits + :exc:`Exception`. + +The livestreamer session +------------------------ +.. autoclass:: Livestreamer + :members: + +.. automodule:: livestreamer.plugins + +Plugins +------- +.. autoclass:: Plugin + :members: + +.. automodule:: livestreamer.stream + + +Streams +------- +.. autoclass:: Stream + :members: + + +Examples +-------- + +Fetching a streams data:: + + from livestreamer import Livestreamer + + url = "http://twitch.tv/day9tv" + livestreamer = Livestreamer() + channel = livestreamer.resolve_url(url) + streams = channel.get_streams() + + stream = streams["720p"] + fd = stream.open() + + while True: + data = fd.read(1024) + if len(data) == 0: + break + + # do something with data + + fd.close() + + + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/src/livestreamer/__init__.py b/src/livestreamer/__init__.py index f554fb6..0f50dea 100644 --- a/src/livestreamer/__init__.py +++ b/src/livestreamer/__init__.py @@ -9,6 +9,11 @@ import pkgutil import imp class Livestreamer(object): + """ + A Livestreamer session is used to keep track of plugins, options, log settings. + + """ + def __init__(self): self.options = Options({ "rtmpdump": None, @@ -19,28 +24,44 @@ class Livestreamer(object): self.load_builtin_plugins() def set_option(self, key, value): + """Set option *key* to *value*.""" self.options.set(key, value) def get_option(self, key): + """Return option *key*""" return self.options.get(key) def set_plugin_option(self, plugin, key, value): + """Set plugin option *key* to *value* for the plugin *plugin*.""" if plugin in self.plugins: plugin = self.plugins[plugin] plugin.set_option(key, value) def get_plugin_option(self, plugin, key): + """Return plugin option *key* for the plugin *plugin*.""" if plugin in self.plugins: plugin = self.plugins[plugin] return plugin.get_option(key) def set_loglevel(self, level): + """ + Set the log level to *level*. + Valid levels are: none, error, warning, info, debug. + """ self.logger.set_level(level) def set_logoutput(self, output): + """ + Set the log output to *output*. Expects a file like + object with a write method. + """ self.logger.set_output(output) def resolve_url(self, url): + """ + Attempt to find the correct plugin for *url* and return it. + Raises :exc:`NoPluginError` on failure. + """ parsed = urlparse(url) if len(parsed.scheme) == 0: @@ -54,6 +75,9 @@ class Livestreamer(object): raise NoPluginError def get_plugins(self): + """ + Returns the loaded plugins for the session. + """ return self.plugins def load_builtin_plugins(self): @@ -62,6 +86,9 @@ class Livestreamer(object): self.load_plugin(name, file, pathname, desc) def load_plugins(self, path): + """ + Attempt to load plugins from the *path* directory. + """ for loader, name, ispkg in pkgutil.iter_modules(path): file, pathname, desc = imp.find_module(name, path) self.load_plugin(name, file, pathname, desc) diff --git a/src/livestreamer/plugins/__init__.py b/src/livestreamer/plugins/__init__.py index 4c70fdc..ad96f6c 100644 --- a/src/livestreamer/plugins/__init__.py +++ b/src/livestreamer/plugins/__init__.py @@ -1,6 +1,10 @@ from livestreamer.options import Options class Plugin(object): + """ + A plugin can retrieve stream information from the *url* specified. + """ + options = Options() def __init__(self, url): @@ -20,6 +24,16 @@ class Plugin(object): return cls.options.get(key) def get_streams(self): + """ + Retrieves and returns a :class:`dict` containing the streams. + + The key is the name of the stream, most commonly the quality. + The value is a :class:`Stream` object. + + The stream with key *best* is a reference to the stream most likely + to be of highest quality. + """ + ranking = ["iphonelow", "iphonehigh", "240p", "320k", "360p", "850k", "480p", "1400k", "720p", "2400k", "hd", "1080p", "live"] streams = self._get_streams() diff --git a/src/livestreamer/stream.py b/src/livestreamer/stream.py index 398bb6f..e71e3bc 100644 --- a/src/livestreamer/stream.py +++ b/src/livestreamer/stream.py @@ -10,11 +10,21 @@ class StreamError(Exception): pass class Stream(object): + """ + This is a base class that should be inherited when implementing + different stream types. Should only be used directly from plugins. + """ + def __init__(self, session): self.session = session def open(self): - raise NotImplementedError + """ + Opens a connection to the stream. + Returns a file-like object than can be used to read data. + Raises :exc:`StreamError` on failure. + """ + raise NotImplementedError class StreamProcess(Stream): def __init__(self, session, params={}): -- cgit v1.2.3