Metadata-Version: 1.1
Name: pineapple
Version: 0.3
Summary: Utility functions for the Pineapple IPython/Jupyter front-end
Home-page: https://github.com/nwhitehead/pineapple-module/
Author: Nathan Whitehead
Author-email: nwhitehe@gmail.com
License: ISC
Description: pineapple-module
        ----------------
        
        This project is a Python module that defines some utility
        functions for the Pineapple IPython/Jupyter front-end.
        
        The goal is to standardize notebooks so that notebook authors
        can have a consistent and easy way for readers to reproduce their
        exact results with the least amount of hassle.
        
        Usage
        ~~~~~
        
        After importing the module, within IPython notebooks you get
        magic functions ``%pip``, ``%require``, and ``%runtest``.
        
        The ``%pip`` command lets you easily use the ``pip`` command
        directly to manage installed packages.
        
        The ``%require`` command shows all installed packages with versions
        if called with no arguments. If called with arguments, it will attempt
        to install the requested packages. Arguments are version specifiers,
        separated by spaces.
        
        The ``%runtest`` command takes any number of test case or test suite
        classes descended from ``unittest.TestCase`` or ``unittest.TestSuite``
        and runs them in the cell. It should also be compatible with ``unittest2``.
        
        ::
        
            import pineapple
            
            %pip install numpy
            
            %pip list
            
            %require numpy==1.9.2
            
            %require numpy==1.9.2 ipython==4.0.0
            
            %require
        
            %runtest MyTesterClass
        
Keywords: Pineapple,IPython,Jupyter,reproducible,versions,package,modules
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: IPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
