animate-puml

PlantUML Animation

Simple animation for PlantUML diagrams.

---

Documentation: https://namuan.github.io/animate-puml

Source Code: https://github.com/namuan/animate-puml

PyPI: https://pypi.org/project/animate-puml/

---

Pre-requisites

• PlantUML

  brew install plantuml
  

Installation

pip install animate-puml

Usage

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

Acknowledgements

• PlantUML

Development

• Clone this repository

• Requirements:

  • Python 3.7+
  • Poetry

• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Validating build

make build

Release process

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.

Disclaimer

This project is not affiliated with PlantUML.