README.md

Canvas LMS ↔️ Jenzabar SIS

Create student users, handle enrollment add/drops in Canvas LMS

Usage

$ canvas-jenzabar <generator> <options>

Or, if you'd like to be prompted for choices:

$ canvas-jenzabar

? What do you want to generate?
❯ users
  enrollment-adds
  enrollment-drops

? Destinations (in addition to stdout)
❯◉ file
 ◯ upload

  🌕  CANVAS HOST:       canvas.instructure.com
  🔵  JENZABAR HOST:     jenzabar.school.edu

"user_id","login_id","first_name","last_name","email","status"
⋮

Generators

• users – CSV of users to update
• enrollment-adds – students to add to Canvas course enrollment
• enrollment-drops – students to drop (make inactive) in Canvas course enrollment

Options

• --file – saves the output to a file in ./tmp
• --upload – uploads the file to canvas instance

Installation

Prerequisites:

• NodeJS LTS

# clone repo
$ git clone [email protected]:mcadonline/canvas-jenzabar-integration.git

# install node deps
$ npm ci

# configure .env file
$ cd canvas-jenzabar-integration
$ cp .env.example .env
$ nano .env

Note that canvas-jenzabar will use .env file in repo dir.

Running:

$ npm start

Or create a link with npm link and run using the canvas-jenzabar command:

# link one time
$ npm link

# now you can run using the canvas-jenzabar command
$ canvas-jenzabar users --file

Updating

$ git pull
$ npm ci

Resources

• Canvas API
• Canvas APIs: Getting Started, the practical ins and outs,...
• Canvas Oauth2
• The ABCs of Canvas Dev

Author

James Johnson
Director, Online Learning
Minneapolis College of Art and Design