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 Join the chat at https://gitter.im/pylti/lti

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
tool_provider = DjangoToolProvider.from_django_request(request=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.2.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

lti-0.8.2-py2.py3-none-any.whl (19.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for lti-0.8.2.tar.gz
Algorithm Hash digest
SHA256 e2370fd6daa97aa1c59cd5e53ac1a3e8cea5363dcfa7e414d09e7f79d0020031
MD5 5fb73b45e6bd1bf88e355d931ab027e4
BLAKE2b-256 a3012bba51e598fbf2d592b2fac3bdf4e15e551f0adc459534a90f5f7465dfcb

See more details on using hashes here.

File details

Details for the file lti-0.8.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for lti-0.8.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c77f0c7dcf05b86ba5a9395afff49cc85a787121e4a5062f30ef4a3764d53f38
MD5 f44f1d844e4bf8a460a98e1dc6a42117
BLAKE2b-256 6ae4ae8ae958d153d12d9535da57a0461e2d7eeba344c1ca92db5d37b85b09ed

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