Metadata-Version: 1.0
Name: ipython-doctester
Version: 0.2.2
Summary: Run doctests in individual IPython Notebook cells
Home-page: http://pypi.python.org/pypi/ipython_doctester/
Author: Catherine Devlin
Author-email: catherine.devlin@gmail.com
License: MIT
Description: =================
        ipython_doctester
        =================
        
        Lets you run the doctests of a single class or function at a time.  Useful for 
        tutorials based on the IPython Notebook, using doctests for student feeback.
        
        Install with ``pip install ipython_doctester``, or 
        navigate to this directory and run::
        
            python setup.py install
        
        Use
        ===
        
        Run ``ipython notebook``, then start your notebook with this import::
        
            In [1]: from ipython_doctester import test
        
        In each subsequent cell, set up objects with their doctests, and with absent 
        (or flawed) function bodies, and decorate them with @test::
        
            In [2]: @test
                    def square(x):
                        '''
                        >>> f(2)
                        4
                        '''
                        
        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
        ===========
        
        https://github.com/catherinedevlin/ipython_doctester
        
        Thanks to
        =========
        
        Brian Granger for technical advice
        
Platform: UNKNOWN
