edq-lms-toolkit 1.0.0

A suite of CLI tools and Python library interfacing with Learning Management Systems (LMSs).

LMS Tools

A suite of tools and Python interface for different Learning Management Systems (LMSs).

This project is not affiliated with any LMS developer/provider.

Documentation Table of Contents:

• Installation
• CLI Configuration
• Usage Notes
  • Name Resolution and Labels
  • Output Formats
• CLI Tools
  • List Course Users
  • Get Course Users
  • List Assignments
  • Get Assignments

Installation

The project (tools and API) can be installed from PyPi with:

pip install edq-lms-toolkit

Standard Python requirements are listed in pyproject.toml. The project and Python dependencies can be installed from source with:

pip3 install .

Cloning

This repository includes submodules. To fetch these submodules on clone, add the --recurse-submodules flag. For example:

git clone --recurse-submodules [e-mail]:edulinq/lms-toolkit.git

To fetch the submodules after cloning, you can use:

git submodule update --init --recursive

Usage Notes

Name Resolution and Labels

The LMS Toolkit is able to resolve most objects that have a name, so you can refer to that object by name instead of by ID. Fields with this resolution will be referred to as "queries". The exact attributes that can be used as a query depend on the underlying object, for example users can use their name or email in a user query.

A "label" is a formatted field that the LMS Toolkit will use in certain cases that includes both the name and id in a single field: "name (id)".

For example, a user may be identified by any of the following:

Query Type	Query
Email	[e-mail]
Name	Sammy Slug
ID	123
Label (Email)	[e-mail] (123)
Label (Name)	Sammy Slug (123)

Output Formats

Many commands can output data in three different formats:

• Text (--format text) -- A human-readable format (usually the default).
• Table (--format table) -- A tab-separated table.
• JSON (--format json) -- A JSON object/list.

CLI Tools

All CLI tools can be invoked with -h / --help to see the full usage and all options.

List Course Users

Course users can be listed using the lms.cli.courses.users.list tool. For example:

python3 -m lms.cli.courses.users.list

Get Course Users

To fetch information about course users, use the lms.cli.courses.users.get tool. For example:

python3 -m lms.cli.courses.users.get [e-mail]

Any number of user queries may be specified.

List Assignments

Course assignments can be listed using the lms.cli.courses.assignments.list tool. For example:

python3 -m lms.cli.courses.assignments.list

Get Assignments

To fetch information about course assignments, use the lms.cli.courses.assignments.get tool. For example:

python3 -m lms.cli.courses.assignments.fetch 'Homework 1'

Any number of assignment queries may be specified.