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.14.tar.gz (36.9 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.14-py3-none-any.whl (62.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: canvaslms-2.14.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/5.19.0-45-generic

File hashes

Hashes for canvaslms-2.14.tar.gz
Algorithm Hash digest
SHA256 f7db87d4d364dc000d3d0cb1f761eb0930f9822a687a77d104f8fd1d64714bbf
MD5 c590d9e262875859766eb0d42a349d5e
BLAKE2b-256 5166a46d4638317daa68f946c64a103ba2bb54cf9247b0d9522dbd378b439aea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: canvaslms-2.14-py3-none-any.whl
  • Upload date:
  • Size: 62.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/5.19.0-45-generic

File hashes

Hashes for canvaslms-2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6521cb5434af0104266a6f2b8b0dc8c3f29938a65398ff0724b63feca51e2f04
MD5 442ade80824134a720abaa88dd580e89
BLAKE2b-256 43dfbf2025cab4f06a38b7fe1505aaea3b54a9f3a8feb6250eb1d603d253fab1

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