Skip to main content

Command-line interface for 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-1.4.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

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

canvaslms-1.4-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: canvaslms-1.4.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10

File hashes

Hashes for canvaslms-1.4.tar.gz
Algorithm Hash digest
SHA256 2fa140af37af61bc6ee6a79e24739ef895bae4facef82e8a2665aa389ab2ccce
MD5 1d15f462cbd6e0d1bd8a252017705ccd
BLAKE2b-256 1e2bd19b31c819e19cdae002224bfc1b4e44fd4fc4bcff484ccd3d1742869663

See more details on using hashes here.

File details

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

File metadata

  • Download URL: canvaslms-1.4-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10

File hashes

Hashes for canvaslms-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d26500fb016fcf2a72e8bac740271b9173ffef4a17d28450d5c508a1eb477842
MD5 c6c9e46f513ac26d5d00f08af4018ab6
BLAKE2b-256 7f3d7b7c5e92dd01a3bbabc84c0f62f5cf19f6187e78ef08a5cfb8acd9d20d69

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