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 6.0 KiB

4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
2 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
4 vuotta sitten
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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-%3E%3D%203.6-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. ![contributors](https://img.shields.io/github/contributors/mingrammer/diagrams)
  9. <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>
  10. **Diagram as Code**.
  11. 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.
  12. **Diagram as Code** also allows you to **track** the architecture diagram changes in any **version control** system.
  13. > 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.
  14. ## Providers
  15. ![aws provider](https://img.shields.io/badge/AWS-orange?logo=amazon-aws&color=ff9900)
  16. ![azure provider](https://img.shields.io/badge/Azure-orange?logo=microsoft-azure&color=0089d6)
  17. ![gcp provider](https://img.shields.io/badge/GCP-orange?logo=google-cloud&color=4285f4)
  18. ![ibm provider](https://img.shields.io/badge/IBM-orange?logo=ibm&color=052FAD)
  19. ![kubernetes provider](https://img.shields.io/badge/Kubernetes-orange?logo=kubernetes&color=326ce5)
  20. ![alibaba cloud provider](https://img.shields.io/badge/AlibabaCloud-orange?logo=alibaba-cloud&color=ff6a00)
  21. ![oracle cloud provider](https://img.shields.io/badge/OracleCloud-orange?logo=oracle&color=f80000)
  22. ![openstack provider](https://img.shields.io/badge/OpenStack-orange?logo=openstack&color=da1a32)
  23. ![firebase provider](https://img.shields.io/badge/Firebase-orange?logo=firebase&color=FFCA28)
  24. ![digital ocean provider](https://img.shields.io/badge/DigitalOcean-0080ff?logo=digitalocean&color=0080ff)
  25. ![elastic provider](https://img.shields.io/badge/Elastic-orange?logo=elastic&color=005571)
  26. ![outscale provider](https://img.shields.io/badge/OutScale-orange?color=5f87bf)
  27. ![on premise provider](https://img.shields.io/badge/OnPremise-orange?color=5f87bf)
  28. ![generic provider](https://img.shields.io/badge/Generic-orange?color=5f87bf)
  29. ![programming provider](https://img.shields.io/badge/Programming-orange?color=5f87bf)
  30. ![saas provider](https://img.shields.io/badge/SaaS-orange?color=5f87bf)
  31. ## Getting Started
  32. It requires **Python 3.6** or higher, check your Python version first.
  33. 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**.
  34. > macOS users can download the Graphviz via `brew install graphviz` if you're using [Homebrew](https://brew.sh).
  35. ```shell
  36. # using pip (pip3)
  37. $ pip install diagrams
  38. # using pipenv
  39. $ pipenv install diagrams
  40. # using poetry
  41. $ poetry add diagrams
  42. ```
  43. 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).
  44. ## Examples
  45. | Event Processing | Stateful Architecture | Advanced Web Service |
  46. | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
  47. | ![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) |
  48. You can find all the examples on the [examples](https://diagrams.mingrammer.com/docs/getting-started/examples) page.
  49. ## Contributing
  50. To contribute to diagram, check out [contribution guidelines](CONTRIBUTING.md).
  51. > Let me know if you are using diagrams! I'll add you in showcase page. (I'm working on it!) :)
  52. ## Who uses it?
  53. [GitPitch](https://gitpitch.github.io/gitpitch) is the perfect slide deck solution for Tech Conferences, Training, Developer Advocates, and Educators. Diagrams is now available as a dedicated [Cloud Diagram Markdown Widget](https://gitpitch.github.io/gitpitch/#/diagrams/cloud-architecture) so you can use Diagrams directly on any slide for conferences, meetups, and training.
  54. [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 your existing cloud infrastructure with Cloudiscovery.
  55. [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.
  56. ## Other languages
  57. - If you are familiar to Go, you can use [go-diagrams](https://github.com/blushft/go-diagrams) as well.
  58. ## License
  59. [MIT](LICENSE)