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.2.tar.gz
(2.5 kB
view hashes)
Built Distribution
Close
Hashes for notebook_cleaner-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ecee527f191f2af4676fdaebaf2e2022153498ce0f7b1cecb042959c03677f2 |
|
MD5 | 968ae772ed9cf3aa0818999f4b263f5c |
|
BLAKE2b-256 | fd0fb7c48c23da834bd91e9523bae8feb59a77b1523a781d3ae2bd6621aaf349 |