Skip to content

Commit

Permalink
version 0.2.2
Browse files Browse the repository at this point in the history
instructions on ipython-docent.appspot.com included
  • Loading branch information
Catherine Devlin committed Mar 14, 2013
1 parent ccba7af commit 9ca0d6f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES.txt
@@ -1,3 +1,4 @@
v0.1.0, Nov 3 2012 -- Initial release
v0.2.0, Dec 16 2012 -- optional ``verbose``; report results to ipython-docent.appspot.com
v0.2.1, Dec 16 2012 -- include requests module in requirements
v0.2.2, Mar 14 2013 -- include ipython-docent.appspot.com integration
7 changes: 6 additions & 1 deletion README.txt
Expand Up @@ -29,6 +29,11 @@ In each subsequent cell, set up objects with their doctests, and with absent

Tests will run on each cell as it is executed.

If you want to track students' progress through a notebook in a
classroom setting, you can; see
http://ipython-docent.appspot.com/
for instructions.

Development
===========

Expand All @@ -37,4 +42,4 @@ https://github.com/catherinedevlin/ipython_doctester
Thanks to
=========

Brian Granger for technical advice
Brian Granger for technical advice
21 changes: 15 additions & 6 deletions ipython_doctester.py
Expand Up @@ -6,7 +6,13 @@
If you want to turn off automatic testing but don't want to take the @test
decorators off, set ipython_doctester.run_tests = False.
Note: It's easy to cheat by simply deleting or changing the doctest.
Note: It's easy to cheat by simply deleting or changing the doctest. That's
OK, cheating is learning, too.
If you want to track students' progress through a notebook in a
classroom setting, you can; see
http://ipython-docent.appspot.com/
for instructions.
Developed for the Dayton Python Workshop:
https://openhatch.org/wiki/Dayton_Python_Workshop
Expand All @@ -21,17 +27,20 @@
import requests
import IPython.zmq.displayhook

__version__ = '0.2.1'
__version__ = '0.2.2'
finder = doctest.DocTestFinder()
docent_url = 'http://ipython-docent.appspot.com'

"""Set these per session as desired.
Setting a workshop_name and student_name will register results with IPython Docent
under the url http://"""
"""Set these per session, as desired."""
run_tests = True
verbose = False # ``True`` causes the result table to print,
# even for successes

"""Set these if desired to track student progress
at http://ipython-docent.appspot.com/.
See that page for more instructions."""
student_name = None
workshop_name = None
verbose = False # True causes the result table to print even for successes

def running_from_notebook():
return isinstance(sys.displayhook, IPython.zmq.displayhook.ZMQShellDisplayHook)
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -4,7 +4,7 @@
name='ipython_doctester',
author='Catherine Devlin',
author_email='catherine.devlin@gmail.com',
version='0.2.1',
version='0.2.2',
url='http://pypi.python.org/pypi/ipython_doctester/',
py_modules = [
"ipython_doctester",
Expand Down

0 comments on commit 9ca0d6f

Please sign in to comment.