Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create nbgrader quickstart command #466

Merged
merged 4 commits into from
Apr 4, 2016
Merged

Conversation

jhamrick
Copy link
Member

@jhamrick jhamrick commented Mar 9, 2016

Fixes #338

Ping @willingc -- can you test out this PR and let me know if you think this "quickstart" example works ok?

@jhamrick jhamrick added this to the 0.3.0 milestone Mar 9, 2016
@willingc
Copy link
Member

@jhamrick I had some difficulty testing it this weekend. I wasn't able to get quickstart running which is likely an environment issue on my side. I'll give it a shot later this week and/or we can jam through stuff at the dev meeting.

@jhamrick
Copy link
Member Author

Hmm, ok. What error did you get when you tried to run it?

@willingc
Copy link
Member

Basically quickstart didn't run so I'm almost 99% positive it's pilot error.

@jhamrick jhamrick force-pushed the quickstart branch 2 times, most recently from 1350b91 to 28a23d2 Compare March 28, 2016 18:22
@jhamrick
Copy link
Member Author

@willingc I have updated the docs for quickstart as per your comments to clarify the course id and the --force flag

@willingc
Copy link
Member

willingc commented Apr 4, 2016

@jhamrick Works as advertised :D

A nice enhancement might be to output a message after executing quickstart to tell the user how to begin using the quickstart.

@jhamrick
Copy link
Member Author

jhamrick commented Apr 4, 2016

Good idea. I'll add something along the lines of "edit the source files in ... and then release them with nbgrader assign ps1" and then also a link to the main docs for further information.

@willingc
Copy link
Member

willingc commented Apr 4, 2016

@jhamrick Do you want me to merge this as is? Or wait for the enhancement?

@jhamrick
Copy link
Member Author

jhamrick commented Apr 4, 2016

I will make the enhancement first.

@jhamrick
Copy link
Member Author

jhamrick commented Apr 4, 2016

This now will print:

$ nbgrader quickstart course101
[QuickStartApp | INFO] Creating directory '/Users/jhamrick/project/misc/course101'...
[QuickStartApp | INFO] Copying example from the user guide...
[QuickStartApp | INFO] Generating example config file...
[QuickStartApp | INFO] Done! The course files are located in '/Users/jhamrick/project/misc/course101'.

    To get started, you can edit the source notebooks located in:

        /Users/jhamrick/project/misc/course101/source/ps1

    Once you have edited them to your satisfaction, you can create
    the student version by running `nbgrader assign ps1` from the
    '/Users/jhamrick/project/misc/course101' directory.

    For further details, please see the full nbgrader documentation at:

        http://nbgrader.readthedocs.org/

Does that look good to you @willingc ?

@willingc willingc merged commit 8b8e89d into jupyter:master Apr 4, 2016
@willingc
Copy link
Member

willingc commented Apr 4, 2016

@jhamrick This looks great! I am pressing merge 🎉

@jhamrick jhamrick deleted the quickstart branch April 4, 2016 21:35
@jhamrick
Copy link
Member Author

jhamrick commented Apr 4, 2016

Thanks! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants