向ipython添加plantuml单元魔术的包。
IPlantUML的Python项目详细描述
这是什么?
这个python包定义了一个PlantUML单元格 伊普顿的魔法。它允许您在 你的笔记本。我会根据需要添加装饰。但是,现在,我只是 需要作为一个软件包(PYPI)工作和存在的东西。
我的代码基于Steven Burkeplantuml gist。
安装
首先,用pip安装iplantuml。
pip install iplantuml
然后,安装plantuml。在基于debian的系统上,您可以安装plantuml 包裹。否则您可以下载plantuml.jar并将其复制到 /usr/local/bin/plantuml.jar。
sudo apt install plantuml
或者,您可以在 安装
git clone https://github.com/jbn/IPlantUML.git
cd IPlantUML
python setup.py install iplantuml --jarpath /my/custom/path/plantuml.jar
使用量
在ipython,首先,
importiplantuml
然后,创建一个类似的单元格,
%%plantuml @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response @enduml
输出将是生成的svg uml图。
默认情况下,魔术将删除中间(tmp.uml)和目标 (tmp.svg)文件。但是,如果在^{tt5}中输入名称$ 第行,它同时保留$name.uml和$name.svg的文件。为了 示例,
%%plantuml auth @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response @enduml
生成并保留auth.uml和auth.svg。