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.
64 lines
1.6 KiB
64 lines
1.6 KiB
---
|
|
id: installation
|
|
title: Installation
|
|
---
|
|
|
|
**diagrams** requires **Python 3.7** or higher, check your Python version first.
|
|
|
|
**diagrams** uses [Graphviz](https://www.graphviz.org/) to render the diagram, so you need to [install Graphviz](https://graphviz.gitlab.io/download/) to use it.
|
|
|
|
> macOS users using [Homebrew](https://brew.sh) can install Graphviz via `brew install graphviz` . Similarly, Windows users with [Chocolatey](https://chocolatey.org) installed can run `choco install graphviz` or use [Winget](https://learn.microsoft.com/windows/package-manager/) via `winget install Graphviz.Graphviz -i`.
|
|
|
|
After installing Graphviz (or if you already have it), install **diagrams**:
|
|
|
|
```shell
|
|
# using pip (pip3)
|
|
$ pip install diagrams
|
|
|
|
# using pipenv
|
|
$ pipenv install diagrams
|
|
|
|
# using poetry
|
|
$ poetry add diagrams
|
|
|
|
# using uv
|
|
$ uv tool install diagrams
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```python
|
|
# 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:
|
|
|
|
```shell
|
|
$ 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.
|
|
|
|
```shell
|
|
$ diagrams diagram1.py diagram2.py
|
|
```
|
|
|
|
## Next
|
|
|
|
See more [Examples](/docs/getting-started/examples) or see the [Guides](/docs/guides/diagram) page for more details.
|