From 70ee1c03453946321bcf73090ba1d4b37348d9ea Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 13:47:33 +0100 Subject: [PATCH 01/20] Simplify html code --- vizro-core/README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index e7cf7a833..1284c35f5 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -1,41 +1,31 @@ -

-

+ +

+ Vizro logo -

-
- -
- -Vizro is a low-code toolkit for building high-quality data visualization apps - -
- -
-[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) +#### Vizro is a low-code toolkit for building high-quality data visualization apps -
+[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) +[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) +[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) -
+[Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) -Documentation | Get Started | Vizro examples gallery -
---- -

-

-

-

+ +
## What is Vizro? From 53a9c822c7ed51afc3f4b5ffcb8caae00cf561e4 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 12:50:20 +0000 Subject: [PATCH 02/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 1284c35f5..e6d00d113 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -1,5 +1,3 @@ - -
@@ -10,17 +8,10 @@ #### Vizro is a low-code toolkit for building high-quality data visualization apps -[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) -[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) -[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) +[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) - - - From 628f30ac8a1fcd462d912801377a8e653f577875 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 13:59:12 +0100 Subject: [PATCH 03/20] Fix --- vizro-core/README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 1284c35f5..cbde2a206 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -1,6 +1,6 @@ +

- -
+
@@ -18,11 +18,8 @@ [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) - - - +--- -
@@ -35,20 +32,18 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. -

+

- + Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. - -

+
-
The benefits of the Vizro toolkit include: -

+

-

+
Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. From 5e9180ee993948166d845fac29ecaffddd79c30a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 12:59:56 +0000 Subject: [PATCH 04/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index cbde2a206..b35e28e8a 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -10,15 +10,12 @@ #### Vizro is a low-code toolkit for building high-quality data visualization apps -[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) -[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) -[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) +[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) --- + @@ -36,8 +33,8 @@ Then customize and deploy your app to production at scale. Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. -
+
The benefits of the Vizro toolkit include: From f28c724c66c41db26988d716cc0d70e8c58a3ed9 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 14:10:01 +0100 Subject: [PATCH 05/20] Check if we can center image directly --- vizro-core/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index cbde2a206..6ec635216 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -32,18 +32,16 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. -
- + Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. -
+
The benefits of the Vizro toolkit include: -
- -
+ + Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. From 0bad9200cc991860f70d480f32546c38c87bb78a Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 14:11:10 +0100 Subject: [PATCH 06/20] Lint --- vizro-core/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 6ec635216..9bafe9739 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -10,10 +10,10 @@ #### Vizro is a low-code toolkit for building high-quality data visualization apps -[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) -[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) -[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) +[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) +[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) +[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) From 1929ac9ed4846b07f315e60c22f0cb6f22f16888 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:11:42 +0000 Subject: [PATCH 07/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 9bafe9739..a8fbbc638 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -10,15 +10,12 @@ #### Vizro is a low-code toolkit for building high-quality data visualization apps -[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) -[![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) -[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) -[![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) +[![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) --- + @@ -42,7 +39,6 @@ The benefits of the Vizro toolkit include: - Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. ## Why use Vizro? From e1d1942f13610fd6c9679225e9903b9fbbb6e79f Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 14:47:12 +0100 Subject: [PATCH 08/20] Check how it looks like --- vizro-core/README.md | 33 ++++++++++----------------------- 1 file changed, 10 insertions(+), 23 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index a8fbbc638..103f98d4e 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -77,41 +77,28 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ## How to use Vizro? -
+ +

Vizro framework

-
-

Vizro framework

- -

Low-code framework for building dashboards. +**Low-code framework for building dashboards.** The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). -Visit the documentation for more details. - -

-
- - -
+Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details.

-
- -
-

Visual vocabulary

+ +

Visual vocabulary

-

- Chart examples. +**Chart examples.** -The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. +The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code +to create these charts with Plotly or embed them into a Vizro dashboard. -Visit the visual vocabulary to search for charts or get inspiration. +Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. -

-
-


From fccfe8e42d4c8ee082033585eb69b282676cfaf8 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:47:47 +0000 Subject: [PATCH 09/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 103f98d4e..3f1027a65 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -94,12 +94,10 @@ Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more deta **Chart examples.** -The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code -to create these charts with Plotly or embed them into a Vizro dashboard. +The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. -

From 4dfa9a3acd03d7e46c42ef5979447b6fc1ba5870 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:04:32 +0100 Subject: [PATCH 10/20] Check if it looks terrible --- vizro-core/README.md | 50 +++++++++++++++++++------------------------- 1 file changed, 21 insertions(+), 29 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 3f1027a65..6e1b15ce2 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -14,11 +14,12 @@ [Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) ---- +
+
+
- ## What is Vizro? @@ -29,15 +30,17 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. - - -Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. +
+ +Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality +multi-page prototypes. +

The benefits of the Vizro toolkit include: - + Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. @@ -77,7 +80,7 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ## How to use Vizro? - +

Vizro framework

**Low-code framework for building dashboards.** @@ -89,7 +92,7 @@ Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more deta

- +

Visual vocabulary

**Chart examples.** @@ -101,40 +104,29 @@ Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to

-
-
-

Vizro examples gallery

+ +

Vizro examples gallery

-

- Dashboard examples. +**Dashboard examples.** The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. -Visit the dashboard examples gallery to see the dashboards in action. - -

-
- -
+Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action.

-
- -
-

Vizro-AI

+ +

Vizro-AI

-

- LLM generated charts and dashboards. +**LLM generated charts and dashboards.** Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. -Visit the Vizro-AI documentation for more details. +Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. -

-
-
+
+
## Installation and first steps From 5a186e8eb8616aed6a34cad80bae09bc51a4f56f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 14:04:58 +0000 Subject: [PATCH 11/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 6e1b15ce2..cbf10c526 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -32,7 +32,7 @@ Then customize and deploy your app to production at scale.
-Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality +Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes.
From 7017451a4a370e2ce8f932d8a070bf6bfa79154d Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:16:09 +0100 Subject: [PATCH 12/20] Check if it looks better --- vizro-core/README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 6e1b15ce2..cb6e4bffe 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -80,8 +80,9 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ## How to use Vizro? - -

Vizro framework

+### [Vizro framework](https://vizro.readthedocs.io/en/stable/) + + **Low-code framework for building dashboards.** @@ -90,10 +91,11 @@ The Vizro framework underpins the entire Vizro toolkit. It is a Python package ( Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details.
-
- -

Visual vocabulary

+ +### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) + + **Chart examples.** @@ -101,11 +103,11 @@ The visual vocabulary helps you to decide which chart type to use for your requi Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. -

- -

Vizro examples gallery

+### [Vizro examples gallery](https://vizro.mckinsey.com/) + + **Dashboard examples.** @@ -113,11 +115,11 @@ The dashboard examples gallery enables you to explore Vizro in action by viewing Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. -

- -

Vizro-AI

+### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) + + **LLM generated charts and dashboards.** @@ -125,7 +127,6 @@ Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorpo Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. -

## Installation and first steps From 35506334ef063a356e040422e89abd8e975c93e5 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 14:16:53 +0000 Subject: [PATCH 13/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index d6b8ea783..2b328f187 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -92,7 +92,6 @@ Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more deta
- ### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) From ee436a6b1d3cb41abad4a04b2d1da66b41a02daf Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:18:55 +0100 Subject: [PATCH 14/20] Simplify layout --- vizro-core/README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index d6b8ea783..4c0923c7d 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -82,20 +82,17 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ### [Vizro framework](https://vizro.readthedocs.io/en/stable/) - - **Low-code framework for building dashboards.** The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details. -
+ -### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) - +### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) **Chart examples.** @@ -103,11 +100,10 @@ The visual vocabulary helps you to decide which chart type to use for your requi Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. -
+ -### [Vizro examples gallery](https://vizro.mckinsey.com/) - +### [Vizro examples gallery](https://vizro.mckinsey.com/) **Dashboard examples.** @@ -115,11 +111,10 @@ The dashboard examples gallery enables you to explore Vizro in action by viewing Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. -
+ -### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) - +### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) **LLM generated charts and dashboards.** @@ -127,7 +122,8 @@ Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorpo Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. -
+ + ## Installation and first steps From dc650155a4360080fd14d897054634dc5257c288 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:20:41 +0100 Subject: [PATCH 15/20] Lint --- vizro-core/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 43ec6380e..04ad46326 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -31,18 +31,17 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale.
- Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. +
-
The benefits of the Vizro toolkit include: -Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. +Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. ## Why use Vizro? From 4832b8afe452bb74cf6392116fc664c6cd972689 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 14:21:05 +0000 Subject: [PATCH 16/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 04ad46326..de50ee29c 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -36,7 +36,6 @@ multi-page prototypes. - The benefits of the Vizro toolkit include: @@ -89,7 +88,6 @@ Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more deta - ### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) **Chart examples.** @@ -100,7 +98,6 @@ Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to - ### [Vizro examples gallery](https://vizro.mckinsey.com/) **Dashboard examples.** @@ -111,7 +108,6 @@ Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the d - ### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) **LLM generated charts and dashboards.** @@ -122,7 +118,6 @@ Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-a - ## Installation and first steps ```console From d4a1cd461036e861064672c4eb88064e076bb95e Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:25:19 +0100 Subject: [PATCH 17/20] Simplify --- vizro-core/README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 04ad46326..45932b0f9 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -22,6 +22,7 @@ + ## What is Vizro? Vizro is an open-source Python-based toolkit. @@ -30,19 +31,21 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. -
Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. + -
The benefits of the Vizro toolkit include: +
+
Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. + ## Why use Vizro? Vizro helps you to build data visualization apps that are: @@ -81,20 +84,14 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ### [Vizro framework](https://vizro.readthedocs.io/en/stable/) -**Low-code framework for building dashboards.** - -The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). +**Low-code framework for building dashboards:** The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details. - - ### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) -**Chart examples.** - -The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. +**Chart examples:** The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. @@ -103,9 +100,7 @@ Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to ### [Vizro examples gallery](https://vizro.mckinsey.com/) -**Dashboard examples.** - -The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. +**Dashboard examples:** The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. @@ -114,9 +109,7 @@ Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the d ### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) -**LLM generated charts and dashboards.** - -Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. +**LLM generated charts and dashboards:** Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. From 7c8028000a63ab9951cdd7a4c56758536279a30b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 14:26:01 +0000 Subject: [PATCH 18/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- vizro-core/README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 45932b0f9..845b35116 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -22,7 +22,6 @@ - ## What is Vizro? Vizro is an open-source Python-based toolkit. @@ -31,12 +30,10 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. -Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality -multi-page prototypes. +Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. - The benefits of the Vizro toolkit include:
@@ -45,7 +42,6 @@ The benefits of the Vizro toolkit include: Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. - ## Why use Vizro? Vizro helps you to build data visualization apps that are: @@ -88,7 +84,6 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details. - ### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) **Chart examples:** The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. @@ -97,7 +92,6 @@ Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to - ### [Vizro examples gallery](https://vizro.mckinsey.com/) **Dashboard examples:** The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. @@ -106,7 +100,6 @@ Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the d - ### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) **LLM generated charts and dashboards:** Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. @@ -115,7 +108,6 @@ Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-a - ## Installation and first steps ```console From 89f4dd2ea4624cbf2396ff779a7bbc865ef2ea11 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:29:29 +0100 Subject: [PATCH 19/20] Tidy --- vizro-core/README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 45932b0f9..0a9fc5c99 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -31,17 +31,19 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. +
+ Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. - - - +
+
The benefits of the Vizro toolkit include:
+
Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. @@ -84,14 +86,18 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ### [Vizro framework](https://vizro.readthedocs.io/en/stable/) -**Low-code framework for building dashboards:** The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). +**Low-code framework for building dashboards** + +The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details. ### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) -**Chart examples:** The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. +**Chart examples** + +The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. @@ -100,7 +106,9 @@ Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to ### [Vizro examples gallery](https://vizro.mckinsey.com/) -**Dashboard examples:** The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. +**Dashboard examples** + +The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. @@ -109,7 +117,9 @@ Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the d ### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) -**LLM generated charts and dashboards:** Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. +**LLM generated charts and dashboards** + +Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. From f0cc40b22bf9532ba05e5220964ef65f01aee525 Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 11 Dec 2024 15:30:58 +0100 Subject: [PATCH 20/20] Make images bigger --- vizro-core/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/vizro-core/README.md b/vizro-core/README.md index 0a9fc5c99..69bdd55d0 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -101,7 +101,7 @@ The visual vocabulary helps you to decide which chart type to use for your requi Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. - + ### [Vizro examples gallery](https://vizro.mckinsey.com/) @@ -112,7 +112,7 @@ The dashboard examples gallery enables you to explore Vizro in action by viewing Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. - + ### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) @@ -123,7 +123,7 @@ Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorpo Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. - + ## Installation and first steps