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.

README.md 5.9 KiB

4 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. ![diagrams logo](assets/img/diagrams.png)
  2. # Diagrams
  3. [![license](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
  4. [![pypi version](https://badge.fury.io/py/diagrams.svg)](https://badge.fury.io/py/diagrams)
  5. ![python version](https://img.shields.io/badge/python-3.6%2C3.7%2C3.8-blue?logo=python)
  6. ![Run tests](https://github.com/mingrammer/diagrams/workflows/Run%20tests/badge.svg?branch=master)
  7. [![todos](https://badgen.net/https/api.tickgit.com/badgen/github.com/mingrammer/diagrams?label=todos)](https://www.tickgit.com/browse?repo=github.com/mingrammer/diagrams)
  8. ![on premise provider](https://img.shields.io/badge/provider-OnPremise-orange?color=5f87bf)
  9. ![aws provider](https://img.shields.io/badge/provider-AWS-orange?logo=amazon-aws&color=ff9900)
  10. ![azure provider](https://img.shields.io/badge/provider-Azure-orange?logo=microsoft-azure&color=0089d6)
  11. ![gcp provider](https://img.shields.io/badge/provider-GCP-orange?logo=google-cloud&color=4285f4)
  12. ![kubernetes provider](https://img.shields.io/badge/provider-Kubernetes-orange?logo=kubernetes&color=326ce5)
  13. ![alibaba cloud provider](https://img.shields.io/badge/provider-AlibabaCloud-orange)
  14. ![oracle cloud provider](https://img.shields.io/badge/provider-OracleCloud-orange?logo=oracle&color=f80000)
  15. ![openstack provider](https://img.shields.io/badge/provider-OpenStack-orange?logo=openstack&color=da1a32)
  16. ![firebase provider](https://img.shields.io/badge/provider-Firebase-orange?logo=firebase&color=FFCA28)
  17. ![outscale provider](https://img.shields.io/badge/provider-OutScale-orange?color=5f87bf)
  18. ![elastic provider](https://img.shields.io/badge/provider-Elastic-orange?logo=elastic&color=005571)
  19. ![generic provider](https://img.shields.io/badge/provider-Generic-orange?color=5f87bf)
  20. ![programming provider](https://img.shields.io/badge/provider-Programming-orange?color=5f87bf)
  21. ![saas provider](https://img.shields.io/badge/provider-SaaS-orange?color=5f87bf)
  22. <a href="https://www.buymeacoffee.com/mingrammer" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
  23. **Diagram as Code**.
  24. 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.
  25. **Diagram as Code** also allows you to **track** the architecture diagram changes in any **version control** system.
  26. > 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.
  27. ## Getting Started
  28. It requires **Python 3.6** or higher, check your Python version first.
  29. It uses [Graphviz](https://www.graphviz.org/) to render the diagram, so you need to [install Graphviz](https://graphviz.gitlab.io/download/) to use **diagrams**. After installing graphviz (or already have it), install the **diagrams**.
  30. > macOS users can download the Graphviz via `brew install graphviz` if you're using [Homebrew](https://brew.sh).
  31. ```shell
  32. # using pip (pip3)
  33. $ pip install diagrams
  34. # using pipenv
  35. $ pipenv install diagrams
  36. # using poetry
  37. $ poetry add diagrams
  38. ```
  39. You can start with [quick start](https://diagrams.mingrammer.com/docs/getting-started/installation#quick-start). Check out [guides](https://diagrams.mingrammer.com/docs/guides/diagram) for more details, and you can find all available nodes list in [here](https://diagrams.mingrammer.com/docs/nodes/aws).
  40. ## Examples
  41. | Event Processing | Stateful Architecture | Advanced Web Service |
  42. | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
  43. | ![event processing](https://diagrams.mingrammer.com/img/event_processing_diagram.png) | ![stateful architecture](https://diagrams.mingrammer.com/img/stateful_architecture_diagram.png) | ![advanced web service with on-premise](https://diagrams.mingrammer.com/img/advanced_web_service_with_on-premise.png) |
  44. You can find all the examples on the [examples](https://diagrams.mingrammer.com/docs/getting-started/examples) page.
  45. ## Contributing
  46. To contribute to diagram, check out [contribution guidelines](CONTRIBUTING.md).
  47. > Let me know if you are using diagrams! I'll add you in showcase page. (I'm working on it!) :)
  48. ## Who uses it?
  49. [![GitPitch](https://gitpitch.com/gpimg/logo.png)](https://gitpitch.com/)
  50. [GitPitch](https://gitpitch.com/) is a markdown presentation service for developers. Diagrams is now integrated as [Cloud Diagram Widget](https://gitpitch.com/docs/diagram-features/cloud-diagrams/) of GitPitch, so you can use the Diagrams when to create slide decks for Tech Conferences, Meetups, and Training with GitPitch.
  51. [Cloudiscovery](https://github.com/Cloud-Architects/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.
  52. [Airflow Diagrams](https://github.com/feluelle/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.
  53. ## Other languages
  54. - If you are familiar to Go, you can use [go-diagrams](https://github.com/blushft/go-diagrams) as well.
  55. ## License
  56. [MIT](LICENSE)