Skip to main content

Diagram as Code

Project description

diagrams logo

Diagrams

license pypi version python version Run tests todos contributors

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-Premises 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.

Providers

aws provider azure provider gcp provider ibm provider kubernetes provider alibaba cloud provider oracle cloud provider openstack provider firebase provider digital ocean provider elastic provider outscale provider on premises provider generic provider programming provider saas provider c4 provider

Getting Started

It requires Python 3.9 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-premises

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?

Apache Airflow is the most popular data workflow Orchestrator. Airflow uses Diagrams to generate architecture diagrams in their documentation.

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 your existing cloud infrastructure with Cloudiscovery.

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.

KubeDiagrams is a tool to generate Kubernetes architecture diagrams from Kubernetes manifest files, kustomization files, Helm charts, and actual cluster state. KubeDiagrams supports all Kubernetes built-in resources, any custom resources, and label-based resource clustering.

Other languages

  • If you are familiar with Go, you can use go-diagrams as well.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

diagrams-0.25.1-py3-none-any.whl (34.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: diagrams-0.25.1.tar.gz
  • Upload date:
  • Size: 33.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.10 Darwin/25.0.0

File hashes

Hashes for diagrams-0.25.1.tar.gz
Algorithm Hash digest
SHA256 87480ba0b2d26987a69f7d553aa0cb1cebf1406adc03fef7031bdfff026bfc51
MD5 701333b9e4e06133e5f026db9722735b
BLAKE2b-256 4991af38c647ba20a7b74c23ebb0b56e000f5f8fe80fefb21251e1d0445ac5b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: diagrams-0.25.1-py3-none-any.whl
  • Upload date:
  • Size: 34.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.10 Darwin/25.0.0

File hashes

Hashes for diagrams-0.25.1-py3-none-any.whl
Algorithm Hash digest
SHA256 90698eaa74c027dfffd8306ba7f08ee543959205024050a6357f34eae9961345
MD5 4a6376e89e96e5bed46facb75c4d3eb8
BLAKE2b-256 766083bb3b6c9ed994e2e6829c01261b64fdcbc0b7e239434be5c417a5e05bb2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page