Metadata-Version: 2.0
Name: notebook-cleaner
Version: 0.1.2
Summary: Remove code from HTML files rendered from Jupyter notebooks
Home-page: https://github.com/RAvdek/notebook_cleaner
Author: Russell Avdek
Author-email: russell.avdek@gmail.com
License: MIT
Keywords: ipython
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: beautifulsoup4
Requires-Dist: docopt

# `notebook_cleaner`

A command line tool for removing code blocks and prompts from an HTML export of an iPython notebook.

## Why?

You want to do some data analysis in iPython and you want to show your results to someone who doesn't care to see your code.

## Installation

`pip install notebook_cleaner`

## Usage

```
Usage:
  notebook_cleaner <infile> [<outfile>]
  notebook_cleaner (-h | --help)

Option:
  -h --help  	Prints this message
  -f --force    Don't prompt if a file is goint to be overwritten
```

If `<outfile>` doesn't exist or matches `<infile>`, you'll be prompted to verify it's okay to overwrite `<infile>`.

## An example

```
$ cd examples
$ ipython nbconvert my_notebook.ipynb
... nbconvert just created the new file examples/my_notebook.html ...
$ python notebook_cleaner.py my_notebook.html clean_notebook.html
New file: clean_notebook.html
```

[Here is link to the *before* picture](https://htmlpreview.github.io/?https://github.com/RAvdek/notebook_cleaner/blob/master/examples/my_notebook.html)

[... and a link to the *after* picture](https://htmlpreview.github.io/?https://github.com/RAvdek/notebook_cleaner/blob/master/examples/clean_notebook.html)

## To do
- Need to work out the removal of warnings.
- Images also leave behind some undesireable junk.
- More edge cases could become apparent with use


