Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mitodl/mit_lti_flask_sample

a sample LTI provider using the PyLTI library and the Flask framework
https://github.com/mitodl/mit_lti_flask_sample

flask lti-provider python

Last synced: 3 months ago
JSON representation

a sample LTI provider using the PyLTI library and the Flask framework

Awesome Lists containing this project

README 

        
Sample LTI Provider for Flask

=============================

|Deploy|



.. |Deploy| image:: https://www.herokucdn.com/deploy/button.png

   :target: https://heroku.com/deploy



This is a sample LTI provider for the Flask framework [#f1]_.  It is a minimal

implementation that provides a starting point for a custom LTI provider.

It is one of a series of LTI providers written for popular frameworks and

using the Python LTI library, PyLTI.  Additional sample LTI providers for

other Python frameworks are planned.  Check for them on the PyLTI Github site,

`https://github.com/mitodl/pylti

`_.  While these LTI provider examples can

be used with any LTI consumer, they were created for use with edX.  Integrating

an LTI provider with edX is described in the edX LTI `docs.

`_



You will need both this app and the PyLTI library to create your own LTI

provider.  Each sample contains only the code variations necessary to support

its specific framework.  By creating an interface boundary between a sample

provider and PyLTI, PyLTI manages the specific LTI features and each sample

manages the specific requirements of its framework.  You can easily switch your

custom provider from one framework to another.



If you have questions or problems, please create an issue on the

project's GitHub site,

`https://github.com/mitodl/mit_lti_flask_sample/issues

`_



Please see the PyLTI README `https://github.com/mitodl/pylti

`_ for a detailed description of the architecture.



Super Quick Start

-----------------



You can try out the sample app for free by deploying it to your Heroku account

simply by clicking the deploy button:



|Deploy|



.. |Deploy| image:: https://www.herokucdn.com/deploy/button.png

   :target: https://heroku.com/deploy



After deployment is complete you can customize the app from the Heroku

git repository that is created.  This button will also work in forked

repositories with your own modifications.



Quick Start

-----------



Open your terminal and navigate to the directory you want to contain your

working directory.  Execute these commands:



.. code-block:: bash



   git clone [email protected]:mitodl/mit_lti_flask_sample.git

   cd mit_lti_flask_sample

   pip install -r requirements.txt

   python mit-lti-flask-sample.py



Then navigate to `http://localhost:5000/is_up `_



If you see a page containing the words, "I'm up", you have verified that you

can run the sample app locally.



1. Deploy the sample app to a server accessible from your LTI consumer, edX or

   another LMS.  (These instructions presume you're using edX, but they are

   similar for any LTI consumer.)

#. In edX Studio, navigate to ``Settings\Advanced Settings`` and enter these

   values for the specified keys.



======================= ========================

Keys                    Values

======================= ========================

Advanced Module List    ``[ lti ]``

----------------------- ------------------------

LTI Passports           ``[ "lti_starx_add_demo:__consumer_key__:__lti_secret__" ]``

======================= ========================



3. Still in edX Studio, navigate to the content page that will contain your LTI

   tool and create an LTI Advanced Component.

#. Enter the LTI ID for the external LTI provider.

#. Enter the URL of the external tool that this component launches.



======================= ========================

Keys                    Values

======================= ========================

LTI ID                  ``lti_starx_add_demo``

----------------------- ------------------------

LTI URL                 ``THE_URL_OF_YOUR_DEPLOYED_LTI_PROVIDER``

======================= ========================



.. [#f1] From their website, *"Flask is a microframework for Python based on

   Werkzeug, Jinja 2 and good intentions."* `http://flask.pocoo.org/ `_



There is more comprehensive documentation of these settings at

`http://edx-partner-course-staff.readthedocs.org/en/latest/exercises_tools/lti_component.html

`_