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 openstack provider firebase provider outscale provider elastic provider generic provider programming 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 uses 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.

Airflow Diagrams is an Airflow plugin that aims to easily visualise your Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.

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

Uploaded Source

Built Distribution

diagrams-0.17.0-py3-none-any.whl (15.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: diagrams-0.17.0.tar.gz
  • Upload date:
  • Size: 14.6 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.17.0.tar.gz
Algorithm Hash digest
SHA256 86436166fd3a9b8dddb8ccce2716f458a55614527feedcb95ae4a8cdf5b7659f
MD5 c430cb2ec48c73b24cec39e9442d8b61
BLAKE2b-256 b7ffacc9cdaa4416088d13a3ecc4fd87fcfbb721a1e3aab0522bbf1b168d4ef5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: diagrams-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 15.2 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.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7fe4b0f3baa2416c5ac9cbb69bba9d1ddf6d62524a035f4e2afb3118b310fba5
MD5 cc1d5f0a312fe5a9e089a5562cd6f7c8
BLAKE2b-256 0ee93b53691337aa1e0648937fe08bdf81ec4daab190b18c4820e9a2ce27144d

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