You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Benedikt Werner 4c2d8a3795
Improve wording of documentation (#990)
3 weeks ago
.github ci(test): remove support < Python3.9 6 months ago
assets/img fix: resize logo 4 years ago
diagrams feat(node): add GCP apigee (#905) 6 months ago
docker/dev chore: fixing go get deprecation (#713) 1 year ago
docs Improve wording of documentation (#990) 3 weeks ago
resources feat(node): add GCP apigee (#905) 6 months ago
scripts Improve wording of documentation (#990) 3 weeks ago
templates Improve wording of documentation (#990) 3 weeks ago
tests fix(tests): set lower for case sensitive system (#805) 1 year ago
website feat(node): add GCP apigee (#905) 6 months ago
.gitignore Add programming languages and frameworks (#112) 4 years ago
CHANGELOG.md docs(changelog): update PR links 3 years ago
CONTRIBUTING.md Improve wording of documentation (#990) 3 weeks ago
DEVELOPMENT.md Improve wording of documentation (#990) 3 weeks ago
LICENSE license: create LICENSE.md 4 years ago
README.md Add Apache Airflow as users of Diagrams (#956) 4 months ago
autogen.sh style: split the provider list by newline 1 year ago
config.py refactor(pvd/elastic): add an upper word and some aliases 1 year ago
poetry.lock chore(deps-dev): bump pytest from 7.2.0 to 7.3.0 (#875) 11 months ago
pyproject.toml bump: up to version 0.23.4 6 months ago

README.md

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