animate-puml 0.3.0

Simple animation of PlantUML diagrams

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

• 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.