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.0.tar.gz (30.3 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.0-py3-none-any.whl (49.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: canvaslms-2.0.tar.gz
  • Upload date:
  • Size: 30.3 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.0.tar.gz
Algorithm Hash digest
SHA256 372c8baace3fbfcf8d43aaf285c5da060b6d96a83a06503d70bfb5883da04711
MD5 2ce55e9ec4a5c9de6eba77ce19311e34
BLAKE2b-256 0212ebf009981a1c99846292185f209fdf99cd7f1cf533dee331263283a8c115

See more details on using hashes here.

File details

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

File metadata

  • Download URL: canvaslms-2.0-py3-none-any.whl
  • Upload date:
  • Size: 49.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61dafd6862dbdc9c49f63d882cd8d3ae5590e7559b587a85edc984347985efc8
MD5 494841f8e92356466b6bfe33eba2eec3
BLAKE2b-256 bd1e02891fe4ec988074f8c89e6f93e1720628666f7ec4c6b49ebc544945f7ca

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