Metadata-Version: 2.1
Name: pelikan
Version: 0.0.5
Summary: a jupyter notebook tool to make notebooks comment-free
Home-page: https://github.com/ozlerhakan/palikan
Author: Hakan Ozler
Author-email: ozler.hakan@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/ozlerhakan/pelikan/issues
Keywords: python,jupyter,notebooks
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/plain; charset=UTF-8
License-File: LICENSE

# Pelikan :flamingo:

Pelikan lets you convert notebooks to comment-free notebooks. In other words, It removes Python block and inline comments from source cells in order to point out only source code.


## How it works

```
$ pip install pelikan

$ pelikan --help
usage: pelikan [-h] --notebook NOTEBOOK --output OUTPUT

optional arguments:
  -h, --help            show this help message and exit
  --notebook NOTEBOOK, -n NOTEBOOK
                        The notebook file we want to remove comments from
  --output OUTPUT, -o OUTPUT
                        The name of the newly created comment-free notebook.

$ pelikan -n notebook_file.ipynb -o voila
$ ls
notebook_file.ipynb voila.ipynb
```


## LICENSE

MIT

