Remove code from HTML files rendered from Jupyter notebooks
Project description
# `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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
notebook_cleaner-0.1.3.tar.gz
(2.5 kB
view hashes)
Built Distribution
Close
Hashes for notebook_cleaner-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10f3784bde2c652b388155bad36b46b2371b0dfb1648f34399e6f282b21232da |
|
MD5 | 2580e9b1f6195bb5d6d9655a3458af49 |
|
BLAKE2b-256 | 160aa2ad0d28fdbee409c4a40ac61c1a96566b332b18994faccf0f36af628f52 |