mingrammer/diagrams
:art: Diagram as Code for prototyping cloud system architectures
repo name | mingrammer/diagrams |
repo link | https://github.com/mingrammer/diagrams |
homepage | https://diagrams.mingrammer.com |
language | Python |
size (curr.) | 12356 kB |
stars (curr.) | 2287 |
created | 2020-02-02 |
license | MIT License |
Diagrams
Diagram as Code.
Diagrams lets you draw the cloud system architecture in Python code. It was born for prototyping a new system architecture design without any design tools. You can also describe or visualize the existing system architecture as well. Diagrams currently supports six major providers: AWS
, Azure
, GCP
, Kubernetes
, Alibaba Cloud
and Oracle Cloud
. It now also supports On-Premise
nodes.
Diagram as Code also allows you to track the architecture diagram changes in any version control system.
NOTE: It does not control any actual cloud resources nor does it generate cloud formation or terraform code. It is just for drawing the cloud system architecture diagrams.
Getting Started
It uses Graphviz to render the diagram, so you need to install Graphviz to use diagrams. After installing graphviz (or already have it), install the diagrams.
macOS users can download the Graphviz via
brew install graphviz
if you’re using Homebrew.
# using pip (pip3)
$ pip install diagrams
# using pipenv
$ pipenv install diagrams
# using poetry
$ poetry add diagrams
You can start with quick start. Check out guides for more details, and you can find all available nodes list in here.
Examples
Event Processing | Stateful Architecture | Advanced Web Service |
---|---|---|
You can find all the examples on the examples page.
Contributing
To contribute to diagram, check out contribution guidelines.
Let me know if you are using diagrams! I’ll add you in showcase page. (I’m working on it!) :)