🎨 Diagram as Code for prototyping cloud system architectures
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.
 
 
 
 
 
Go to file
mingrammer 547eefd55b
feat: support inline rendering for jupyter notebook
5 years ago
assets/img fix: resize logo 5 years ago
diagrams feat: support inline rendering for jupyter notebook 5 years ago
docs Add `choco install graphviz` tip for Windows users 5 years ago
resources feat: support on-premise nodes 5 years ago
scripts feat: support on-premise nodes 5 years ago
templates feat: docs auto generation 5 years ago
tests Allow an output filename to be passed to Diagram explicitly. 5 years ago
website docs: reduce left/right paddings 5 years ago
.gitignore chore: update .gitignore 5 years ago
CONTRIBUTING.md feat: initial commit 5 years ago
LICENSE license: create LICENSE.md 5 years ago
README.md docs: update example postions and titles 5 years ago
autogen.sh feat: support on-premise nodes 5 years ago
config.py feat: add aliases for activemq/rabbitmq 5 years ago
poetry.lock feat: initial commit 5 years ago
pyproject.toml bump: up to version 0.6.2 5 years ago

README.md

diagrams logo

Diagrams

license pypi version python version on premise provider aws provider azure provider gcp provider kubernetes provider alibaba cloud provider oracle cloud provider

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 tracking the architecture diagram changes on any version control system.

NOTE: It does not control any actual cloud resources nor generate cloud formation or terraform code, but 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
event processing stateful architecture advanced web service with on-premise

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

License

MIT