Merge 50c4323 into 532073c

README.rst

@@ -1,9 +1,75 @@
 PyLTI - LTI done right
 =========================
+:PyLTI: Python implementation of LTI
+:Version: 0.1.3
+:Author: MIT Office of Digital Learning
+:Homepage: http://odl.mit.edu
+:License: BSD
 
 .. image:: https://secure.travis-ci.org/mitodl/pylti.png?branch=develop
   :target: https://secure.travis-ci.org/mitodl/pylti
 .. image:: https://pypip.in/d/pylti/badge.png
   :target: https://pypi.python.org/pypi/PyLTI/
-.. image:: https://coveralls.io/repos/mitodl/pylti/badge.png?branch=develop 
+.. image:: https://coveralls.io/repos/mitodl/pylti/badge.png?branch=develop
   :target: https://coveralls.io/r/mitodl/pylti?branch=develop
+
+.. _Documentation: http://pylti.readthedocs.org/en/latest/
+
+PyLTI is a Python implementation of the LTI specification [#f1]_.  It supports
+LTI 1.1.1 and LTI 2.0.  While it was written with edX [#f2]_ as its LTI consumer, it
+is a complete implementation of the LTI specification and can be used with any
+learning management system that supports LTI.
+
+A feature of PyLTI is the way it is used in the creation of an LTI tool.  PyLTI
+is written as a library that exposes an API.  This separation of concerns
+enables a developer to focus on the business logic of their tool and support of
+their framework of choice.
+
+To demonstrate this usage, there are also a collection of example LTI tools
+written to support different Python web frameworks.
+
+=========  ============
+Framework  Example
+=========  ============
+Flask      `mit_lti_flask_sample
+           <https://github.mit.edu/mitxlti/mit_lti_flask_sample>`_
+           A skeleton example for the Flask framework that consumes the PyLTI library
+=========  ============
+
+Dependencies:
+=============
+* Python 2.7+
+* oauth 1.0.1+
+* oauth2 1.5.211+
+* httplib2 0.9+
+
+Development dependencies:
+=========================
+* Flask 0.10.1
+* httpretty 0.8.3
+* oauthlib 0.6.3
+* pyflakes 0.8.1
+* pytest 2.6.3
+* pytest-cache 1.0
+* pytest-cov 1.8.0
+* pytest-flakes 0.2
+* pytest-pep8 1.0.6
+* sphinx 1.2.3
+
+Documentation_ is available on readthedocs.
+
+Licensing
+=========
+PyLTI is licensed under the BSD license, version January 9, 2008.  See
+license.rst for the full text of the license.
+
+.. rubric:: Footnotes
+
+.. [#f1] The Learning Tools Interoperability (LTI) specification is an
+   initiative of IMS.  Their site `http://developers.imsglobal.org/
+   <http://developers.imsglobal.org/>`_ contains a description of LTI as well as
+   the current LTI specification.
+.. [#f2] EdX offers interactive online classes and MOOCs from the world’s best
+   universities. Online courses from MITx, HarvardX, BerkeleyX, UTx and many
+   other universities.  EdX is a non-profit online initiative created by
+   founding partners Harvard and MIT. `code.edx.org <http://code.edx.org>`_

docs/Makefile

@@ -0,0 +1,177 @@
+# 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) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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 <target>' where <target> 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 "  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)"
+
+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/PyLTI.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyLTI.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/PyLTI"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyLTI"
+	@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."
+
+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."

docs/source/conf.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+#
+# PyLTI documentation build configuration file, created by
+# sphinx-quickstart on Mon Nov  3 11:17:08 2014.
+#
+
+import sys
+import os
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.coverage',
+]
+
+templates_path = ['_templates']
+
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'PyLTI'
+copyright = u'2014, ODL Engineering'
+
+static_mod = os.path.join('..','..', 'pylti', '__init__.py')
+execfile(static_mod)
+version = VERSION
+release = VERSION
+
+exclude_patterns = []
+
+pygments_style = 'sphinx'
+
+html_theme = 'sphinxdoc'
+
+html_static_path = ['_static']
+
+htmlhelp_basename = 'PyLTIdoc'
+
+
+latex_elements = {
+}
+
+latex_documents = [
+  ('index', 'PyLTI.tex', u'PyLTI Documentation',
+   u'Ivica Ceraj (ODL Engineering)', 'manual'),
+]
+
+man_pages = [
+    ('index', 'pylti', u'PyLTI Documentation',
+     [u'Ivica Ceraj (ODL Engineering)'], 1)
+]
+
+texinfo_documents = [
+  ('index', 'PyLTI', u'PyLTI Documentation',
+   u'Ivica Ceraj (ODL Engineering)', 'PyLTI', 'Python LTI decorators.',
+   'Miscellaneous'),
+]
+