Package which adds a PlantUML cell magic to IPython.
What is it?
This Python package defines a PlantUML cell magic for IPython. It lets you generate UML diagrams as inline SVG in your notebook. I’ll add embellishments as needed. But, for now, I just needed something that worked and existed as a package (in pypi).
First, install IPlantuml with pip.
pip install iplantuml
Then, install plantuml. On Debian based system you can install plantuml package. Otherwise you can download plantuml.jar and copy it to /usr/local/bin/plantuml.jar.
sudo apt install plantuml
Alternatively you can set a custom path for plantuml.jar during installation
git clone https://github.com/jbn/IPlantUML.git cd IPlantUML python setup.py install iplantuml --jarpath /my/custom/path/plantuml.jar
In Ipython, first,
then, create a cell like,
%%plantuml @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response @enduml
The output will be the generated SVG UML diagram.
By default, the magic removes the intermediate (tmp.uml) and target (tmp.svg) files. However, if you enter a name in the %%plantuml line, it retains both files of $name.uml and $name.svg. For example,
%%plantuml auth @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response @enduml
generates and retains auth.uml and auth.svg.