Welcome to the DLKit documentation!

This documentation for the Digital Learning Toolkit (DLKit), like the toolkit itself, is still under development. It currently covers only a small handful of the 180 service packages and over 10,000 educational service APIs that have been defined by MIT’s Office of Digital Learning and its collaborators to date.

The DLKit codebase is generated from the Open Service Interface Definitions (OSIDs), an extensive and growing suite of interface contract specifications that describe the integration points among the core services and components that make up modern educational systems.

Note that this documentation is intended for API consumers. However, at the heart of DLKit is an integration stack that is even more closely aligned with the OSID specifications. This has been designed to allow third parties to extend the library with alternative or additional implementations of any of the defined services for the purposes of service integration, technology migration, service adaptation, etc. Documentation written for service implementers and system integrators, including implementation notes and compliance information, will be provided elsewhere.

The complete OSID specification can be found at http://osid.org/specifications.

Currently, DLKit works with Python 2.7, 3.4, 3.5, and 3.6.

If you are interested in learning more about the DLKit Python libraries documented here, please contact dlkit-info@mit.edu

Get DLKit

The latest release of DLKit and related dependencies are available here: https://bitbucket.org/cjshaw/

The core MongoDB implemenation is located in the https://bitbucket.org/cjshaw/dlkit repository, which has sub-module dependencies on a number of the other repositories on the site. More information about this can be found in the introduction section.

Testing

Unit tests and limited functional tests for DLKit are available here: https://bitbucket.org/cjshaw/dlkit-tests

Indices and tables