Plt Snippet
目前还是预览版
plt-snippet是一个提供matplotlib代码片段的软件,
旨在平缓matplotlib的学习曲线并降低其使用门槛。
- matplotlib的新用户可以使用GUI来帮助记忆绘图 API
- matplotlib的老用户可以快速插入代码片段
- 机构可以定制自己的绘图流程
Features
仅提供代码片段,可以简单修改后画图。
Requirements
matplotlib是一个用于数据可视化的Python包,使用前确保已安装:
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple matplotlib
推荐在ipynb
文件中使用此插件,
在 VS Code 中新建后缀为.ipynb
的文件后将自动推荐相关插件,
视网络情况可能需要手动安装ipykernel
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple ipykernel
同时保证 VS Code
版本高于 1.72.0
。
Extension Settings
plt-snippet.fontPath
: 配置本地字体路径,例如C:\\Users\\username\\Documents\\fonts\\songTimes.ttf
如果有问题可以发邮件到litchi.code@foxmail.com
或者在插件评论区中评论。
使用教程
...
如何自定义模板
制作模板ipynb文件
准备每个ipynb文件的封面图片
建议:
- 图片为png格式
- 宽高比近似1.1:1
- 图片文件大小建议小于50kB
- 若未指定、或不存在图片,模板logo会被替代为默认图片
准备 toml 格式配置文件
下面是一个例子
# 这是一个组
[group-a]
# 组名,会在html中显示为h2
title = "第一组"
# 在组group-a中添加模板条目
[[group-a.item]]
# 模板名称,显示在按钮上,可以是汉字
name = "item-a"
# 模板id,需要唯一,且为英文
id = "a"
# 模板封面图片,可以为相对路径
png = "cover/a.png"
# 模板文件需要为绝对路径
ipynb = "D:\\vscode_plugin\\plt-snippet\\customTemplate\\ipynb\\a.ipynb"
[[group-a.item]]
name = "item-b"
id = "b"
png = "cover/b.png"
ipynb = "D:\\vscode_plugin\\plt-snippet\\customTemplate\\ipynb\\b.ipynb"
# 这是另一个组
[group-b]
# 这是组名
title = "第二组"
[[group-b.item]]
name = "item-c"
id = "c"
png = "cover/c.png"
ipynb = "D:\\vscode_plugin\\plt-snippet\\customTemplate\\ipynb\\c.ipynb"
[[group-b.item]]
name = "item-d"
id = "d"
png = "cover/a.png"
ipynb = "D:\\vscode_plugin\\plt-snippet\\customTemplate\\ipynb\\d.ipynb"
对应的文件路径为
<dir>
|____template.toml
|____cover
| |____a.png
| |____b.png
| |____c.png
| |____d.png
|____ipynb
|____a.ipynb
|____b.ipynb
|____c.ipynb
|____d.ipynb
- 使用配套的小程序读取toml文件,将模板打包为 html 文件
程序基本使用方法:
usage: plt-snippet自定义模板生成器.exe [-h] [-f FILENAME] [-o OUTPUT]
读取 toml 格式文件,输出 VS Code 的 plt-snippet 插件可加载网页。
options:
-h, --help show this help message and exit
-f FILENAME, --filename FILENAME
toml 格式文件
-o OUTPUT, --output OUTPUT
输出网页文件名
其中
选项-f, --filename
指定输入的toml
配置文件路径,默认参数为template.toml
,
选项-o, --output
指定输出的html
文件路径,默认参数为template.html
。
配套的小程序未发布,需要的可以发邮箱到litchi.code@foxmail.com
索要(不收费)
- VS Code 的设置界面(
Ctrl+,
)中通过plt-snippet.cunstomTemplateHtml
配置 html 文件路径
TODO