diagrams README

The project's README from github.com/mingrammer/diagrams. As one markdown file: README.md.

diagrams logo

Diagrams

license pypi version python version Run tests todos contributors

Buy Me A Coffee

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 azure provider gcp provider ibm provider kubernetes provider alibaba cloud provider oracle cloud provider openstack provider firebase provider digital ocean provider elastic provider outscale provider on premises provider generic provider programming provider saas provider c4 provider

Getting Started

Want to try it first? The online playground runs diagrams right in your browser — no installation required.

It requires Python 3.9 or higher, check your Python version first.

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.

Playground

diagrams.mingrammer.com/playground

A free online editor for diagrams: write Diagram as Code in Python and see the rendered architecture diagram instantly, without installing Python or Graphviz. It runs the real diagrams package in your browser via Pyodide, and supports node search, autocompletion, PNG/SVG/JPEG export, and shareable links. See the playground guide for details.

Examples

Event Processing Stateful Architecture Advanced Web Service
event processing stateful architecture advanced web service with on-premises

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!) :)

Who uses it?

Apache Airflow is the most popular data workflow Orchestrator. Airflow uses Diagrams to generate architecture diagrams in their documentation.

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 is an Airflow plugin that aims to easily visualise your Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.

KubeDiagrams is a tool to generate Kubernetes architecture diagrams from Kubernetes manifest files, kustomization files, Helm charts, and actual cluster state. KubeDiagrams supports all Kubernetes built-in resources, any custom resources, and label-based resource clustering.

AWS CloudFormation Diagrams is a simple CLI script to generate AWS architecture diagrams from AWS CloudFormation templates.

Other languages

License

MIT

diagrams (mingrammer/diagrams)

Searching Database…

42.7K ·GitHub
Diagrams
Что это такое?Diagrams — это библиотека для Python, которая рисует архитектуру облачных систем в виде кода: вы описываете свою конфигурацию AWS, Azure, GCP или Kubernetes на Python и получаете готовую диаграмму. Она создана для быстрого прототипирования архитектуры без дизайнерских инструментов.
Это библиотека, с которой я пишу код, или приложение для рисования?Библиотека для Python: вы описываете узлы и связи в коде, а Graphviz отрисовывает картинку. Есть ещё онлайн-песочница в браузере, так что попробовать можно без всякой локальной настройки.
Как это запустить?Сначала установите Python 3.9+ и Graphviz (на macOS через Homebrew: brew install graphviz), затем pip install diagrams. А чтобы вовсе обойтись без локальной установки — начните с онлайн-песочницы.
Оно разворачивает или управляет моими реальными облачными ресурсами?Нет — оно только рисует. Инструмент не управляет настоящими облачными ресурсами и не генерирует код CloudFormation или Terraform; на выходе — просто схема архитектуры.
Какие облачные провайдеры она поддерживает?Все основные: AWS, Azure, GCP, Kubernetes, Alibaba Cloud, Oracle Cloud, плюс локальные (on-premises) узлы, SaaS и популярные фреймворки и языки программирования. Полный список узлов есть по ссылке в README.
Почему описывать архитектуру кодом, а не рисовать в редакторе?Потому что диаграмма лежит в репозитории, как исходный код: подход Diagram as Code позволяет отслеживать изменения схемы в любой системе контроля версий, поэтому архитектуру ревьюят и сравнивают версий так же, как и весь остальной код.
Могу ли я попробовать без установки Python и Graphviz?Да — песочница на diagrams.mingrammer.com/playground запускает настоящий пакет diagrams прямо в браузере через Pyodide: есть поиск узлов, автодополнение, экспорт в PNG/SVG/JPEG и ссылки, которыми можно поделиться.
Кто использует её на практике?Apache Airflow генерирует с её помощью диаграммы архитектуры в своей документации, а Cloudiscovery, Airflow Diagrams, KubeDiagrams и CLI для диаграмм AWS CloudFormation построены поверх неё.
What are similar projects?drawio-skill, d2, system-atlas, awesome-software-architecture, architecture-diagram-generator, plantuml, gitdiagram, live-panel-skill
Which topics is it in?prototype, diagram, system-design, examples, infrastructure, architecture, visualization, kubernetes, documentation, cloud, devops, free
Creator
mingrammer
Size
72.4 MB
Stars
42.7K
Updated
CommitOct 15Releasev0.25.1Nov 22
Age
6y
Commits · 90 Days