Metadata-Version: 1.1
Name: nbstripout
Version: 0.2.2
Summary: Strips outputs from Jupyter and IPython notebooks
Home-page: https://github.com/kynan/nbstripout
Author: Florian, Rathgeber, Michael McNeil Forbes
Author-email: florian.rathgeber@gmail.com, michael.forbes+python@gmail.com
License: License :: OSI Approved :: MIT License
Description: .. image:: https://travis-ci.org/kynan/nbstripout.svg?branch=master
            :target: https://travis-ci.org/kynan/nbstripout
        
        nbstripout: strip output from Jupyter and IPython notebooks
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Opens a notebook, strips its output, and writes the outputless version to the
        original file.
        
        Useful mainly as a git filter or pre-commit hook for users who don't want to
        track output in VCS.
        
        This does mostly the same thing as the `Clear All Output` command in the
        notebook UI.
        
        Based on https://gist.github.com/minrk/6176788.
        
        Usage
        =====
        
        Strip output from IPython / Jupyter notebook (modifies the files in-place): ::
        
            nbstripout FILE.ipynb [FILE2.ipynb ...]
        
        Force processing of non ``.ipynb`` files: ::
        
            nbstripout -f FILE.ipynb.bak
        
        Use as part of a shell pipeline: ::
        
            FILE.ipynb | nbstripout > OUT.ipynb
        
        Set up the git filter and attributes as described in the manual installation
        instructions below: ::
        
            nbstripout install
        
        Remove the git filter and attributes: ::
        
            nbstripout uninstall
        
        Show this help page: ::
        
            nbstripout help
        
        Manual filter installation
        ==========================
        
        Set up a git filter using nbstripout as follows: ::
        
            git config filter.nbstripout.clean '/path/to/nbstripout'
            git config filter.nbstripout.smudge cat
            git config filter.nbstripout.required true
        
        Create a file ``.gitattributes`` or ``.git/info/attributes`` with: ::
        
            *.ipynb filter=nbstripout
        
        Mercurial usage
        ===============
        
        Mercurial does not have the equivalent of smudge filters.  One can use
        an encode/decode hook but this has some issues.  An alternative
        solution is to provide a set of commands that first run ``nbstripout``,
        then perform these operations. This is the approach of the `mmf-setup`_
        package.
        
        .. _mmf-setup: http://bitbucket.org/mforbes/mmf_setup
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Framework :: IPython
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Version Control
