ghclass

These instructions will walk you through setup and downloading your students submissions. These instructions assume that you have already configured a classroom and you are ready to get your students submissions.

GitHub released and official cli for classrooms that you can use as an alternative.

Configure GitHub Authorization

You need to Setup the gh command line app first. AFTER you have followed the instructions you can confirm that set everything up correctly using the command gh auth status

> gh auth status
github.com
  ✓ Logged in to github.com as shanep (keyring)
  ✓ Git operations for github.com configured to use ssh protocol.
  ✓ Token: gho_************************************
  ✓ Token scopes: admin:public_key, gist, read:org, repo

After you have created your classroom on github and your students have all accepted their first assignment you need to download the roster (classroom_roster.csv) and place it in the directory that you want your repos downloaded to.

Installing

• Install Nodejs
• Linux users can install node through their package manager

Once node and npm are installed you can install globally with npm install ghclass -g.

Using

After you have created your classroom on github and your students have all accepted their first assignment you need to download the roster (classroom_roster.csv).

$ ghc --help
Usage: ghc [options]

CLI downloader for github repositories created with classrooms.github.com

Options:
  -V, --version              output the version number
  -r, --roster <name>        File name of the class roster (ex. class_roster.csv)
  -o, --organization <name>  Name of your Github organization
  -a, --assignment <name>    Name of the assignment
  -h, --help                 display help for command

Groups

To download groups make sure and download your roster from classroom.github.com with group names. This tool should automatically detect that the roster has group names and will download the assignment into a folder named after the team.

Demo

Docs

• Setting up Classrooms