42

GitHub - danijar/handout: Turn Python scripts into handouts with Markdown and fi...

 5 years ago
source link: https://github.com/danijar/handout
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

README.md

Python Handout

PyPI

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 Code Handout

Getting started

You use Python Handout as a library inside a normal Python program:

  1. Install via pip3 install -U handout.
  2. Run your script via python3 script.py. (You can start with the example.py from the repository.)
  3. Open output/index.html in your browser to view the result.
  4. Iterate and refresh your browser.

Features

Create the handout via doc = handout.Handout(outdir) to access these features:

Feature Example Add Markdown text as multi-line 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()

Questions

Feel free to create an issue on Github.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK