Skip to main content

a jupyter notebook tool to make notebooks comment-free

Project description

# 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelikan-0.0.5.tar.gz (4.0 kB view details)

Uploaded Source

Built Distributions

pelikan-0.0.5-py3.9.egg (6.6 kB view details)

Uploaded Source

pelikan-0.0.5-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file pelikan-0.0.5.tar.gz.

File metadata

  • Download URL: pelikan-0.0.5.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for pelikan-0.0.5.tar.gz
Algorithm Hash digest
SHA256 101e83cccfc3316a09ca32f4a2149396ba00b0236e68a81d051d19d211cdfcac
MD5 9180bbbe7b73f86200126ca1457081f6
BLAKE2b-256 235de7565e60e5690e1a8706a454bbd97855d241717a28fb7d90922251563c3b

See more details on using hashes here.

File details

Details for the file pelikan-0.0.5-py3.9.egg.

File metadata

  • Download URL: pelikan-0.0.5-py3.9.egg
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for pelikan-0.0.5-py3.9.egg
Algorithm Hash digest
SHA256 d75041cdb322e3c99eae5e6a16a82744a40664ae5f3d51cb7a951d38ac6d3020
MD5 8231181afc886f0f79dff7fc23333a23
BLAKE2b-256 5741efa6a4e5065a58d2928a6a3ca2460c6e9bd644b4ce9b7d70e0cf8a45cd12

See more details on using hashes here.

File details

Details for the file pelikan-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: pelikan-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for pelikan-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 559ffb19aeb7dc7b4cf4667341fc04c187eea6175f1c36e5346f0824eee6b9f5
MD5 fd31a4758ef3aabf9510d4d22d2c6c8e
BLAKE2b-256 fc962d98316269d3ec06651ec877792167606b5a7cf246f45c240bfc16a2cb3e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page