跳转到主要内容

使用Markdown和图表将Python脚本转换为讲义

项目描述

Python讲义

PyPI

将Python脚本转换为带有Markdown注释和内联图表的讲义。Jupyter笔记本的替代品,没有隐藏状态,支持任何文本编辑器。

代码 讲义
Code Handout

入门

您可以在正常Python程序内部使用Python讲义作为库

  1. 通过pip3 install -U handout安装。
  2. 通过python3 script.py运行您的脚本。(您可以从仓库中的example.py开始。)
  3. 在您的浏览器中打开output/index.html以查看结果。
  4. 迭代并在浏览器中刷新。

功能

通过doc = handout.Handout(outdir)创建讲义以访问这些功能

功能 示例
通过三引号注释添加Markdown文本 """Markdown文本"""
通过print()语法添加文本。 doc.add_text('text:', variable)
添加从数组或URL的图像。 doc.add_image(image, 'png', width=1)
添加从数组或URL的视频。 doc.add_video(video, 'gif', fps=30, width=1)
添加matplotlib图表。 doc.add_figure(fig, width=1)
添加自定义HTML。 doc.add_html(string)
将添加的项目插入到<outdir>/index.html中并保存。 doc.show()

问题

请在Github上创建一个问题。

项目详情


下载文件

下载适用于您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

handout-1.1.2.tar.gz (18.9 kB 查看哈希值)

上传时间

由以下支持