README.md (1658B)
1 # A+Attendance CLI 2 3 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 4 universities using Canvas and A+Attendance. 5 6 ## Building/Installing 7 8 To compile this program, you need `go` installed as well as need to set two 9 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. 10 11 ### Getting an API key 12 13 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. 14 15 ### Setting the Environment Variables 16 17 In your shell's configuration file, add: 18 ```sh 19 export CANVAS_INSTANCE="https://youruniversityhere.instructure.com" 20 export CANVAS_API_KEY="the_canvas_access_token_you_stored_somewhere" 21 22 # below not needed if go is already setup 23 export GOPATH=$HOME/.local/go 24 export GOBIN=$GOPATH/bin 25 export PATH=$PATH:$GOBIN 26 ``` 27 28 ### Installing 29 30 Simply run `go install codeberg.org/flpolyaplus/aplus@latest`. 31 32 ## Usage 33 34 ### Show help message 35 `aplus --help` 36 37 ### List all courses and canvas course codes 38 `aplus --list-all` 39 40 ### List favorite courses and canvas course codes 41 `aplus --list-favorites` 42 43 ### Enter code for a specified course 44 `aplus --code <code> --course <canvas_course_number>` 45 46 If no course is specified, the code is tried on all active courses. 47 48 ### Show timetable for a specified course 49 `aplus --timetable --course <canvas_course_number>` 50 51 ## Mirrors 52 [Codeberg](https://codeberg.org/flpolyaplus/aplus/) 53 54 [Gitea (vineetk)](https://gitea.vineetk.net/flpolyaplus/aplus/)