diff --git a/.github/images/dashboard_examples.png b/.github/images/dashboard_examples.png deleted file mode 100644 index 70922f659..000000000 Binary files a/.github/images/dashboard_examples.png and /dev/null differ diff --git a/.github/images/example_screens.png b/.github/images/example_screens.png deleted file mode 100644 index d35209b8d..000000000 Binary files a/.github/images/example_screens.png and /dev/null differ diff --git a/.github/images/infographic.svg b/.github/images/infographic.svg new file mode 100644 index 000000000..95b4b1c88 --- /dev/null +++ b/.github/images/infographic.svg @@ -0,0 +1 @@ +​production scaling​build prototypes and deploy to production at scale in minutes​in-built best practices​apply beautiful visual design and engineering forpowerfulfeatures​open-source tools​enjoy the freedom of open source with the flexibility of Plotly, Dash and Pydantic​low-code​use a few lines of simple configuration to build apps quickly and easily​efficient communication​share insights without needing advanced engineering or visual design expertise​code extensions​enable customization for advanced users using Python, JavaScript, HTML and CSS diff --git a/.github/images/logo_watermarks.svg b/.github/images/logo_watermarks.svg new file mode 100644 index 000000000..6b4baba31 --- /dev/null +++ b/.github/images/logo_watermarks.svg @@ -0,0 +1 @@ +​enabled by:​built and maintained by:​plotly& dash​python​pydantic diff --git a/.github/images/tech_logos.png b/.github/images/tech_logos.png deleted file mode 100644 index 9628f6902..000000000 Binary files a/.github/images/tech_logos.png and /dev/null differ diff --git a/.github/images/toolkit_dashboard_examples.png b/.github/images/toolkit_dashboard_examples.png new file mode 100644 index 000000000..6e0c37885 Binary files /dev/null and b/.github/images/toolkit_dashboard_examples.png differ diff --git a/.github/images/toolkit_framework.svg b/.github/images/toolkit_framework.svg new file mode 100644 index 000000000..1751d5c74 --- /dev/null +++ b/.github/images/toolkit_framework.svg @@ -0,0 +1 @@ + diff --git a/.github/images/toolkit_visual_vocabulary.png b/.github/images/toolkit_visual_vocabulary.png new file mode 100644 index 000000000..cb6045ca1 Binary files /dev/null and b/.github/images/toolkit_visual_vocabulary.png differ diff --git a/.github/images/toolkit_vizro_ai.gif b/.github/images/toolkit_vizro_ai.gif new file mode 100644 index 000000000..b7f8c7c56 Binary files /dev/null and b/.github/images/toolkit_vizro_ai.gif differ diff --git a/.github/images/value_prop_icons.png b/.github/images/value_prop_icons.png deleted file mode 100644 index 3636d3c8d..000000000 Binary files a/.github/images/value_prop_icons.png and /dev/null differ diff --git a/.github/images/visual_vocabulary.png b/.github/images/visual_vocabulary.png deleted file mode 100644 index c8259ae16..000000000 Binary files a/.github/images/visual_vocabulary.png and /dev/null differ diff --git a/.github/images/vizro_examples_gallery.png b/.github/images/vizro_examples_gallery.png deleted file mode 100644 index a2bf13cb8..000000000 Binary files a/.github/images/vizro_examples_gallery.png and /dev/null differ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d0596372c..1107ba26c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -45,7 +45,7 @@ repos: args: [--autofix] - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.8.1 + rev: v0.8.6 hooks: - id: ruff args: [--fix] @@ -85,7 +85,7 @@ repos: args: ["--fix"] - repo: https://github.com/executablebooks/mdformat - rev: 0.7.18 + rev: 0.7.21 hooks: - id: mdformat args: diff --git a/CODEOWNERS b/CODEOWNERS index 9a7842259..ac270f64c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,2 +1,3 @@ * @Joseph-Perkins @antonymilne @huong-li-nguyen @maxschulz-COL @lingyielia docs/ @stichbury @Joseph-Perkins @antonymilne @huong-li-nguyen @maxschulz-COL +*.css @huong-li-nguyen @nadijagraca diff --git a/README.md b/README.md index d30fa8e29..32834d3c4 100644 --- a/README.md +++ b/README.md @@ -1,118 +1,126 @@ -

+

+ +
-

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) +[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? + +Vizro is an open-source Python-based toolkit. + +Use it to build beautiful and powerful data visualization apps quickly and easily, without needing advanced engineering or visual design expertise. -Documentation | Get Started | Vizro examples gallery +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: -

- -

- -

- - -Visual Intelligence. Beautifully Engineered - - -

- -

- -Vizro is a toolkit for creating modular data visualization applications - -

- -

- -

+
+ +
+
-## What is Vizro? +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: + +**Quick and easy** -

- -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. - -

+Build apps in minutes. Use a few lines of simple configuration (via Pydantic models, JSON, YAML, or Python dictionaries) in place of thousands of lines of code. -

- -

+**Beautiful and powerful** -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. +Build high-quality multi-page apps without needing advanced engineering or visual design expertise. Use powerful features of production-grade BI tools, with in-built visual design best practices. -Define high-level categories within the configuration, including: +**Flexible** -- **Components:** create charts, tables, input/output interfaces, and more. -- **Controls**: create filters, parameter inputs, and custom action controllers. -- **Pages, layouts and navigation**: create multiple pages, with customizable layouts and flexible navigation across them. -- **Actions and interactions**: create interactions between charts, and use pre-defined or customized actions (such as exporting). +Benefit from the capabilities and flexibility of open-source packages. Use the trusted dependencies of Plotly, Dash, and Pydantic. -Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation. +**Customizable** -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. +Almost infinite control for advanced users. Use Python, JavaScript, HTML and CSS code extensions. + +**Scalable** + +Rapidly prototype and deploy to production. Use the in-built production-grade capabilities of Plotly, Dash and Pydantic. 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. -## What is Vizro-AI? +## When to use Vizro? + +Use Vizro when you need to combine the speed and ease of low-code Python tools, with production capabilities of JavaScript and BI tools, and the freedom of open source: -Vizro-AI is a separate package and extends Vizro to enable the use of natural language queries to build Plotly charts and Vizro dashboards. With Vizro-AI you can effortlessly create interactive charts and comprehensive dashboards by simply describing your needs in plain English, or any other language. +- Have an app that looks beautiful and professional by default. +- Enjoy the simplicity of low-code, plus the option to customize with code almost infinitely. +- Rapidly create prototypes which are production-ready and easy to deploy at scale. -

-Gif to show vizro-ai -

+## How to use Vizro? -See the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. +## [Vizro framework](https://vizro.readthedocs.io/en/stable/) -## Key benefits of 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. -
+## [Vizro visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) -## Vizro examples gallery +**Chart examples.** -You can see Vizro in action by clicking on the following image or by visiting [the examples gallery at vizro.mckinsey.com](https://vizro.mckinsey.com). +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. + + + -## Visual vocabulary +## [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. -Our visual vocabulary dashboard helps you to select and create various types of charts. It helps you decide when to use each chart type, and offers sample Python code to create these charts with [Plotly](https://plotly.com/python/) and embed them into a Vizro dashboard. +Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. - - + + -## Dashboard screenshots +## [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai/) -

- -

+**Use LLMs to generate 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. + + ## Installation and first steps @@ -124,10 +132,6 @@ See the [installation guide](https://vizro.readthedocs.io/en/stable/pages/user-g The [get started documentation](https://vizro.readthedocs.io/en/stable/pages/tutorials/first-dashboard/) explains how to create your first dashboard. -## Get hands on - -See the [how-to guides](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for step-by-step instructions on the key Vizro features. - ## Packages This repository is a monorepo containing the following packages: @@ -139,13 +143,13 @@ This repository is a monorepo containing the following packages: ## Community and development -We encourage you to ask and answer technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues). This is also the place where you can submit bug reports or request new features. +We encourage you to ask and discuss any technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues). This is also the place where you can submit bug reports or request new features. ## Want to contribute to Vizro? -The [contributing guide](https://vizro.readthedocs.io/en/stable/pages/explanation/contributing/) explain how you can contribute to Vizro. +The [contributing guide](https://vizro.readthedocs.io/en/stable/pages/explanation/contributing/) explains how you can contribute to Vizro. -You can also view current and former [contributors](https://vizro.readthedocs.io/en/stable/pages/explanation/authors/). +You can also view current and former contributors [here](https://vizro.readthedocs.io/en/stable/pages/explanation/authors/). ## Want to report a security vulnerability? @@ -153,4 +157,4 @@ See our [security policy](https://github.com/mckinsey/vizro/security/policy). ## License -`vizro` is distributed under the terms of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) +`vizro` is distributed under the terms of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/pyproject.toml b/pyproject.toml index 2a1469171..6424bb322 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ authors = [ {name = "Vizro Team"} ] description = "Vizro is a package to facilitate visual analytics." +dynamic = ["version"] name = "vizro" [tool.bandit] @@ -14,7 +15,7 @@ exclude_dirs = ["tests"] [tool.codespell] builtin = "clear,rare,en-GB_to_en-US" ignore-words-list = "grey,ned,sav,Thur" -skip = "*.min.css.map,*.min.css,.vale/*, *assets/*" +skip = "*.min.css.map,*.min.css,.vale/*, *assets/*,.github/*" [tool.mypy] # strict checks : strict = true diff --git a/vizro-ai/CHANGELOG.md b/vizro-ai/CHANGELOG.md index 98a162904..3b01a9cb6 100644 --- a/vizro-ai/CHANGELOG.md +++ b/vizro-ai/CHANGELOG.md @@ -11,6 +11,18 @@ See the fragment files in the [changelog.d directory](https://github.com/mckinse + + +# 0.3.3 — 2025-01-16 + +## Changed + +- Pinned the Vizro upper bound to prepare for Pydantic V2 migration. ([#923](https://github.com/mckinsey/vizro/pull/923)) + +## Fixed + +- Fixed the "Model name could not be retrieved" error when using VizroAI with AWS Bedrock. ([#953](https://github.com/mckinsey/vizro/pull/953)) + # 0.3.2 — 2024-11-08 diff --git a/vizro-ai/changelog.d/20240917_174515_alexey_snigir_automatic_vizro_ai_score_tests.md b/vizro-ai/changelog.d/20240917_174515_alexey_snigir_automatic_vizro_ai_score_tests.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20240917_174515_alexey_snigir_automatic_vizro_ai_score_tests.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-ai/changelog.d/20241108_083647_runner.md b/vizro-ai/changelog.d/20241108_083647_runner.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20241108_083647_runner.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-ai/changelog.d/20241108_085722_maximilian_schulz_0_3_2.md b/vizro-ai/changelog.d/20241108_085722_maximilian_schulz_0_3_2.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20241108_085722_maximilian_schulz_0_3_2.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-ai/changelog.d/20241108_102707_maximilian_schulz_some_cleanup.md b/vizro-ai/changelog.d/20241108_102707_maximilian_schulz_some_cleanup.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20241108_102707_maximilian_schulz_some_cleanup.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-ai/changelog.d/20241112_202616_nadija_ratkusic_graca_add_risk_mitigation_links.md b/vizro-ai/changelog.d/20241112_202616_nadija_ratkusic_graca_add_risk_mitigation_links.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20241112_202616_nadija_ratkusic_graca_add_risk_mitigation_links.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-ai/changelog.d/20241113_200250_nadija_ratkusic_graca_css_fixes.md b/vizro-ai/changelog.d/20241113_200250_nadija_ratkusic_graca_css_fixes.md deleted file mode 100644 index aa45b72f1..000000000 --- a/vizro-ai/changelog.d/20241113_200250_nadija_ratkusic_graca_css_fixes.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-core/changelog.d/20241202_150655_huong_li_nguyen_refactor_bs_example.md b/vizro-ai/changelog.d/20250116_084919_lingyi_zhang_0_3_3.md similarity index 99% rename from vizro-core/changelog.d/20241202_150655_huong_li_nguyen_refactor_bs_example.md rename to vizro-ai/changelog.d/20250116_084919_lingyi_zhang_0_3_3.md index 4abc0f11e..7c0d58d4f 100644 --- a/vizro-core/changelog.d/20241202_150655_huong_li_nguyen_refactor_bs_example.md +++ b/vizro-ai/changelog.d/20250116_084919_lingyi_zhang_0_3_3.md @@ -10,42 +10,36 @@ Uncomment the section that is right (remove the HTML comment wrapper). - A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX. ([#1](https://github.com/mckinsey/vizro/pull/1)) --> - - - - - - - - - - - - + + +# 0.1.30 — 2024-12-16 + +## Removed + +- Remove built-in CSS shortcuts `#floating-*` to float images. These can still be provided manually. ([#919](https://github.com/mckinsey/vizro/pull/919)) + +## Fixed + +- Ensure the single-select dropdown value can be cleared when used as a dynamic filter. ([#915](https://github.com/mckinsey/vizro/pull/915)) + +- Remove static CSS that prevented header text from wrapping in `AgGrid`. ([#928](https://github.com/mckinsey/vizro/pull/928)) + # 0.1.29 — 2024-12-03 diff --git a/vizro-core/README.md b/vizro-core/README.md index 283717094..32834d3c4 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -1,143 +1,160 @@ -

+

+ +
-

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) +[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? -Documentation | Get Started | Vizro examples gallery +Vizro is an open-source Python-based toolkit. +Use it to build beautiful and powerful data visualization apps quickly and easily, without needing advanced engineering or visual design expertise. + +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: -

- -

- -

- - -Visual Intelligence. Beautifully engineered - - -

- -

- -Vizro is a toolkit for creating modular data visualization applications - -

- -

- -

+
+ +
+
-## What is Vizro? +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: + +**Quick and easy** + +Build apps in minutes. Use a few lines of simple configuration (via Pydantic models, JSON, YAML, or Python dictionaries) in place of thousands of lines of code. -

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

+**Beautiful and powerful** -

- -

+Build high-quality multi-page apps without needing advanced engineering or visual design expertise. Use powerful features of production-grade BI tools, with in-built visual design best practices. -Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilizing libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices +**Flexible** -Define high level categories within the configuration, including: +Benefit from the capabilities and flexibility of open-source packages. Use the trusted dependencies of Plotly, Dash, and Pydantic. -- **components:** create charts, tables, input/output interfaces, and more -- **controls**: create filters, parameter inputs, and custom action controllers -- **pages, layouts and navigation**: create multiple pages, with customizable layouts and flexible navigation across them -- **actions and interactions**: create interactions between charts, and use pre-defined or customized actions (such as exporting) +**Customizable** -Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation +Almost infinite control for advanced users. Use Python, JavaScript, HTML and CSS code extensions. -Optional high-code extensions allow 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 +**Scalable** -(Visit the ["Why Vizro"](https://vizro.readthedocs.io/en/latest/pages/explanation/why_vizro/) section to see a more detailed explanation of Vizro use cases) +Rapidly prototype and deploy to production. Use the in-built production-grade capabilities of Plotly, Dash and Pydantic. -
+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. -## Key benefits of Vizro +## When to use Vizro? -
+Use Vizro when you need to combine the speed and ease of low-code Python tools, with production capabilities of JavaScript and BI tools, and the freedom of open source: -

- -

+- Have an app that looks beautiful and professional by default. +- Enjoy the simplicity of low-code, plus the option to customize with code almost infinitely. +- Rapidly create prototypes which are production-ready and easy to deploy at scale. -
+## How to use Vizro? -## Vizro examples gallery +## [Vizro framework](https://vizro.readthedocs.io/en/stable/) -You can see Vizro in action by clicking on the following image or by visiting [the examples gallery at vizro.mckinsey.com](https://vizro.mckinsey.com). +**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. + +## [Vizro 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. + +Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. + + + -## Visual vocabulary +## [Vizro examples gallery](https://vizro.mckinsey.com/) -Our visual vocabulary dashboard helps you to select and create various types of charts. It helps you decide when to use each chart type, and offers sample Python code to create these charts with [Plotly](https://plotly.com/python/) and embed them into a Vizro 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. + + + -## Dashboard screenshots +## [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai/) + +**Use LLMs to generate 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. -## Installation +Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. + + + +## Installation and first steps ```console pip install vizro ``` -See the [Install guide](https://vizro.readthedocs.io/en/stable/pages/user_guides/install/) for more information - -Please note this repository is a monorepo and the core `vizro` package can be found in [/vizro-core](https://github.com/mckinsey/vizro/tree/main/vizro-core) +See the [installation guide](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for more information. -## Getting started +The [get started documentation](https://vizro.readthedocs.io/en/stable/pages/tutorials/first-dashboard/) explains how to create your first dashboard. -See the [Tutorials](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) for creating your first dashboard +## Packages -## Documentation +This repository is a monorepo containing the following packages: -See the [Documentation](https://vizro.readthedocs.io/en/stable/) for more details +| Folder | Version | Documentation | +| :------------------------: | :-----------------------------------------------------------------------------------------: | :--------------------------------------------------------------: | +| [vizro-core](./vizro-core) | [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) | [Vizro Docs](https://vizro.readthedocs.io/en/stable/) | +| [vizro-ai](./vizro-ai) | [![PyPI version](https://badge.fury.io/py/vizro-ai.svg)](https://badge.fury.io/py/vizro-ai) | [Vizro-AI Docs](https://vizro.readthedocs.io/projects/vizro-ai/) | -## Community and Development +## Community and development -We encourage you to ask and answer technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues). This is also the place where you can submit bug reports or request new features. +We encourage you to ask and discuss any technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues). This is also the place where you can submit bug reports or request new features. -## Contributing +## Want to contribute to Vizro? -To learn more about making a contribution, please see the [contributing guide](https://vizro.readthedocs.io/en/stable/pages/development/contributing/) for more information +The [contributing guide](https://vizro.readthedocs.io/en/stable/pages/explanation/contributing/) explains how you can contribute to Vizro. -You can also view current and former [contributors](https://vizro.readthedocs.io/en/stable/pages/development/authors/) +You can also view current and former contributors [here](https://vizro.readthedocs.io/en/stable/pages/explanation/authors/). -## Reporting a Security Vulnerability +## Want to report a security vulnerability? -Please see our [security policy](https://github.com/mckinsey/vizro/security/policy) +See our [security policy](https://github.com/mckinsey/vizro/security/policy). ## License -`vizro` is distributed under the terms of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) +`vizro` is distributed under the terms of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/vizro-core/changelog.d/20241203_145221_antony.milne_mdformat.md b/vizro-core/changelog.d/20241203_145221_antony.milne_mdformat.md deleted file mode 100644 index 4abc0f11e..000000000 --- a/vizro-core/changelog.d/20241203_145221_antony.milne_mdformat.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-core/changelog.d/20241203_150134_antony.milne_mdformat.md b/vizro-core/changelog.d/20241203_150134_antony.milne_mdformat.md deleted file mode 100644 index 4abc0f11e..000000000 --- a/vizro-core/changelog.d/20241203_150134_antony.milne_mdformat.md +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/vizro-core/changelog.d/20241204_135618_huong_li_nguyen_remove_custom_img_css.md b/vizro-core/changelog.d/20241204_135618_huong_li_nguyen_remove_custom_img_css.md deleted file mode 100644 index 750a8d283..000000000 --- a/vizro-core/changelog.d/20241204_135618_huong_li_nguyen_remove_custom_img_css.md +++ /dev/null @@ -1,48 +0,0 @@ - - - - -### Removed - -- Remove built-in CSS shortcuts `#floating-*` to float images. These can still be provided manually. ([#919](https://github.com/mckinsey/vizro/pull/919)) - - - - - - - diff --git a/vizro-core/changelog.d/20241203_094802_maximilian_schulz_0_1_29.md b/vizro-core/changelog.d/20241216_113455_runner.md similarity index 99% rename from vizro-core/changelog.d/20241203_094802_maximilian_schulz_0_1_29.md rename to vizro-core/changelog.d/20241216_113455_runner.md index 4abc0f11e..7c0d58d4f 100644 --- a/vizro-core/changelog.d/20241203_094802_maximilian_schulz_0_1_29.md +++ b/vizro-core/changelog.d/20241216_113455_runner.md @@ -10,42 +10,36 @@ Uncomment the section that is right (remove the HTML comment wrapper). - A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX. ([#1](https://github.com/mckinsey/vizro/pull/1)) --> - - - - - - - - - - - - + + + + + + + + diff --git a/vizro-core/changelog.d/20250106_205004_84141230+manuelkonrad_fix_parcoord_margins.md b/vizro-core/changelog.d/20250106_205004_84141230+manuelkonrad_fix_parcoord_margins.md new file mode 100644 index 000000000..a411f0317 --- /dev/null +++ b/vizro-core/changelog.d/20250106_205004_84141230+manuelkonrad_fix_parcoord_margins.md @@ -0,0 +1,48 @@ + + + + + + + + +### Fixed + +- Fix hidden axis and tick labels for Graph components using `px.parallel_coordinates`. ([#941](https://github.com/mckinsey/vizro/pull/941)) + + + diff --git a/vizro-core/changelog.d/20250109_152222_huong_li_nguyen_update_bs_theme.md b/vizro-core/changelog.d/20250109_152222_huong_li_nguyen_update_bs_theme.md new file mode 100644 index 000000000..7c0d58d4f --- /dev/null +++ b/vizro-core/changelog.d/20250109_152222_huong_li_nguyen_update_bs_theme.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-core/changelog.d/20250114_130329_huong_li_nguyen_update_kpi_font_size.md b/vizro-core/changelog.d/20250114_130329_huong_li_nguyen_update_kpi_font_size.md new file mode 100644 index 000000000..7c0d58d4f --- /dev/null +++ b/vizro-core/changelog.d/20250114_130329_huong_li_nguyen_update_kpi_font_size.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-core/changelog.d/20241203_133819_petar_pejovic.md b/vizro-core/changelog.d/20250115_123645_huong_li_nguyen_fix_removal_of_number_input.md similarity index 90% rename from vizro-core/changelog.d/20241203_133819_petar_pejovic.md rename to vizro-core/changelog.d/20250115_123645_huong_li_nguyen_fix_removal_of_number_input.md index c5a4460ba..80406f949 100644 --- a/vizro-core/changelog.d/20241203_133819_petar_pejovic.md +++ b/vizro-core/changelog.d/20250115_123645_huong_li_nguyen_fix_removal_of_number_input.md @@ -37,7 +37,8 @@ Uncomment the section that is right (remove the HTML comment wrapper). ### Fixed -- Ensure the single-select dropdown value can be cleared when used as a dynamic filter. ([#915](https://github.com/mckinsey/vizro/pull/915)) +- Enable visibility of the spinner buttons in number inputs. ([#954](https://github.com/mckinsey/vizro/pull/954)) +