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 main major providers including: AWS, Azure, GCP, Kubernetes, Alibaba Cloud, Oracle Cloud etc... It also supports On-Premise nodes, SaaS and major Programming frameworks and languages.

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.

Cloudiscovery helps you to analyze resources in your cloud (AWS/GCP/Azure/Alibaba/IBM) account. It allows you to create a diagram of analyzed cloud resource map based on this Diagrams library, so you can draw the your existing cloud infratructure with Cloudicovery.

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

Uploaded Source

Built Distribution

diagrams-0.15.0-py3-none-any.whl (13.7 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for diagrams-0.15.0.tar.gz
Algorithm Hash digest
SHA256 1c1637846d8ba57f0e5f3c731631665071d558aa1ea3dcda73c11a4698a4b612
MD5 c7645530781938deb9839cbfd456a287
BLAKE2b-256 041c9ee3bab63caf4d555f560f4f2a0f4fbc052296a79ec88a70e612d1d9cd32

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for diagrams-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee1430394c1dc3534db3352f1d08f47d4ca3b1ccc28f3673598526a55bdf20ed
MD5 96543b3c49c35c56f0251d15338e5ffd
BLAKE2b-256 09df21862ca8c0771cfd8a035c6f17fea27bafcb66b5bc9f253425cc7386c235

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