Skip to main content

Diagram as Code

Project description

diagrams logo

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 four major providers: AWS, Azure, GCP and Kubernetes.

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. And you can go guides for more details.

Examples

Grouped Workers on AWS Stateful Architecture on k8s Event Processing on AWS
grouped workers stateful architecture event processing

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

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.2.1.tar.gz (5.5 MB view details)

Uploaded Source

Built Distribution

diagrams-0.2.1-py3-none-any.whl (5.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: diagrams-0.2.1.tar.gz
  • Upload date:
  • Size: 5.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.5 Darwin/19.0.0

File hashes

Hashes for diagrams-0.2.1.tar.gz
Algorithm Hash digest
SHA256 56494ca65a93c85e0c8ce07daab26e182f29163fc953384069eb588ae3b44b27
MD5 0b46187337368d1d5df187c6d7c782b3
BLAKE2b-256 17791e6ec21276491d875bac8c8aa4e91245c360d59f36b4b55553f4730432ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: diagrams-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.5 Darwin/19.0.0

File hashes

Hashes for diagrams-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d44419d122db8503896101eb09560c6c4acc06efe1d26308ba05f7e3656b3dd
MD5 d0a1a957534340670123c2afa098f629
BLAKE2b-256 2d3a12c3c93ec0aa26767c69588e6a24dc189ee54d60875724e9674e0f62c085

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