Go to file
Vineet Kumar 0e1a5cf3a3 exit if the CANVAS environment variables are not set 2024-01-17 16:51:00 -05:00
.gitignore add .gitignore 2024-01-12 17:24:09 -05:00
LICENSE Update LICENSE with author names, further reorganization. 2023-11-13 13:02:21 -05:00
README.md update readme to the current status of the project 2024-01-16 15:31:04 -05:00
aplus.go exit if the CANVAS environment variables are not set 2024-01-17 16:51:00 -05:00
canvas.go exit if the CANVAS environment variables are not set 2024-01-17 16:51:00 -05:00
go.mod use golang flag instead of external getopt library 2023-11-20 10:27:50 -05:00
go.sum use golang flag instead of external getopt library 2023-11-20 10:27:50 -05:00
main.go update readme to the current status of the project 2024-01-16 15:31:04 -05:00
structs.go use the Canvas API to get A+ tool ID and URL 2023-11-20 10:08:58 -05:00

README.md

A+Attendance CLI

This is a CLI utility initially created for students at Florida Polytechnic University to submit their A+ attendance codes, but can be used for other universities using Canvas and A+Attendance.

Building/Installing

To compile this program, you need go installed as well as need to set two environment variables in your shell's configuration file (like ~/.profile or it's rc file) for your Canvas instance URL and your account's API key.

Getting an API key

When logged into your university's Canvas site, go to Account -> Settings -> New Access Token -> (give any name or expiration date) -> store the Token somewhere.

Setting the Environment Variables

In your shell's configuration file, add:

export CANVAS_INSTANCE="https://youruniversityhere.instructure.com"
export CANVAS_API_KEY="the_canvas_access_token_you_stored_somewhere"

# below not needed if go is already setup
export GOPATH=$HOME/.local/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN

Installing

Simply run go install codeberg.org/flpolyaplus/aplus@latest.

Usage

Show help message

aplus --help

List all courses and canvas course codes

aplus --list-all

List favorite courses and canvas course codes

aplus --list-favorites

Enter code for a specified course

aplus --code <code> --course <canvas_course_number>

If no course is specified, the code is tried on all active courses.

Show timetable for a specified course

aplus --timetable --course <canvas_course_number>

Mirrors

Codeberg

Gitea (vineetk)