diff --git a/.gitignore b/.gitignore index ac69f35..46ce87e 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,6 @@ htmlcov # virtual environment venv + +# docs +docs/_build* diff --git a/.travis.yml b/.travis.yml index 3da10f9..eed39d5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,7 @@ env: - TOX_ENV=py27 - TOX_ENV=py34 - TOX_ENV=flake8 + - TOX_ENV=docs matrix: include: - python: 3.5 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..bf31a25 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# 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 coverage 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 " applehelp to make an Apple Help Book" + @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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @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 " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of 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/python-twitch.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-twitch.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/python-twitch" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-twitch" + @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." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @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." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_static/.gitcreate b/docs/_static/.gitcreate new file mode 100644 index 0000000..e69de29 diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..74ca42b --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,24 @@ +API +=== + +.. warning:: + + This documentation is currently a work in progress and is still rough + around the edges. Not finding what you are looking for? Please open an + issue describing your troubles on `python-twitch's github page`_! + + +.. automodule:: twitch.api.v3 + :members: + + +scraper +------- + +.. automodule:: twitch.scraper + +.. Links + +.. _twitch: http://www.twitch.tv/ +.. _Python: http://www.python.org/ +.. _`python-twitch's github page`: https://github.com/ingwinlu/python-twitch diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..f1501c8 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,303 @@ +# -*- coding: utf-8 -*- +# +# python-twitch documentation build configuration file, created by +# sphinx-quickstart on Sat Oct 3 15:25:47 2015. +# +# 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 +import os +import shlex + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# 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', + 'sphinx.ext.ifconfig', + 'sphinx.ext.extlinks', + 'sphinx.ext.doctest', +] + +# 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 encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'python-twitch' +copyright = u'2015, winlu' +author = u'winlu' + +# 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. +import pkg_resources +try: + release = pkg_resources.get_distribution(project).version +except pkg_resources.DistributionNotFound: + print("twitch distribution not found, needed to build the docs") + sys.exit(1) +del pkg_resources + +version = '.'.join(release.split('.')[:2]) + +# 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 + +# 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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- 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' +if not on_rtd: + try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + except ImportError: + pass + +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# 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 + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'python-twitchdoc' + +# -- 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, 'python-twitch.tex', u'python-twitch Documentation', + u'winlu', '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 = [ + (master_doc, 'python-twitch', u'python-twitch Documentation', + [author], 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 = [ + (master_doc, 'python-twitch', u'python-twitch Documentation', + author, 'python-twitch', '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' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 0000000..3d536df --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,28 @@ +Contribute +========== + +.. warning:: + + This documentation is currently a work in progress and is still rough + around the edges. Not finding what you are looking for? Please open an + issue describing your troubles on `python-twitch's github page`_! + + +You are welcome to contribute. Post your issues on `python-twitch's github +page`_ with your feature suggestions and your problems. + +Pull requests are required to be compatible with both Python 2.7 and recent +versions of Python 3. To help you ensure good code quality CI is automatically +testing all PR's and tells you if something is wrong with them. + +.. note:: + + TODO: the document should also talk about style (flake8) and the necessity + of adding tests to cover all code changes. + + +.. Links + +.. _twitch: http://www.twitch.tv/ +.. _Python: http://www.python.org/ +.. _`python-twitch's github page`: https://github.com/ingwinlu/python-twitch diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..93deb6b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,59 @@ +python-twitch |version| +======================= + +.. warning:: + + This documentation is currently a work in progress and is still rough + around the edges. Not finding what you are looking for? Please open an + issue describing your troubles on `python-twitch's github page`_! + + +**python-twitch** is a library designed for easy access to the twitch_ api's. It +is written in Python_ and enables you to access most of the functionality of the +official twitch-api documentation while also offering an interface towards their +hidden api and usher services. + + +Features +-------- + +python-twitch |version| currently supports: + +* access to twitch api's + + v3 api + + hidden api + + usher api +* translation of m3u8 playlists into more friendly json format +* tests! + +Contents: +--------- + +.. toctree:: + :maxdepth: 2 + + quickstart + contribute + +API Reference +------------- + +.. toctree:: + :maxdepth: 2 + + api + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Links + +.. _twitch: http://www.twitch.tv/ +.. _Python: http://www.python.org/ +.. _`python-twitch's github page`: https://github.com/ingwinlu/python-twitch diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..adde31e --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,76 @@ +Quickstart +========== + +.. warning:: + + This documentation is currently a work in progress and is still rough + around the edges. Not finding what you are looking for? Please open an + issue describing your troubles on `python-twitch's github page`_! + + +Installation +------------ + +python-twitch can be installed via:: + + pip install python-twitch + +For a more unstable version you can directly install from the github +repository:: + + pip install -e git+https://github.com/ingwinlu/python-twitch + + +Dependencies +------------ + +python-twitch supports Python 2.7 and Python 3.3+. It's only dependency is six_ +which should be automatically be installed when you install python-twitch. + + +Usage +----- + +No additional setup is required, choose which API's you want to use and import +them. python-twitch also does some logging. For troubleshooting add a handler to +`twitch.logging.log`. + + +API ++++ + +Choose which ever API's you want to use and import them into your project:: + + from twitch.api import v3 + v3.streams.all(limit=1) + + +Responses ++++++++++ + +All queries executed over python-twitch result in json responses. You can find +more information on them on the official twitch api documentation. Inofficial +api's don't have any documentation and might get changed anytime, so don't build +reliable systems around them and expect the results to change without warning. + + +Logging ++++++++ + +To have access to python-twitchs logging output add a handler to +twitch.logging.log:: + + import logging + from twitch.logging import log + + console_handler = logging.StreamHandler() + console_handler.setLevel(logging.INFO) + formatter = logging.Formatter( + '%(asctime)s - %(name)s - %(levelname)s - %(message)s') + log.addHandler(console_handler) + + +.. links: + +.. _six: http://pythonhosted.org/six/ +.. _`python-twitch's github page`: https://github.com/ingwinlu/python-twitch diff --git a/tox.ini b/tox.ini index cedc5d1..759733e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py{27,34,35}, flake8 +envlist = py{27,34,35}, flake8, docs [testenv] basepython = @@ -29,3 +29,12 @@ deps = commands = flake8 --version flake8 twitch + +[testenv:docs] +basepython = python2.7 +deps = + sphinx + sphinx_rtd_theme +changedir = docs +commands = + sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html diff --git a/twitch/api/v3/__init__.py b/twitch/api/v3/__init__.py index 675cec5..0f234f2 100644 --- a/twitch/api/v3/__init__.py +++ b/twitch/api/v3/__init__.py @@ -1,5 +1,26 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/ +""" + twitch.api.v3 + ------------- + + Accumulate functionality from all submodules + https://github.com/justintv/Twitch-API/blob/master/v3_resources/ + + .. autofunction:: twitch.api.v3.root() + + .. automodule:: twitch.api.v3.blocks + .. automodule:: twitch.api.v3.channels + .. automodule:: twitch.api.v3.chat + .. automodule:: twitch.api.v3.follows + .. automodule:: twitch.api.v3.games + .. automodule:: twitch.api.v3.ingests + .. automodule:: twitch.api.v3.search + .. automodule:: twitch.api.v3.streams + .. automodule:: twitch.api.v3.subscriptions + .. automodule:: twitch.api.v3.teams + .. automodule:: twitch.api.v3.users + .. automodule:: twitch.api.v3.videos +""" from twitch.api.v3 import blocks # NOQA from twitch.api.v3 import channels # NOQA diff --git a/twitch/api/v3/blocks.py b/twitch/api/v3/blocks.py index 9fc14f4..f7bfa74 100644 --- a/twitch/api/v3/blocks.py +++ b/twitch/api/v3/blocks.py @@ -1,5 +1,11 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/blocks.md +""" + twitch.api.v3.blocks + ~~~~~~~~~~~~~~~~~~~~ + + This module implements the functionality described here + https://github.com/justintv/Twitch-API/blob/master/v3_resources/blocks.md +""" from twitch.queries import query diff --git a/twitch/api/v3/channels.py b/twitch/api/v3/channels.py index 456e57e..69a52ae 100644 --- a/twitch/api/v3/channels.py +++ b/twitch/api/v3/channels.py @@ -1,5 +1,14 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md +""" + twitch.api.v3.channels + ~~~~~~~~~~~~~~~~~~~~~~ + + This module implements the functionality described here + https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md + + .. autofunction:: by_name(name) + .. autofunction:: teams(name) +""" from twitch import keys from twitch.queries import V3Query as Qry @@ -10,6 +19,11 @@ @query def by_name(name): + """Get channel object by name. + + :param name: Name of the channel + :returns: Channel Object as JSON + """ q = Qry('channels/{channel}') q.add_urlkw(keys.CHANNEL, name) return q @@ -21,9 +35,11 @@ def channel(): def get_videos(name, **kwargs): + """Synonym for videos.by_channel""" return by_channel(name, **kwargs) +# TODO needs authentification @query def editors(name): raise NotImplementedError @@ -49,6 +65,11 @@ def commercial(name, length=30): @query def teams(name): + """Returns team objects associated with the channel + + :param name: Name of the channel + :returns: Channel Object as JSON + """ q = Qry('channels/{channel}/teams') q.add_urlkw('channel', name) return q diff --git a/twitch/api/v3/chat.py b/twitch/api/v3/chat.py index 049dde7..5a0d9f4 100644 --- a/twitch/api/v3/chat.py +++ b/twitch/api/v3/chat.py @@ -1,5 +1,15 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md +""" + twitch.api.v3.chat + ~~~~~~~~~~~~~~~~~~ + + This module implements the functionality described here + https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md + + .. autofunction:: by_channel(name) + .. autofunction:: badges(name) + .. autofunction:: emoticons() +""" from twitch import keys from twitch.queries import V3Query as Qry @@ -8,6 +18,11 @@ @query def by_channel(name): + """Get links object to other chat endpoints + + :param name: Name of the channel + :returns: JSON Object describing other chat endpoints + """ q = Qry('chat/{channel}') q.add_urlkw(keys.CHANNEL, name) return q @@ -15,6 +30,11 @@ def by_channel(name): @query def badges(name): + """Get chat badges for channel + + :param name: Name of the channel + :returns: JSON Object describing all channel badges + """ q = Qry('chat/{channel}/badges') q.add_urlkw(keys.CHANNEL, name) return q @@ -22,5 +42,9 @@ def badges(name): @query def emoticons(): + """Returns a list of all emoticon objects for Twitch. + + :returns: JSON Object describing all emoticon objects + """ q = Qry('chat/emoticons') return q diff --git a/twitch/api/v3/follows.py b/twitch/api/v3/follows.py index 0714eb7..662380a 100644 --- a/twitch/api/v3/follows.py +++ b/twitch/api/v3/follows.py @@ -1,5 +1,17 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/follows.md +""" + twitch.api.v3.follows + ~~~~~~~~~~~~~~~~~~~~~ + + This module implements the functionality described here + https://github.com/justintv/Twitch-API/blob/master/v3_resources/follows.md + + .. autofunction:: by_channel(name, limit=25, offset=0,\ +direction=Direction.DESC) + .. autofunction:: by_user(name, limit=25, offset=0,\ +direction=Direction.DESC, sort_by=SortBy.CREATED_AT) + .. autofunction:: status(user, target) +""" from twitch import keys from twitch.api.parameters import Direction, SortBy @@ -9,6 +21,17 @@ @query def by_channel(name, limit=25, offset=0, direction=Direction.DESC): + """Get channel's list of following users + + :param name: Name of the channel + :param limit: Maximum number of objects in array. + Default is 25. Maximum is 100. + :param offset: Object offset for pagination. + Default is 0. + :param direction: Creation date sorting direction. + Default is 'desc'. Valid values are 'asc' and 'desc'. + :returns: JSON List of Follow objects + """ q = Qry('channels/{channel}/follows') q.add_urlkw(keys.CHANNEL, name) q.add_param(keys.LIMIT, limit, 25) diff --git a/twitch/api/v3/root.py b/twitch/api/v3/root.py index b0fc249..b413d80 100644 --- a/twitch/api/v3/root.py +++ b/twitch/api/v3/root.py @@ -1,5 +1,5 @@ # -*- encoding: utf-8 -*- -# https://github.com/justintv/Twitch-API/blob/master/v3_resources/root.md +"""https://github.com/justintv/Twitch-API/blob/master/v3_resources/root.md""" from twitch.queries import V3Query as Qry from twitch.queries import query @@ -8,4 +8,5 @@ # TODO token as parameter @query def root(): + """Return the root of the api.""" return Qry('') diff --git a/twitch/parser.py b/twitch/parser.py index 21c843a..dab7972 100644 --- a/twitch/parser.py +++ b/twitch/parser.py @@ -1,5 +1,6 @@ # -*- encoding: utf-8 -*- import re +from functools import wraps from twitch.logging import log @@ -12,6 +13,7 @@ def m3u8(f): + @wraps(f) def m3u8_wrapper(*args, **kwargs): return m3u8_to_dict(f(*args, **kwargs)) return m3u8_wrapper diff --git a/twitch/queries.py b/twitch/queries.py index 15eff40..85e1cd3 100644 --- a/twitch/queries.py +++ b/twitch/queries.py @@ -1,4 +1,5 @@ # -*- encoding: utf-8 -*- +from functools import wraps from six.moves.urllib.parse import urljoin @@ -116,6 +117,7 @@ def assert_new(d, k): # TODO maybe rename def query(f): + @wraps(f) def wrapper(*args, **kwargs): qry = f(*args, **kwargs) if not isinstance(qry, _Query):