Metadata-Version: 2.0
Name: nelson
Version: 0.4.1
Summary: Handling submission of code to Udacity for automatic feedback
Home-page: http://github.com/udacity/nelson
Author: S. Charles Brubaker
Author-email: cb@udacity.com
License: MIT
Keywords: Udacity Georgia Tech OMS
Platform: UNKNOWN
Requires-Dist: requests (>=2.2.1)
Requires-Dist: requests-toolbelt (>=0.7.0)
Requires-Dist: future

==============
nelson
==============

Projects for Georgia Tech's OMSCS program or for Udacity's advanced nanodegree programs are typically distributed with project-specific submission scripts that handle the submission to Udacity's advanced automatic feedback service.  These scripts typically rely on this underlying library, which contains most of the shared functionality.


Examples
---------

This is simple example for GTOMSCS.  It submits the file hello_world.py to the quiz named "hello_world" within the course "cs101".
::
    from nelson.gtomscs import submit

    def main():
        course = 'cs101'
        quiz = 'hello_world'
        filenames = ['hello_world.py']

        submit(course, quiz, filenames)

    if __name__ == '__main__':
        main()

For Udacity, simply import from ``nelson.udacity`` instead of ``nelson.gtomscs``.

Typical output would be something like
::
    GT Login required.
    Username :jbarros7
    Password :
    Save the jwt?[y,N]y
    Submission includes the following files:
        helloworld.c

    Uploading submission...
    [=========================== 100% ===========================] 376/376

    Waiting for results...Done!

    Results:
    --------
    Tests that the code compiles cleanly:                                        5/5
    Tests that the code prints "Hello World!":                                   5/5


    (Details available in helloworld-result-2017-01-04-22-41-22.json)


