mirror of https://github.com/mingrammer/diagrams
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.6 KiB
1.6 KiB
id | title |
---|---|
installation | Installation |
diagrams requires Python 3.7 or higher, check your Python version first.
diagrams uses Graphviz to render the diagram, so you need to install Graphviz to use it.
macOS users using Homebrew can install Graphviz via
brew install graphviz
. Similarly, Windows users with Chocolatey installed can runchoco install graphviz
or use Winget viawinget install Graphviz.Graphviz -i
.
After installing Graphviz (or if you already have it), install diagrams:
# using pip (pip3)
$ pip install diagrams
# using pipenv
$ pipenv install diagrams
# using poetry
$ poetry add diagrams
# using uv
$ uv tool install diagrams
Quick Start
# diagram.py
from diagrams import Diagram
from diagrams.aws.compute import EC2
from diagrams.aws.database import RDS
from diagrams.aws.network import ELB
with Diagram("Web Service", show=False):
ELB("lb") >> EC2("web") >> RDS("userdb")
To generate the diagram, run:
$ python diagram.py
This generates the diagram below:
It will be saved as web_service.png
in your working directory.
CLI
With the diagrams
CLI you can process one or more diagram files at once.
$ diagrams diagram1.py diagram2.py