Turn Python scripts into handouts with Markdown and figures
Python
2,035
48 commits
updated Aug 28, 2021
Turn Python scripts into handouts with Markdown comments and inline figures. An alternative to Jupyter notebooks without hidden state that supports any text editor.
| Code | Handout |
|---|---|
 |  |
You use Python Handout as a library inside a normal Python program:
pip3 install -U handout.python3 script.py. (You can start with
examples/start.py from the repository.)output/index.html in your browser to view the result.Create the handout via doc = handout.Handout(outdir) to access these features:
| Feature | Example |
|---|---|
| Add Markdown text as triple-quote comments. | """Markdown text""" |
Add text via print() syntax. | doc.add_text('text:', variable) |
| Add image from array or url. | doc.add_image(image, 'png', width=1) |
| Add video from array or url. | doc.add_video(video, 'gif', fps=30, width=1) |
| Add matplotlib figure. | doc.add_figure(fig, width=1) |
| Add custom HTML. | doc.add_html(string) |
Insert added items and save to <outdir>/index.html. | doc.show() |
Feel free to create an issue on Github.
Overall
Maintained
Code review
PyPI
Latest release
Releases this year
18 followers · starred Aug 2019
1,825 followers · starred Aug 2019
1,372 followers · starred Aug 2019
2,337 followers · starred Aug 2019
Turn Python scripts into handouts with Markdown and figures
Python
2,035
48 commits
updated Aug 28, 2021
Turn Python scripts into handouts with Markdown comments and inline figures. An alternative to Jupyter notebooks without hidden state that supports any text editor.
| Code | Handout |
|---|---|
| |
You use Python Handout as a library inside a normal Python program:
pip3 install -U handout.python3 script.py. (You can start with
examples/start.py from the repository.)output/index.html in your browser to view the result.Create the handout via doc = handout.Handout(outdir) to access these features:
| Feature | Example |
|---|---|
| Add Markdown text as triple-quote comments. | """Markdown text""" |
Add text via print() syntax. | doc.add_text('text:', variable) |
| Add image from array or url. | doc.add_image(image, 'png', width=1) |
| Add video from array or url. | doc.add_video(video, 'gif', fps=30, width=1) |
| Add matplotlib figure. | doc.add_figure(fig, width=1) |
| Add custom HTML. | doc.add_html(string) |
Insert added items and save to <outdir>/index.html. | doc.show() |
Feel free to create an issue on Github.
Overall
Maintained
Code review
PyPI
Latest release
Releases this year
18 followers · starred Aug 2019
1,825 followers · starred Aug 2019
1,372 followers · starred Aug 2019
2,337 followers · starred Aug 2019