Skip to main content

LTI 1.3 Advantage Tool implementation in Python

Project description

LTI 1.3 Advantage Tool implementation in Python

PyPI Python Build Status MIT

This project is a Python implementation of the similar PHP tool. Library contains adapters for usage from Django and Flask web frameworks but there is no difficulty to adapt it to other frameworks: you should just re-implement OIDCLogin and MessageLaunch classes as it is already done in existing adapters.


To configure your own tool you may use built-in adapters:

from pylti1p3.tool_config import
tool_conf = ToolConfJsonFile('path/to/json')

from pylti1p3.tool_config import ToolConfDict
settings = {
    "<issuer_1>": { },
    "<issuer_2>": { }
private_key = '...'
tool_conf = ToolConfDict(settings)
tool_conf.set_private_key(iss, private_key)

or create your own implementation. The pylti1p3.tool_config.ToolConfAbstract interface must be fully implemented for this to work.

Usage with Django

Open Id Connect Login Request

LTI 1.3 uses a modified version of the OpenId Connect third party initiate login flow. This means that to do an LTI 1.3 launch, you must first receive a login initialization request and return to the platform.

To handle this request, you must first create a new OIDCLogin (or DjangoOIDCLogin) object:

from pylti1p3.contrib.django import DjangoOIDCLogin

oidc_login = DjangoOIDCLogin(request, tool_conf)

Now you must configure your login request with a return url (this must be preconfigured and white-listed on the tool). If a redirect url is not given or the registration does not exist an pylti1p3.exception.OIDC_Exception will be thrown.

except OIDC_Exception:
    # display error page
    log.error('Error doing OIDC login')

With the redirect, we can now redirect the user back to the tool. There are three ways to do this:

This will add a HTTP 302 location header:


This will display some javascript to do the redirect instead of using a HTTP 302:

oidc_login.redirect(get_launch_url(request), js_redirect=True)

You can also get the url you need to redirect to, with all the necessary query parameters (if you would prefer to redirect in a custom way):

redirect_obj = oidc_login.get_redirect_object()
redirect_url = redirect_obj.get_redirect_url()

Redirect is done, we can move onto the launch.

LTI Message Launches

Now that we have done the OIDC log the platform will launch back to the tool. To handle this request, first we need to create a new MessageLaunch (or DjangoMessageLaunch) object.

message_launch = DjangoMessageLaunch(request, tool_conf)

Once we have the message launch, we can validate it. Validation is transparent - it’s done once before you try to access the message body:

    launch_data = message_launch.get_launch_data()
except LtiException:
    log.error('Launch validation failed')

You may do it more explicitly:

    launch_data = message_launch.set_auto_validation(enable=False).validate()
except LtiException:
    log.error('Launch validation failed')

Now we know the launch is valid we can find out more information about the launch.

Check if we have a resource launch or a deep linking launch:

if message_launch.is_resource_launch():
    # Resource Launch!
elif message_launch.is_deep_link_launch():
    # Deep Linking Launch!
    # Unknown launch type

Check which services we have access to:

if message_launch.has_ags():
    # Has Assignments and Grades Service
if message_launch.has_nrps():
    # Has Names and Roles Service

Accessing Cached Launch Requests

It is likely that you will want to refer back to a launch later during subsequent requests. This is done using the launch id to identify a cached request. The launch id can be found using:

launch_id = message_launch.get_launch_id()

Once you have the launch id, you can link it to your session and pass it along as a query parameter.

Make sure you check the launch id against the user session to prevent someone from making actions on another person’s launch.

Retrieving a launch using the launch id can be done using:

message_launch = DjangoMessageLaunch.from_cache(launch_id, request, tool_conf)

Once retrieved, you can call any of the methods on the launch object as normal, e.g.

if message_launch.has_ags():
    # Has Assignments and Grades Service

Deep Linking Responses

If you receive a deep linking launch, it is very likely that you are going to want to respond to the deep linking request with resources for the platform.

To create a deep link response you will need to get the deep link for the current launch:

deep_link = message_launch.get_deep_link()

Now we need to create pylti1p3.deep_link_resource.DeepLinkResource to return:

resource = DeepLinkResource()
    .set_custom_params({'my_param': my_param})\
    .set_title('My Resource')

Everything is set to return the resource to the platform. There are two methods of doing this.

The following method will output the html for an aut-posting form for you.

deep_link.output_response_form([resource1, resource2])

Alternatively you can just request the signed JWT that will need posting back to the platform by calling.

deep_link.get_response_jwt([resource1, resource2])

Names and Roles Service

Before using names and roles you should check that you have access to it:

if not message_launch.has_nrps():
    raise Exception("Don't have names and roles!")

Once we know we can access it, we can get an instance of the service from the launch.

nrps = message_launch.get_nrps()

From the service we can get list of all members by calling:

members = nrps.get_members()

Assignments and Grades Service

Before using assignments and grades you should check that you have access to it:

if not launch.has_ags():
    raise Exception("Don't have assignments and grades!")

Once we know we can access it, we can get an instance of the service from the launch:

ags = launch.get_ags()

To pass a grade back to the platform, you will need to create a pylti1p3.grade.Grade object and populate it with the necessary information:

gr = Grade()

To send the grade to the platform we can call:


This will put the grade into the default provided lineitem. If no default lineitem exists it will create one.

If you want to send multiple types of grade back, that can be done by specifying a pylti1p3.lineitem.LineItem:

line_item = LineItem()

ags.put_grade(gr, line_item);

If a lineitem with the same tag exists, that lineitem will be used, otherwise a new lineitem will be created.

Usage with Flask

Open Id Connect Login Request

This is draft of API endpoint. Wrap it in library of your choice.

Create FlaskRequest adapter. Then create instance of FlaskOIDCLogin. redirect method will return instance of werkzeug.wrappers.Response that points to LTI platform if login was successful. Handle exceptions.

from flask import request, session
from pylti1p3.flask_adapter import (FlaskRequest, FlaskOIDCLogin)

def login(request_params_dict):

    tool_conf = ... # See Configuration chapter above

    # FlaskRequest by default use flask.request and flask.session
    # so in this case you may define request object without any arguments:

    request = FlaskRequest()

    # in case of using different request object (for example webargs or something like this)
    # you may pass your own values:

    request = FlaskRequest(

    oidc_login = FlaskOIDCLogin(

    return oidc_login.redirect(request.get_param('target_link_uri'))

LTI Message Launches

This is draft of API endpoint. Wrap it in library of your choice.

Create FlaskRequest adapter. Then create instance of FlaskMessageLaunch. It lets you access data from LTI launch message if launch was successful. Handle exceptions.

from flask import request, session
from werkzeug.utils import redirect
from pylti1p3.flask_adapter import (FlaskRequest, FlaskMessageLaunch)

def launch(request_params_dict):

    tool_conf = ... # See Configuration chapter above

    request = FlaskRequest()

    # or

    request = FlaskRequest(

    message_launch = FlaskMessageLaunch(

    email = message_launch.get_launch_data().get('email')

    # Place your user creation/update/login logic
    # and redirect to tool content here

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PyLTI1p3, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size PyLTI1p3-1.4.0-py2.py3-none-any.whl (30.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size PyLTI1p3-1.4.0.tar.gz (19.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page