maxschulz-COL commited on
Commit
bc995eb
·
verified ·
1 Parent(s): 0f8da72

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +79 -1
README.md CHANGED
@@ -7,4 +7,82 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ <br/><br/>
11
+
12
+ <p align="center">
13
+ <picture>
14
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/Vizro_Github_Banner_Dark_Mode.png">
15
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/Vizro_Github_Banner_Light_Mode.png">
16
+ <img alt="Vizro logo" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/Vizro_Github_Banner_Dark_Mode.png" width="250">
17
+ </picture>
18
+ </p>
19
+ <br/><br/>
20
+
21
+ <div align="center" markdown="1">
22
+
23
+ [![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue.svg)](https://pypi.org/project/vizro/)
24
+ [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro)
25
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md)
26
+ [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/)
27
+ [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858)
28
+
29
+ </div>
30
+
31
+ <div align="center" markdown="1">
32
+
33
+ <a href="https://vizro.readthedocs.io/en/stable/" target="_blank">Documentation </a> |
34
+ <a href="https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/" target="_blank">Get Started </a> |
35
+ <a href="http://vizro.mckinsey.com/" target="_blank">Live Demo </a>
36
+
37
+ </div>
38
+
39
+ ---
40
+
41
+ <p align="center">
42
+ <img src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/example_screens.png" width="700"/>
43
+ </p>
44
+
45
+ <p align="center">
46
+ <font size="+2">
47
+ <b>
48
+ Visual Intelligence. Beautifully Engineered
49
+ </b>
50
+ </font>
51
+ </p>
52
+
53
+ <p align="center">
54
+ <font size="+1">
55
+ Vizro is a toolkit for creating modular data visualization applications
56
+ </font>
57
+ </p>
58
+
59
+ <p align="center">
60
+ <img src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/tech_logos.png" width="300"/>
61
+ </p>
62
+
63
+ ## What is Vizro?
64
+
65
+ <p align="left">
66
+ <font size="+1">
67
+ Rapidly self-serve the assembly of customized dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python-enabled data visualization applications.
68
+ </font>
69
+ </p>
70
+
71
+ <p align="center">
72
+ <img src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/code_dashboard.png" width="1300"/>
73
+ </p>
74
+
75
+ Use a few lines of simple configuration to create complex dashboards, which are automatically assembled using libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices.
76
+
77
+ Define high-level categories within the configuration, including:
78
+
79
+ - **Components:** create charts, tables, input/output interfaces, and more.
80
+ - **Controls**: create filters, parameter inputs, and custom action controllers.
81
+ - **Pages, layouts and navigation**: create multiple pages, with customizable layouts and flexible navigation across them.
82
+ - **Actions and interactions**: create interactions between charts, and use pre-defined or customized actions (such as exporting).
83
+
84
+ Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation.
85
+
86
+ Optional high-code extensions enable almost infinite customization in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications.
87
+
88
+ Visit ["Why should I use Vizro?"](https://vizro.readthedocs.io/en/stable/pages/explanation/faq/#why-should-i-use-vizro) for a more detailed explanation of Vizro use cases.