Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

version 0.2.2

instructions on ipython-docent.appspot.com included
  • Loading branch information...
commit 9ca0d6f50c1b71a8b8a80aec2b48b0ae702d69de 1 parent ccba7af
Catherine Devlin authored
Showing with 23 additions and 8 deletions.
  1. +1 −0  CHANGES.txt
  2. +6 −1 README.txt
  3. +15 −6 ipython_doctester.py
  4. +1 −1  setup.py
View
1  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
View
7 README.txt
@@ -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
===========
@@ -37,4 +42,4 @@ https://github.com/catherinedevlin/ipython_doctester
Thanks to
=========
-Brian Granger for technical advice
+Brian Granger for technical advice
View
21 ipython_doctester.py
@@ -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
@@ -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)
View
2  setup.py
@@ -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",
Please sign in to comment.
Something went wrong with that request. Please try again.