Skip to main content

Diagram as Code

Project description

diagrams logo

Diagrams

license pypi version python version

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.

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

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

Uploaded Source

Built Distribution

diagrams-0.5.0-py3-none-any.whl (7.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: diagrams-0.5.0.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.3 CPython/3.7.6 Darwin/19.0.0

File hashes

Hashes for diagrams-0.5.0.tar.gz
Algorithm Hash digest
SHA256 3fbafe102456ffed4c7a832978980a290d11eed70f05a64d7ed475feb6581554
MD5 bbc8755508fae4246527ed0ccdbb1d6c
BLAKE2b-256 29a1232525e48f644384a6b36cb770fb0baed08acacfbc73a45a6c1cfa012032

See more details on using hashes here.

File details

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

File metadata

  • Download URL: diagrams-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.3 CPython/3.7.6 Darwin/19.0.0

File hashes

Hashes for diagrams-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7383a156aeab0175fed9605b4bcc82f20416e3b46772a7632080d4dbf54fa78
MD5 8d75e00c6993cba6831c6e9d9d0f567e
BLAKE2b-256 0e20f9e20da4adee2dbbebf9f9db5f80f3c2e3c873597a2421bd42ebf867406d

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