eecs-yorku

A command-line SSH client tool for submitting assignments through your York Univeristy Prism account.

---

What's this for?

    York University gives us (students) accounts for the computer science department system (called Prism). We use our accounts to log into the lab computers, and they have this special program installed on them that we can use, from the terminal, to submit our work (text files, java files, etc).
    We also have SSH access for our accounts, so we could do a lot of the work on our own computers and SSH in and submit them.
    Not many students actually do this, however, for these reasons:
    1) Some students dont know what SSH is or whether we have it.
    2) Many students have heard that you can do this, but either dont know how or it sounds like a lot of work to set it up. (You have to install Putty and Filezilla or PSCP)
    3) Some students do have it working, or could do it easily, but, due to having to login to and switch back and forth between 2 or 3 different programs every time, still dont do it or are at least annoyed by it.
    eecs-york automates this process, so it feels like you have the Prism application on your own computer.

To use:

1. Install Node (v6.7.0^)
   
2. Run this command on your terminal:

$ npm install -g eecs-yorku

1. Set up your credentials with these two commands:

$  eecs-yorku set-user <your_username> 
$  eecs-yorku set-pass <your_password>

1. Test that it works with this command (it should give you the help page for the submit command):

$  eecs-yorku submit

1. To test the submission function run this command (replace the <file_placeholders> for real file names):

$   eecs-yorku submit fake_course fake_lab <a_file> <another_file>

1. the command above should return something like "there is no such course" (which means its working), and have uploaded your files to your prism account under /etc/home/<your_username>/submissions/fake_course/fake_lab

API:

set-user

$ eecs-yorku set-user <username>

Sets user to use for authorization. Stored in .json in user's home directory.

set-pass

$ eecs-yorku set-pass <password>

Sets password to use for authentication.

submit

$ eecs-yorku submit <course> <assignment> <file> <another-file> ... 

Uploads all given files (any number of files) to your Prism account and then calls the submit program with the information given. It returns the output to you, so if your file wasn't accepted, you'll get the response (this includes the style-checker feedback).

Whether your file is accepted or rejected, it is stored in your Prism account under /eecs/home/<username>/submissions/<course>/<assignment>.

A new submission of the same file (whether successful or not) will overwrite the previous upload.

$ eecs-yorku submit

Calling submit with no further parameters will return the help page from the Prism application.

show submission [not yet implemented]

$ eecs-yorku submit -l <course> <assignment>

Lists all files you have previously submitted for a specific assignment.

upload [not yet implemented]

$ eecs-yorku upload [dir] <file> <another-file> ...

Uploads a set of files without calling submit. A directory of choice within your account directory should be able to be selected.

You can upload your files right now just by providing nonsensical course and assignment names (for example "xx"). You cannot currently select a directory, however. Your files will be stored in the submissions directory.

set-rsa [not yet implemented]

eecs-yorku set-rsa ...

Set up rsa authentication