Skip to content

p5quared/decanter

Repository files navigation

Decanter Logo

Decanter

Decanter is a CLI app for interacting with Autolab at UB (University at Buffalo ...). Pour data from your computer to Autolab, a little more seamlessly.

Installation

If you have homebrew you can install via tap like so:

brew install p5quared/decanter/decanter

Otherwise, you can build from source if you have go installed:

git clone https://github.com/p5quared/decanter.git
cd decanter
go install

Usage

Before you can do much of anything, you need to setup Decanter via decanter setup.

To view a command overview, use decanter -h.

Some examples are:

  • decanter list me
  • decanter list assessments
  • decanter submit -c cse486-s24 -a PA2-Raft-Cluster -f submission.tar

Tips

Remembering the full submit command can get quite tedious for your projects. Consider writing a per-project script to automate this process. For instance, if your project came with a Makefile or you want to use just, you could add a recipe like so:

submit: 
	decanter submit -c COURSE_ID -a ASSESSMENT -f FILE -w 

Notes

If you find issues or have suggestions, I'd love to hear about them in the Github issues section.

Contributions would be appreciated. If you'd like to contribute, please email me or write an issue first. There's also a long list of TODO's that I have written down and scattered throughout the code.

At some point I'll be cleaning up the Autolab API and publishing it as a standalone library.

If you've read this far I'd really appreciate if you'd give the repo a ⭐ or a watch. We need to reach a certain threshold of 'notoriety' before Homebrew will accept our formulae.

FAQ

  • When I view my submission scores, I can't see the total (score / x)!
    • The Autolab API only returns problem scores, and requires instructor scopes to access maximum scores. shrug
  • Why can't I do XYZ with Decanter?
    • Hey come on, I'm only one person here.
  • Why is it red and not blue?
    • Red is the color of passion, here are some great red things:
      • The Northern Cardinal
      • The <3 in I <3 NY
      • The leaves of a Japanese maple tree.
      • My copy of Crime and Punishment
      • etc...
    • If that doesn't satisfy you, I also want make sure nobody is confused about the fact that this app is not directly affiliated with UB in any way.
  • What the hell is that logo?
    • Sorry honey, it's modern art and I'm afraid you just don't get it.

About

CLI for UB Autolab... Decan't you see why that's awesome?

Resources

License

Stars

Watchers

Forks

Languages