diff --git a/pyproject.toml b/pyproject.toml index bf7f977bb..7d81efea6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -95,4 +95,4 @@ select = [ "vizro-ai/examples/chart_by_vizro_ai.ipynb" = ["T201", "E501"] "vizro-ai/examples/dashboard_by_vizro_ai.ipynb" = ["T201", "E402", "E501"] # Ignore missing docstrings in visual-vocabulary examples to keep them succinct. -"vizro-core/examples/_visual-vocabulary/pages/examples/**" = ["D100", "D103"] +"vizro-core/examples/visual-vocabulary/pages/examples/**" = ["D100", "D103"] diff --git a/vizro-core/changelog.d/20240923_095658_huong_li_nguyen_fix_typo_and_folder_name.md b/vizro-core/changelog.d/20240923_095658_huong_li_nguyen_fix_typo_and_folder_name.md new file mode 100644 index 000000000..f1f65e73c --- /dev/null +++ b/vizro-core/changelog.d/20240923_095658_huong_li_nguyen_fix_typo_and_folder_name.md @@ -0,0 +1,48 @@ + + + + + + + + + diff --git a/vizro-core/examples/_visual-vocabulary/LICENSE.txt b/vizro-core/examples/visual-vocabulary/LICENSE.txt similarity index 100% rename from vizro-core/examples/_visual-vocabulary/LICENSE.txt rename to vizro-core/examples/visual-vocabulary/LICENSE.txt diff --git a/vizro-core/examples/_visual-vocabulary/README.md b/vizro-core/examples/visual-vocabulary/README.md similarity index 99% rename from vizro-core/examples/_visual-vocabulary/README.md rename to vizro-core/examples/visual-vocabulary/README.md index c5f0f02c5..18a9f9fde 100644 --- a/vizro-core/examples/_visual-vocabulary/README.md +++ b/vizro-core/examples/visual-vocabulary/README.md @@ -101,7 +101,7 @@ The dashboard is still in development. Below is an overview of the chart types f Contributions are welcome! To contribute a chart, follow the steps below: -1. Check that a `svg` file named after the chart type is contained in the [assets](https://github.com/mckinsey/vizro/tree/main/vizro-core/examples/_visual-vocabulary/assets/images/charts) folder. If not, [raise an issue](https://github.com/mckinsey/vizro/issues) in the repository. +1. Check that a `svg` file named after the chart type is contained in the [assets](https://github.com/mckinsey/vizro/tree/main/vizro-core/examples/visual-vocabulary/assets/images/charts) folder. If not, [raise an issue](https://github.com/mckinsey/vizro/issues) in the repository. 2. Add the data set to `_pages_utils.py` if it doesn't already exist. Use existing data sets preferably or any other data set that is publicly available e.g. [plotlx.express.data](https://plotly.com/python-api-reference/generated/plotly.express.data.html) 3. Create a new page for the chart type and add it to the relevant category `.py` file such as `correlation.py`, `deviation.py`, `distribution.py`, etc. Ensure you add the page to the list of `pages` at the end of the `.py` file. @@ -111,6 +111,6 @@ Contributions are welcome! To contribute a chart, follow the steps below: ## How to run the example locally -1. If you have `hatch` set up, run the example with the command `hatch run example _visual-vocabulary`. +1. If you have `hatch` set up, run the example with the command `hatch run example visual-vocabulary`. Otherwise, with a virtual Python environment activated, run `pip install -r requirements.txt` and then `python app.py`. 2. You should now be able to access the app locally via http://127.0.0.1:8050/. diff --git a/vizro-core/examples/_visual-vocabulary/app.py b/vizro-core/examples/visual-vocabulary/app.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/app.py rename to vizro-core/examples/visual-vocabulary/app.py diff --git a/vizro-core/examples/_visual-vocabulary/assets/app.svg b/vizro-core/examples/visual-vocabulary/assets/app.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/app.svg rename to vizro-core/examples/visual-vocabulary/assets/app.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/css/custom.css b/vizro-core/examples/visual-vocabulary/assets/css/custom.css similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/css/custom.css rename to vizro-core/examples/visual-vocabulary/assets/css/custom.css diff --git a/vizro-core/examples/_visual-vocabulary/assets/favicon.ico b/vizro-core/examples/visual-vocabulary/assets/favicon.ico similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/favicon.ico rename to vizro-core/examples/visual-vocabulary/assets/favicon.ico diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/arc.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/arc.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/arc.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/arc.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/area.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/area.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/area.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/area.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/barcode.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/barcode.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/barcode.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/barcode.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/beeswarm.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/beeswarm.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/beeswarm.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/beeswarm.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/boxplot.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/boxplot.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/boxplot.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/boxplot.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble-map.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bubble-map.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble-map.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bubble-map.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble-timeline.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bubble-timeline.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble-timeline.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bubble-timeline.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bubble.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bubble.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bubble.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bullet.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bullet.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bullet.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bullet.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/bump.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/bump.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/bump.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/bump.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/butterfly.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/butterfly.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/butterfly.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/butterfly.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/chord.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/chord.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/chord.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/chord.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/choropleth.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/choropleth.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/choropleth.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/choropleth.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/column-and-line.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/column-and-line.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/column-and-line.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/column-and-line.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/column.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/column.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/column.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/column.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/connected-scatter.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/connected-scatter.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/connected-scatter.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/connected-scatter.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/correlation-matrix.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/correlation-matrix.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/correlation-matrix.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/correlation-matrix.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/cumulative-curve.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/cumulative-curve.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/cumulative-curve.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/cumulative-curve.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/diverging-bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/diverging-bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/diverging-bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/diverging-bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/diverging-stacked-bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/diverging-stacked-bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/diverging-stacked-bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/diverging-stacked-bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/donut.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/donut.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/donut.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/donut.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/dot-map.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/dot-map.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/dot-map.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/dot-map.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/dot-plot.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/dot-plot.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/dot-plot.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/dot-plot.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/fan.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/fan.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/fan.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/fan.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/flow-map.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/flow-map.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/flow-map.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/flow-map.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/funnel.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/funnel.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/funnel.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/funnel.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/gantt.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/gantt.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/gantt.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/gantt.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/gridplot.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/gridplot.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/gridplot.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/gridplot.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/heatmap.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/heatmap.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/heatmap.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/heatmap.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/histogram.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/histogram.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/histogram.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/histogram.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/line.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/line.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/line.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/line.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/lollipop.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/lollipop.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/lollipop.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/lollipop.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/marimekko.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/marimekko.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/marimekko.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/marimekko.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/network.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/network.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/network.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/network.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-bubble.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-bubble.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-bubble.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-bubble.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-column.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-column.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/ordered-column.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/ordered-column.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/paired-bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/paired-bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/paired-bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/paired-bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/paired-column.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/paired-column.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/paired-column.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/paired-column.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/parallel-coordinates.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/parallel-coordinates.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/parallel-coordinates.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/parallel-coordinates.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/pictogram.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/pictogram.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/pictogram.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/pictogram.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/pie.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/pie.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/pie.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/pie.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/radar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/radar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/radar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/radar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/radial.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/radial.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/radial.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/radial.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/sankey.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/sankey.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/sankey.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/sankey.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/scatter-matrix.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/scatter-matrix.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/scatter-matrix.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/scatter-matrix.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/scatter.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/scatter.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/scatter.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/scatter.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/slope.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/slope.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/slope.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/slope.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/sparkline.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/sparkline.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/sparkline.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/sparkline.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/stacked-bar.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/stacked-bar.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/stacked-bar.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/stacked-bar.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/stacked-column.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/stacked-column.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/stacked-column.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/stacked-column.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/stepped-line.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/stepped-line.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/stepped-line.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/stepped-line.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/surplus-deficit-filled-line.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/surplus-deficit-filled-line.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/surplus-deficit-filled-line.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/surplus-deficit-filled-line.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/treemap.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/treemap.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/treemap.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/treemap.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/venn.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/venn.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/venn.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/venn.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/violin.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/violin.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/violin.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/violin.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/images/charts/waterfall.svg b/vizro-core/examples/visual-vocabulary/assets/images/charts/waterfall.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/images/charts/waterfall.svg rename to vizro-core/examples/visual-vocabulary/assets/images/charts/waterfall.svg diff --git a/vizro-core/examples/_visual-vocabulary/assets/logo.svg b/vizro-core/examples/visual-vocabulary/assets/logo.svg similarity index 100% rename from vizro-core/examples/_visual-vocabulary/assets/logo.svg rename to vizro-core/examples/visual-vocabulary/assets/logo.svg diff --git a/vizro-core/examples/_visual-vocabulary/chart_groups.py b/vizro-core/examples/visual-vocabulary/chart_groups.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/chart_groups.py rename to vizro-core/examples/visual-vocabulary/chart_groups.py diff --git a/vizro-core/examples/_visual-vocabulary/custom_charts.py b/vizro-core/examples/visual-vocabulary/custom_charts.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/custom_charts.py rename to vizro-core/examples/visual-vocabulary/custom_charts.py diff --git a/vizro-core/examples/_visual-vocabulary/custom_components.py b/vizro-core/examples/visual-vocabulary/custom_components.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/custom_components.py rename to vizro-core/examples/visual-vocabulary/custom_components.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/__init__.py b/vizro-core/examples/visual-vocabulary/pages/__init__.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/__init__.py rename to vizro-core/examples/visual-vocabulary/pages/__init__.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/_factories.py b/vizro-core/examples/visual-vocabulary/pages/_factories.py similarity index 99% rename from vizro-core/examples/_visual-vocabulary/pages/_factories.py rename to vizro-core/examples/visual-vocabulary/pages/_factories.py index ea8cd76eb..06b306ff2 100644 --- a/vizro-core/examples/_visual-vocabulary/pages/_factories.py +++ b/vizro-core/examples/visual-vocabulary/pages/_factories.py @@ -33,7 +33,7 @@ def butterfly_factory(group: str): Use a butterfly chart when you wish to emphasize the comparison between two data sets sharing the same parameters. Sharing this chart with your audience will help them see at a glance how two groups differ - within the same parameters. You can also **stack** two bars on each side To divide your + within the same parameters. You can also **stack** two bars on each side to divide your categories. """ ), diff --git a/vizro-core/examples/_visual-vocabulary/pages/_pages_utils.py b/vizro-core/examples/visual-vocabulary/pages/_pages_utils.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/_pages_utils.py rename to vizro-core/examples/visual-vocabulary/pages/_pages_utils.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/correlation.py b/vizro-core/examples/visual-vocabulary/pages/correlation.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/correlation.py rename to vizro-core/examples/visual-vocabulary/pages/correlation.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/deviation.py b/vizro-core/examples/visual-vocabulary/pages/deviation.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/deviation.py rename to vizro-core/examples/visual-vocabulary/pages/deviation.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/distribution.py b/vizro-core/examples/visual-vocabulary/pages/distribution.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/distribution.py rename to vizro-core/examples/visual-vocabulary/pages/distribution.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/__init__.py b/vizro-core/examples/visual-vocabulary/pages/examples/__init__.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/__init__.py rename to vizro-core/examples/visual-vocabulary/pages/examples/__init__.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/area.py b/vizro-core/examples/visual-vocabulary/pages/examples/area.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/area.py rename to vizro-core/examples/visual-vocabulary/pages/examples/area.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/bar.py b/vizro-core/examples/visual-vocabulary/pages/examples/bar.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/bar.py rename to vizro-core/examples/visual-vocabulary/pages/examples/bar.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/boxplot.py b/vizro-core/examples/visual-vocabulary/pages/examples/boxplot.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/boxplot.py rename to vizro-core/examples/visual-vocabulary/pages/examples/boxplot.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/bubble.py b/vizro-core/examples/visual-vocabulary/pages/examples/bubble.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/bubble.py rename to vizro-core/examples/visual-vocabulary/pages/examples/bubble.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/bubble_map.py b/vizro-core/examples/visual-vocabulary/pages/examples/bubble_map.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/bubble_map.py rename to vizro-core/examples/visual-vocabulary/pages/examples/bubble_map.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/butterfly.py b/vizro-core/examples/visual-vocabulary/pages/examples/butterfly.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/butterfly.py rename to vizro-core/examples/visual-vocabulary/pages/examples/butterfly.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/choropleth.py b/vizro-core/examples/visual-vocabulary/pages/examples/choropleth.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/choropleth.py rename to vizro-core/examples/visual-vocabulary/pages/examples/choropleth.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/column_and_line.py b/vizro-core/examples/visual-vocabulary/pages/examples/column_and_line.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/column_and_line.py rename to vizro-core/examples/visual-vocabulary/pages/examples/column_and_line.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/connected_scatter.py b/vizro-core/examples/visual-vocabulary/pages/examples/connected_scatter.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/connected_scatter.py rename to vizro-core/examples/visual-vocabulary/pages/examples/connected_scatter.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/donut.py b/vizro-core/examples/visual-vocabulary/pages/examples/donut.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/donut.py rename to vizro-core/examples/visual-vocabulary/pages/examples/donut.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/dot_map.py b/vizro-core/examples/visual-vocabulary/pages/examples/dot_map.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/dot_map.py rename to vizro-core/examples/visual-vocabulary/pages/examples/dot_map.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/funnel.py b/vizro-core/examples/visual-vocabulary/pages/examples/funnel.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/funnel.py rename to vizro-core/examples/visual-vocabulary/pages/examples/funnel.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/heatmap.py b/vizro-core/examples/visual-vocabulary/pages/examples/heatmap.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/heatmap.py rename to vizro-core/examples/visual-vocabulary/pages/examples/heatmap.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/histogram.py b/vizro-core/examples/visual-vocabulary/pages/examples/histogram.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/histogram.py rename to vizro-core/examples/visual-vocabulary/pages/examples/histogram.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/line.py b/vizro-core/examples/visual-vocabulary/pages/examples/line.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/line.py rename to vizro-core/examples/visual-vocabulary/pages/examples/line.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/magnitude_column.py b/vizro-core/examples/visual-vocabulary/pages/examples/magnitude_column.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/magnitude_column.py rename to vizro-core/examples/visual-vocabulary/pages/examples/magnitude_column.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/ordered_bar.py b/vizro-core/examples/visual-vocabulary/pages/examples/ordered_bar.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/ordered_bar.py rename to vizro-core/examples/visual-vocabulary/pages/examples/ordered_bar.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/ordered_column.py b/vizro-core/examples/visual-vocabulary/pages/examples/ordered_column.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/ordered_column.py rename to vizro-core/examples/visual-vocabulary/pages/examples/ordered_column.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/paired_bar.py b/vizro-core/examples/visual-vocabulary/pages/examples/paired_bar.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/paired_bar.py rename to vizro-core/examples/visual-vocabulary/pages/examples/paired_bar.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/paired_column.py b/vizro-core/examples/visual-vocabulary/pages/examples/paired_column.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/paired_column.py rename to vizro-core/examples/visual-vocabulary/pages/examples/paired_column.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/parallel_coordinates.py b/vizro-core/examples/visual-vocabulary/pages/examples/parallel_coordinates.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/parallel_coordinates.py rename to vizro-core/examples/visual-vocabulary/pages/examples/parallel_coordinates.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/pie.py b/vizro-core/examples/visual-vocabulary/pages/examples/pie.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/pie.py rename to vizro-core/examples/visual-vocabulary/pages/examples/pie.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/sankey.py b/vizro-core/examples/visual-vocabulary/pages/examples/sankey.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/sankey.py rename to vizro-core/examples/visual-vocabulary/pages/examples/sankey.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/scatter.py b/vizro-core/examples/visual-vocabulary/pages/examples/scatter.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/scatter.py rename to vizro-core/examples/visual-vocabulary/pages/examples/scatter.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/scatter_matrix.py b/vizro-core/examples/visual-vocabulary/pages/examples/scatter_matrix.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/scatter_matrix.py rename to vizro-core/examples/visual-vocabulary/pages/examples/scatter_matrix.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/stacked_bar.py b/vizro-core/examples/visual-vocabulary/pages/examples/stacked_bar.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/stacked_bar.py rename to vizro-core/examples/visual-vocabulary/pages/examples/stacked_bar.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/stacked_column.py b/vizro-core/examples/visual-vocabulary/pages/examples/stacked_column.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/stacked_column.py rename to vizro-core/examples/visual-vocabulary/pages/examples/stacked_column.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/stepped_line.py b/vizro-core/examples/visual-vocabulary/pages/examples/stepped_line.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/stepped_line.py rename to vizro-core/examples/visual-vocabulary/pages/examples/stepped_line.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/time_column.py b/vizro-core/examples/visual-vocabulary/pages/examples/time_column.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/time_column.py rename to vizro-core/examples/visual-vocabulary/pages/examples/time_column.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/treemap.py b/vizro-core/examples/visual-vocabulary/pages/examples/treemap.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/treemap.py rename to vizro-core/examples/visual-vocabulary/pages/examples/treemap.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/examples/violin.py b/vizro-core/examples/visual-vocabulary/pages/examples/violin.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/examples/violin.py rename to vizro-core/examples/visual-vocabulary/pages/examples/violin.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/flow.py b/vizro-core/examples/visual-vocabulary/pages/flow.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/flow.py rename to vizro-core/examples/visual-vocabulary/pages/flow.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/magnitude.py b/vizro-core/examples/visual-vocabulary/pages/magnitude.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/magnitude.py rename to vizro-core/examples/visual-vocabulary/pages/magnitude.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/part_to_whole.py b/vizro-core/examples/visual-vocabulary/pages/part_to_whole.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/part_to_whole.py rename to vizro-core/examples/visual-vocabulary/pages/part_to_whole.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/ranking.py b/vizro-core/examples/visual-vocabulary/pages/ranking.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/ranking.py rename to vizro-core/examples/visual-vocabulary/pages/ranking.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/spatial.py b/vizro-core/examples/visual-vocabulary/pages/spatial.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/spatial.py rename to vizro-core/examples/visual-vocabulary/pages/spatial.py diff --git a/vizro-core/examples/_visual-vocabulary/pages/time.py b/vizro-core/examples/visual-vocabulary/pages/time.py similarity index 100% rename from vizro-core/examples/_visual-vocabulary/pages/time.py rename to vizro-core/examples/visual-vocabulary/pages/time.py diff --git a/vizro-core/examples/_visual-vocabulary/requirements.in b/vizro-core/examples/visual-vocabulary/requirements.in similarity index 100% rename from vizro-core/examples/_visual-vocabulary/requirements.in rename to vizro-core/examples/visual-vocabulary/requirements.in diff --git a/vizro-core/examples/_visual-vocabulary/requirements.txt b/vizro-core/examples/visual-vocabulary/requirements.txt similarity index 100% rename from vizro-core/examples/_visual-vocabulary/requirements.txt rename to vizro-core/examples/visual-vocabulary/requirements.txt diff --git a/vizro-core/hatch.toml b/vizro-core/hatch.toml index b4a9dcb4e..1bf15be24 100644 --- a/vizro-core/hatch.toml +++ b/vizro-core/hatch.toml @@ -85,10 +85,10 @@ serve = "mkdocs serve --open" dependencies = [ "pip", "pyyaml", - # black is required to run the example _visual-vocabulary. This is completely independent of the black used in linting + # black is required to run the example visual-vocabulary. This is completely independent of the black used in linting # our code. When this moves to HuggingFace we can remove the requirement from here. "black==24.4.2", - "plotly>=5.24.0" # to leverage new MapLibre features in _visual-vocabulary + "plotly>=5.24.0" # to leverage new MapLibre features in visual-vocabulary ] installer = "uv" scripts = {example = "cd examples/{args:scratch_dev}; python app.py"}