Utility to turn IPython scripts into Jupyter Notebook format. Forked from py2nb project.
Project description
Features after forking:
- New token recognized for code cells, defined by
#%%
, used in Spyder and PyCharm scientific mode.
Original source repo readme follows...
PY2NB: Python To Notebook Converter
This is a small utility for turning python scripts into jupyter notebooks and convert module-level multiline (triple quote) string literals into markdown cells.
Why?
I wanted a tool to create user examples that can be executed as normal python scripts so that they can be copy-and-pasted easily and can be rendered as notebook for better readability (e.g nice styling, results embedded).
Also,
- Notebooks are nice to look at but slow to write
- Notebooks does not play well with version control
Install
python setup.py install
Usage
To convert a python script into a notebook:
python -m py2nb input.py output.ipynb
Additional commandline not from this package
Execute a notebook:
ipython nbconvert --to=notebook --execute input.ipynb
Convert a notebook to a HTML:
ipython nbconvert --to=html input.ipynb
Samples
See "samples" directory.
How?
Uses python tokenize
(builtin tokenizer library) for tokenization.
String literals with triple quote at column zero are converted into a comment
token with special <markdowncell>
and <codecell>
to feed into the python
importer in IPython version 3. The processed tokens are untokenized using the
tokenize
module so that untouched line looks exactly the same as the input.
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
Built Distribution
Hashes for py2jnb-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b62786b91bdd0802ef83a28aa2b68f58465cc1767c298f33fe8c0c65554cd58c |
|
MD5 | 588f83dfa444a134d18b5489f2d65ebf |
|
BLAKE2b-256 | 123978bb0c5d4a4723e8c9f6af154c39fc2d9571a320d9852bc9da265a1050b6 |