Skip to main content

Diagram as Code

Project description

diagrams logo

Diagrams

license pypi version python version Run tests todos

on premise provider aws provider azure provider gcp provider kubernetes provider alibaba cloud provider oracle cloud provider programming provider firebase provider elastic provider saas provider

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

Uploaded Source

Built Distribution

diagrams-0.14.0-py3-none-any.whl (13.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for diagrams-0.14.0.tar.gz
Algorithm Hash digest
SHA256 0c6fd33d6419a423e5c9fab04a04af12206747ece4a04ed4c6dd854b81cba9f9
MD5 18ca2a4983426af8f761b025f1934c73
BLAKE2b-256 9dd742df9ce43e907ee227879ab715aa6ca5c2fcb367013559ca440467754299

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for diagrams-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afcebb0df7f1443063c304c80d7021f69eadd9ce759a32441d5c2fbe1a5b16fe
MD5 9429737dfea3354c73fec53eddc6011e
BLAKE2b-256 04854634f44cef59e003f9feab72ced20188ca2e6f0d4e51dcf0453a23d30f23

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