Simple animation of PlantUML diagrams
Project description
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
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for animate_puml-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4002477bb2a2c74549ff01e059428f3f8ccf5859ce3cbb16052bd79623690316 |
|
MD5 | 52ce51152ec481ae8225492f7ed36acc |
|
BLAKE2b-256 | a84351709f6144a903caa87293d699c358a9b2ddad22aac0d53588c7e5309da5 |