Simple animation for PlantUML diagrams
MIT License
Simple animation for PlantUML diagrams.
Animating sequence diagram.
Documentation: https://namuan.github.io/animate-puml
Source Code: https://github.com/namuan/animate-puml
PyPI: https://pypi.org/project/animate-puml/
brew install plantuml
pip install animate-puml
Given an example PlantUML document in assets/security.puml
:
animate-puml -i assets/security.puml -o assets/security-puml.gif
By default, the script will delete any temporary files generated during the animation process.
To keep the files, use the --debug
flag.
animate-puml -i assets/security.puml -o assets/security-puml.gif --debug
Each frame of the animation will wait for 1 second by default.
To change the wait time, use the --frame-duration
flag to specify the time in milliseconds.
animate-puml -i assets/security.puml -o assets/security-puml.gif --frame-duration 4000
Use the -h
flag to see all available options.
animate-puml -h
animate-puml
looks for three things in the PlantUML document:
' start
and ' end
comments to determine the start and end of lines to animate.!$disabled_arrow
and !$enabled_arrow
macros. These macros are used to enable/disable arrows.!$disabled
and !$enabled
macros. These macros are used to enable/disable text.See GenerateFrames
class in app.py for more details.
Clone this repository
Requirements:
Create a virtual environment and install the dependencies
poetry install
poetry shell
make build
A release is automatically published when a new version is bumped using make bump
.
See .github/workflows/build.yml
for more details.
Once the release is published, .github/workflows/publish.yml
will automatically publish it to PyPI.
This project is not affiliated with PlantUML.