Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mingrammer/diagrams
:art: Diagram as Code for prototyping cloud system architectures
https://github.com/mingrammer/diagrams
architecture diagram diagram-as-code graphviz
Last synced: 5 days ago
JSON representation
:art: Diagram as Code for prototyping cloud system architectures
- Host: GitHub
- URL: https://github.com/mingrammer/diagrams
- Owner: mingrammer
- License: mit
- Created: 2020-02-02T15:23:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T12:57:09.000Z (9 months ago)
- Last Synced: 2024-04-22T12:20:44.028Z (9 months ago)
- Topics: architecture, diagram, diagram-as-code, graphviz
- Language: Python
- Homepage: https://diagrams.mingrammer.com
- Size: 46.7 MB
- Stars: 34,815
- Watchers: 389
- Forks: 2,242
- Open Issues: 376
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesomeLibrary - diagrams
- AiTreasureBox - mingrammer/diagrams - 01-07_40067_7](https://img.shields.io/github/stars/mingrammer/diagrams.svg)|🎨 Diagram as Code for prototyping cloud system architectures| (Repos)
- awesome - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- best-of-python - GitHub - 66% open · ⏱️ 13.04.2024): (Others)
- my-awesome-github-stars - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- awesome-ccamel - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- Awesome - Diagrams - Diagram as Code for prototyping cloud system architectures (Multimedia / Image and pictures)
- my-awesome-starred - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- awesome-python-resources - GitHub - 59% open · ⏱️ 10.08.2022): (数据可视化)
- awesome-repositories - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- awesome-sources - Diagram as Code - Diagrams lets you draw the cloud system architecture in Python code. (Tools)
- awesome-starts - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
- awesome-list - Diagrams - Lets you draw the cloud system architecture in Python code. (Data Visualization / Data Management)
- awesome-list - diagrams
- awesome-devops - diagrams - :art: Diagram as Code for prototyping cloud system architectures. (Other / Observability)
- my-awesome - mingrammer/diagrams - as-code,graphviz pushed_at:2025-01 star:40.0k fork:2.6k :art: Diagram as Code for prototyping cloud system architectures (Python)
- awesome-starred - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (others)
- StarryDivineSky - mingrammer/diagrams - Premise 节点、 SaaS 主要 Programming 框架和语言。 (其他__大数据 / 网络服务_其他)
- jimsghstars - mingrammer/diagrams - :art: Diagram as Code for prototyping cloud system architectures (Python)
README
![diagrams logo](assets/img/diagrams.png)
# Diagrams
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
[![pypi version](https://badge.fury.io/py/diagrams.svg)](https://badge.fury.io/py/diagrams)
![python version](https://img.shields.io/badge/python-%3E%3D%203.9-blue?logo=python)
![Run tests](https://github.com/mingrammer/diagrams/workflows/Run%20tests/badge.svg?branch=master)
[![todos](https://badgen.net/https/api.tickgit.com/badgen/github.com/mingrammer/diagrams?label=todos)](https://www.tickgit.com/browse?repo=github.com/mingrammer/diagrams)
![contributors](https://img.shields.io/github/contributors/mingrammer/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 main major providers including: `AWS`, `Azure`, `GCP`, `Kubernetes`, `Alibaba Cloud`, `Oracle Cloud` etc... It also supports `On-Premises` nodes, `SaaS` and major `Programming` frameworks and languages.
**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.
## Providers
![aws provider](https://img.shields.io/badge/AWS-orange?logo=amazon-aws&color=ff9900)
![azure provider](https://img.shields.io/badge/Azure-orange?logo=microsoft-azure&color=0089d6)
![gcp provider](https://img.shields.io/badge/GCP-orange?logo=google-cloud&color=4285f4)
![ibm provider](https://img.shields.io/badge/IBM-orange?logo=ibm&color=052FAD)
![kubernetes provider](https://img.shields.io/badge/Kubernetes-orange?logo=kubernetes&color=326ce5)
![alibaba cloud provider](https://img.shields.io/badge/AlibabaCloud-orange?logo=alibaba-cloud&color=ff6a00)
![oracle cloud provider](https://img.shields.io/badge/OracleCloud-orange?logo=oracle&color=f80000)
![openstack provider](https://img.shields.io/badge/OpenStack-orange?logo=openstack&color=da1a32)
![firebase provider](https://img.shields.io/badge/Firebase-orange?logo=firebase&color=FFCA28)
![digital ocean provider](https://img.shields.io/badge/DigitalOcean-0080ff?logo=digitalocean&color=0080ff)
![elastic provider](https://img.shields.io/badge/Elastic-orange?logo=elastic&color=005571)
![outscale provider](https://img.shields.io/badge/OutScale-orange?color=5f87bf)
![on premises provider](https://img.shields.io/badge/OnPremises-orange?color=5f87bf)
![generic provider](https://img.shields.io/badge/Generic-orange?color=5f87bf)
![programming provider](https://img.shields.io/badge/Programming-orange?color=5f87bf)
![saas provider](https://img.shields.io/badge/SaaS-orange?color=5f87bf)
![c4 provider](https://img.shields.io/badge/C4-orange?color=5f87bf)## Getting Started
It requires **Python 3.9** or higher, check your Python version first.
It uses [Graphviz](https://www.graphviz.org/) to render the diagram, so you need to [install Graphviz](https://graphviz.gitlab.io/download/) 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](https://brew.sh).
```shell
# using pip (pip3)
$ pip install diagrams# using pipenv
$ pipenv install diagrams# using poetry
$ poetry add diagrams
```You can start with [quick start](https://diagrams.mingrammer.com/docs/getting-started/installation#quick-start). Check out [guides](https://diagrams.mingrammer.com/docs/guides/diagram) for more details, and you can find all available nodes list in [here](https://diagrams.mingrammer.com/docs/nodes/aws).
## Examples
| Event Processing | Stateful Architecture | Advanced Web Service |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| ![event processing](https://diagrams.mingrammer.com/img/event_processing_diagram.png) | ![stateful architecture](https://diagrams.mingrammer.com/img/stateful_architecture_diagram.png) | ![advanced web service with on-premises](https://diagrams.mingrammer.com/img/advanced_web_service_with_on-premises.png) |You can find all the examples on the [examples](https://diagrams.mingrammer.com/docs/getting-started/examples) page.
## Contributing
To contribute to diagram, check out [contribution guidelines](CONTRIBUTING.md).
> Let me know if you are using diagrams! I'll add you in showcase page. (I'm working on it!) :)
## Who uses it?
[Apache Airflow](https://github.com/apache/airflow) is the most popular data workflow Orchestrator. Airflow uses Diagrams to generate architecture diagrams in their documentation.
[Cloudiscovery](https://github.com/Cloud-Architects/cloudiscovery) helps you to analyze resources in your cloud (AWS/GCP/Azure/Alibaba/IBM) account. It allows you to create a diagram of analyzed cloud resource map based on this Diagrams library, so you can draw your existing cloud infrastructure with Cloudiscovery.
[Airflow Diagrams](https://github.com/feluelle/airflow-diagrams) is an Airflow plugin that aims to easily visualise your Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.
## Other languages
- If you are familiar with Go, you can use [go-diagrams](https://github.com/blushft/go-diagrams) as well.
## License
[MIT](LICENSE)