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
How it works
Sample PlantUML Document
@startuml
' scale 1000 width
!$disabled = "<color:lightgray><size:14>"
rectangle "<size:20>Client" as Client #LightCyan
rectangle "AUTH" as Auth
rectangle "API_GATEWAY" as APIG
rectangle GCP #LightCyan {
node "ServiceA" as ServiceA
node "ServiceB" as ServiceB
node "ServiceC" as ServiceC
queue "Kafka" as Queue
}
' start
Client -right[#lightgray]-> Auth : $disabled Get Token
Client -right[#lightgray]-> APIG : $disabled Pass token
APIG -up[#lightgray]-> Auth : $disabled Validate token
APIG -right[#lightgray]-> ServiceA : $disabled Pass token
ServiceA -up[#lightgray]-> Auth : $disabled Validate token
ServiceA -right[#lightgray]-> ServiceB : $disabled Pass token
ServiceB -up[#lightgray]-> Auth : $disabled Validate token
ServiceA -down[#lightgray]-> Queue : $disabled Pass token
Queue -down[#lightgray]-> ServiceC : $disabled Pass token
ServiceC -up[#lightgray]-> Auth : $disabled Validate token
' end
@enduml
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
animate_puml-0.4.1.tar.gz
(5.5 kB
view hashes)
Built Distribution
Close
Hashes for animate_puml-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29eb84a15a7d053ce372373d5c80e97af7a821245078bdb8efcf3392156cfb20 |
|
MD5 | 51814cd8137c5de9b164b66f727b7f37 |
|
BLAKE2b-256 | e5a47ecaba4b5eb763aef47c4e6ffe8332cc529895604dc4169d0f171106fbbc |