dac - Diagrams as Code

Combinations of Diagrams as Code tools, aiming for a minimal workflow.

Motivation

Diagrams really aid understanding a software system or architecture and the tooling around such diagramming techniques are not quite straight forward or need installation of many dependencies. We use a minimal docker image and container to run all diagram processing.

Tools

The project includes ability to generate diagrams from code using:

• Python - diagrams. Generates architecture diagrams from python code.
• Uml - plantuml. Generates any uml diagram.
• C4 Model - c4-plantuml. Generates diagrams from uml code with C4 resources available.
• Docker - To run and containerize the tools.

Example Outputs (png)

C4

Uml

Python

Workflow

make help

Run container

make run-container

• builds the docker image and runs the container

Generate Diagrams

C4 Model

filename=test_c4 inputext=puml outputext=png make diagrams-uml

UML

filename=test inputext=uml outputext=png make diagrams-uml

Python

filename=consumer inputext=py outputext=png make diagrams-py

Stop container

make stop-container