Skip to main content

Diagram as Code

Project description

diagrams logo

:warning: This repo is an extension version for diagrams, since the upstream is inactive, this fork will use main/ as the active branch. I rename the project as diagrams-ext to avoid conflict with upstream since 0.23.5-alpha4.

Main Features:

How to use:

poertry add diagrams_ext

:warning: Check README_MAIN.md for more details

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

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 premise provider generic provider programming provider saas provider c4 provider

Getting Started

It requires Python 3.7 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?

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.

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_ext-0.23.5a5.tar.gz (23.9 MB view details)

Uploaded Source

Built Distribution

diagrams_ext-0.23.5a5-py3-none-any.whl (24.6 MB view details)

Uploaded Python 3

File details

Details for the file diagrams_ext-0.23.5a5.tar.gz.

File metadata

  • Download URL: diagrams_ext-0.23.5a5.tar.gz
  • Upload date:
  • Size: 23.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for diagrams_ext-0.23.5a5.tar.gz
Algorithm Hash digest
SHA256 ef5831a479c465e2d4dfe581c3b580a74a7a49e62654fdecfea2052554e82889
MD5 dc9fdc780c63ff6b778c1a111219bf41
BLAKE2b-256 935f9abb4a828e994a613a420cbc7254ffe025151817bbcaba24931ff7dffb6f

See more details on using hashes here.

File details

Details for the file diagrams_ext-0.23.5a5-py3-none-any.whl.

File metadata

  • Download URL: diagrams_ext-0.23.5a5-py3-none-any.whl
  • Upload date:
  • Size: 24.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for diagrams_ext-0.23.5a5-py3-none-any.whl
Algorithm Hash digest
SHA256 e8fd26efc43f2bca4bf7c659869bb84067e6c7c08b80de993010af413748e961
MD5 12aae06146163bcbfa57db6845253399
BLAKE2b-256 f5199dd059103275306e3677112801bbbfb57673f76915da3a1d2260cf46271d

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