Skip to main content

Command-line interface to Canvas LMS

Project description

canvaslms: A CLI to Canvas LMS.

This program provides a command-line interface for Canvas. The command is canvaslms and it has several subcommands in the same style as Git. canvaslms provides output in a format useful for POSIX tools, this makes automating tasks much easier.

Let's consider how to grade students logging into the student-shell SSH server. We store the list of students' Canvas and KTH IDs in a file.

canvaslms users -c DD1301 -s | cut -f 1,2 > students.csv

Then we check who has logged into student-shell.

ssh student-shell.sys.kth.se last | cut -f 1 -d " " | sort | uniq \
  > logged-in.csv

Finally, we check who of our students logged in.

for s in $(cut -f 2 students.csv); do
  grep $s logged-in.csv && \

Finally, we can set their grade to P and add the comment "Well done!" in Canvas. We set the grades for the two assignments whose titles match the regular expression (Preparing the terminal|The terminal).

    canvaslms grade -c DD1301 -a "(Preparing the terminal|The terminal)" \
      -u $(grep $s students.csv | cut -f 1) \
      -g P -m "Well done!"
done

Installation

Just install the PyPI package:

python3 -m pip install canvaslms

Some subcommands use pandoc, so you will likely have to install pandoc on your system manually.

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

canvaslms-2.5.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

canvaslms-2.5-py3-none-any.whl (51.9 kB view details)

Uploaded Python 3

File details

Details for the file canvaslms-2.5.tar.gz.

File metadata

  • Download URL: canvaslms-2.5.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.6 Linux/5.15.0-56-generic

File hashes

Hashes for canvaslms-2.5.tar.gz
Algorithm Hash digest
SHA256 8c9d6b42651accc50f59b75e3965ae5a6950020366cf7d2edac86b56495bd3c8
MD5 913684b5a6049b01489fb129f0f66eb5
BLAKE2b-256 56b1aaef12cb4b1b43792aa73045018227830657a2d650f9377f1cc72a115189

See more details on using hashes here.

File details

Details for the file canvaslms-2.5-py3-none-any.whl.

File metadata

  • Download URL: canvaslms-2.5-py3-none-any.whl
  • Upload date:
  • Size: 51.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.6 Linux/5.15.0-56-generic

File hashes

Hashes for canvaslms-2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8da099daf6134f3256de9b03f39f075188e4d479b1d4dffa8dd485c30acd7607
MD5 c4fa78cd8f91d5812b5214f9526be718
BLAKE2b-256 2098710f4b08450350ed7fd455c25a7f54bfa3f0d5a9f49b898780b3f6f57f92

See more details on using hashes here.

Supported by

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