Skip to main content

Diagram as Code

Project description

diagrams logo

Diagrams

license pypi version python version todos on premise provider aws provider azure provider gcp provider kubernetes provider alibaba cloud provider oracle cloud provider programming 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 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.

Getting Started

It requires Python 3.6 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.

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

Who use it?

GitPitch

GitPitch is a markdown presentation service for developers. Diagrams is now integrated as Cloud Diagram Widget of GitPitch, so you can use the Diagrams when to create slide decks for Tech Conferences, Meetups, and Training with GitPitch.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diagrams-0.11.0.tar.gz (11.1 MB view details)

Uploaded Source

Built Distribution

diagrams-0.11.0-py3-none-any.whl (11.6 MB view details)

Uploaded Python 3

File details

Details for the file diagrams-0.11.0.tar.gz.

File metadata

  • Download URL: diagrams-0.11.0.tar.gz
  • Upload date:
  • Size: 11.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Darwin/19.4.0

File hashes

Hashes for diagrams-0.11.0.tar.gz
Algorithm Hash digest
SHA256 ebaeaf89feda1059cadf4434f7c6d3899edb1bb21cef9a98b3d519f3da925510
MD5 bb37107e56a8e9a5bd7a3da3c43ca17a
BLAKE2b-256 941b9d14a7a45ab29ddc78d4b70dba3ffb5b970eea94917bcae31b160c857d08

See more details on using hashes here.

File details

Details for the file diagrams-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: diagrams-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Darwin/19.4.0

File hashes

Hashes for diagrams-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 931ce7c9bb9acc2ed191dcf62cc4799a5ebdb99f634566d542fce238dc879397
MD5 8072db47880814d4f47ab2306b8948e1
BLAKE2b-256 0bab138b0a3c9b21e60f60ec027da434963977a897c3aff4ccb78f010ba47d16

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page