Skip to main content

A python library for building and/or consuming LTI apps

Project description

https://travis-ci.org/pylti/lti.svg?branch=master https://codecov.io/gh/pylti/lti/branch/master/graph/badge.svg

lti is a Python library implementing the Learning Tools Interperability (LTI) standard. It is based on dce_lti_py, which is based on ims_lti_py.

Installation

pip install lti

Dependencies

Usage

The primary goal of this library is to provide classes for building Python LTI tool providers (LTI apps). To that end, the functionality that you’re looking for is probably in the ToolConfig and ToolProvider classes.

Tool Config Example (Django)

Here’s an example of a Django view you might use as the configuration URL when registering your app with the LTI consumer.

from lti import ToolConfig
from django.http import HttpResponse


def tool_config(request):

    # basic stuff
    app_title = 'My App'
    app_description = 'An example LTI App'
    launch_view_name = 'lti_launch'
    launch_url = request.build_absolute_uri(reverse('lti_launch'))

    # maybe you've got some extensions
    extensions = {
        'my_extensions_provider': {
            # extension settings...
        }
    }

    lti_tool_config = ToolConfig(
        title=app_title,
        launch_url=launch_url,
        secure_launch_url=launch_url,
        extensions=extensions,
        description = app_description
    )

    return HttpResponse(lti_tool_config.to_xml(), content_type='text/xml')

Tool Provider OAuth Request Validation Example (Django)

from lti.contrib.django import DjangoToolProvider
from my_app import RequestValidator


# create the tool provider instance
secret = 'my LTI app oauth secret'
tool_provider = DjangoToolProvider.from_django_request(secret, request)

# the tool provider uses the 'oauthlib' library which requires an instance
# of a validator class when doing the oauth request signature checking.
# see https://oauthlib.readthedocs.org/en/latest/oauth1/validator.html for
# info on how to create one
validator = RequestValidator()

# validate the oauth request signature
ok = tool_provider.is_valid_request(validator)

# do stuff if ok / not ok

Testing

Unit tests can be run by executing

tox

This uses tox to set up and run the test environment.

Project details


Download files

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

Source Distribution

lti-0.8.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

lti-0.8.0-py2-none-any.whl (18.6 kB view details)

Uploaded Python 2

File details

Details for the file lti-0.8.0.tar.gz.

File metadata

  • Download URL: lti-0.8.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for lti-0.8.0.tar.gz
Algorithm Hash digest
SHA256 b8c830c03f74a0be8f3fc04a380b057c8c7ce2fb85b4fc5b38c2e804699ff71f
MD5 228a54ef479f3134b251165e593fc359
BLAKE2b-256 8880aa41f3183d8aee430d22712eaaa21be28e035ea2097afe2db74091f29ee7

See more details on using hashes here.

File details

Details for the file lti-0.8.0-py2-none-any.whl.

File metadata

File hashes

Hashes for lti-0.8.0-py2-none-any.whl
Algorithm Hash digest
SHA256 a3c0490d13d28da98de176ee1026bc722a48d006d10b5efdae1c1f02b5d1f2e6
MD5 91096fc287af858a6d798b844819b575
BLAKE2b-256 86a9f84a5732b75c30a03e07b8296104a676c4b967797f853448d769f2df7ce1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page