Skip to main content

Diagram as Code

Project description

compat-fork-diagrams

This is a fork of the diagrams library to update it with support for newer Python versions.

Compat-fork changelog:

  • Version 0.24.1 (September 10, 2024)
    • Fix packaging
  • Version 0.24.0 (September 10, 2024)
    • Drop dependency on typed-ast to add support for Python 3.12 and 3.13

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

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.

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

compat_fork_diagrams-0.24.1.tar.gz (23.8 MB view details)

Uploaded Source

Built Distribution

compat_fork_diagrams-0.24.1-py3-none-any.whl (24.6 MB view details)

Uploaded Python 3

File details

Details for the file compat_fork_diagrams-0.24.1.tar.gz.

File metadata

  • Download URL: compat_fork_diagrams-0.24.1.tar.gz
  • Upload date:
  • Size: 23.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for compat_fork_diagrams-0.24.1.tar.gz
Algorithm Hash digest
SHA256 73210796792cb46f911096f01d746d3c5be41716da03f4d203e7f8d244545b1c
MD5 fd837aa7d2654b4597e7e3f9c6487aea
BLAKE2b-256 5fde392670cd0b5887b296ae314a9aa4a79add9d5715b1dde015370624c36f82

See more details on using hashes here.

File details

Details for the file compat_fork_diagrams-0.24.1-py3-none-any.whl.

File metadata

File hashes

Hashes for compat_fork_diagrams-0.24.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc1a7fa4ba2d37a9a463d359ba49c561782723d4b5c38990ac81bb1fbf205f56
MD5 cc7c4649c0bc0b7549e831c8ec11dd36
BLAKE2b-256 79095342a69ae85b6ccd39a4fcca10ed3fc7399a3eda4328b01d68b2ef11ed72

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