p5quared / decanter

CLI for UB Autolab... Decan't you see why that's awesome?
MIT License
3 stars 1 forks source link

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:

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