Merge branch 'main' into bugfix/css/nav_panel_keyline

mckinsey · Nov 14, 2023 · 3ee7964 · 3ee7964
2 parents 6709a38 + d0a27ce
commit 3ee7964
Show file tree

Hide file tree

Showing 32 changed files with 222 additions and 287 deletions.
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -69,8 +69,10 @@ jobs:
           hatch build
       - name: Set PyPI token
         run: |
-          if [ "${{ needs.check-version.outputs.PACKAGE_NAME }}" == "vizro-core" ]; then
-              echo 'PYPI_TOKEN=${{ secrets.VIZRO_PYPI_TOKEN }}' >> $GITHUB_ENV
+          if [ "${{ needs.check-version.outputs.package_name }}" == "vizro-core" ]; then
+            echo 'PYPI_TOKEN=${{ secrets.VIZRO_PYPI_TOKEN }}' >> $GITHUB_ENV
+          elif [ "${{ needs.check-version.outputs.package_name }}" == "vizro-ai" ]; then
+            echo 'PYPI_TOKEN=${{ secrets.VIZRO_AI_PYPI_TOKEN }}' >> $GITHUB_ENV
           fi
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
@@ -80,10 +82,10 @@ jobs:
       - name: Check correct package uploaded to PyPI
         run: |
           cd "${{ needs.check-version.outputs.package_name }}/dist"
-          local=$(md5sum vizro-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
+          local=$(md5sum ${{ needs.check-version.outputs.package_name }}-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
           cd ..
-          pip download vizro==${{needs.check-version.outputs.package_version}} -d . --no-deps --timeout 300
-          pypi=$(md5sum vizro-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
+          pip download ${{ needs.check-version.outputs.package_name }}==${{needs.check-version.outputs.package_version}} -d . --no-deps --timeout 300
+          pypi=$(md5sum ${{ needs.check-version.outputs.package_name }}-${{needs.check-version.outputs.package_version}}-py3-none-any.whl)
           if [[ $local = $pypi ]]; then echo "md5 hash is the same"; else echo "md5 hash is not the same"; exit 1; fi
 
   version-bump:

diff --git a/tools/check_package_release.py b/tools/check_package_release.py
@@ -5,7 +5,7 @@
 
 import requests
 
-AVAILABLE_PACKAGES = ["vizro-core"]
+AVAILABLE_PACKAGES = ["vizro-core", "vizro-ai"]
 VERSION_MATCHSTR = r'\s*__version__\s*=\s*"(\d+\.\d+\.\d+)"'
 RESPONSE_ERROR = 404
 

diff --git a/tools/release.sh b/tools/release.sh
@@ -13,14 +13,23 @@ GITHUB_ENDPOINT="https://api.github.com/repos/${GITHUB_USER}/${GITHUB_REPO}/rele
 
 BODY=$(jq -Rs . < "$BODY_PATH")
 
+if [ "$PACKAGE" = "vizro-core" ]; then
+  TAG_NAME="${VERSION}"
+  MAKE_LATEST=true
+else
+  TAG_NAME="${PACKAGE}-${VERSION}"
+  MAKE_LATEST=false
+fi
+
 PAYLOAD=$(cat <<-END
 {
-    "tag_name": "${VERSION}",
+    "tag_name": "${TAG_NAME}",
     "target_commitish": "main",
     "name": "${PACKAGE}-${VERSION}",
     "body": ${BODY},
     "draft": false,
-    "prerelease": false
+    "prerelease": false,
+    "make_latest": "${MAKE_LATEST}"
 }
 END
 )
@@ -32,3 +41,5 @@ STATUS=$(curl -L \
   -H "X-GitHub-Api-Version: 2022-11-28" \
   ${GITHUB_ENDPOINT} \
   -d "${PAYLOAD}")
+
+echo "${STATUS}"
diff --git a/vizro-ai/CHANGELOG.md b/vizro-ai/CHANGELOG.md
@@ -10,3 +10,12 @@ This project adheres to Semantic Versioning (http://semver.org/). -->
 See the fragment files in the [changelog.d directory](https://github.com/mckinsey/vizro/tree/main/vizro-ai/changelog.d).
 
 <!-- scriv-insert-here -->
+
+<a id='changelog-0.1.0'></a>
+
+# 0.1.0 — 2023-11-13
+
+## Highlights ✨
+
+- Initial release of Vizro-AI package. Vizro-AI is a tool for generating data
+  visualizations. ([#138](https://github.com/mckinsey/vizro/pull/138))
diff --git a/.../changelog.d/20231031_102652_anna_xiong_vizro_ai_open_source_initial_commits.md b/.../changelog.d/20231031_102652_anna_xiong_vizro_ai_open_source_initial_commits.md
diff --git a/vizro-ai/changelog.d/20231102_143844_maximilian_schulz_schema_linting.md b/vizro-ai/changelog.d/20231102_143844_maximilian_schulz_schema_linting.md
diff --git a/vizro-ai/changelog.d/20231102_163517_alexey_snigir_vizro_ai_integration_tests.md b/vizro-ai/changelog.d/20231102_163517_alexey_snigir_vizro_ai_integration_tests.md
diff --git a/vizro-ai/changelog.d/20231103_161536_chiara_pullem_incorporate_e2e_feedback.md b/vizro-ai/changelog.d/20231103_161536_chiara_pullem_incorporate_e2e_feedback.md
diff --git a/vizro-ai/changelog.d/20231109_113606_alexey_snigir_pin_openai_version.md b/vizro-ai/changelog.d/20231109_113606_alexey_snigir_pin_openai_version.md
diff --git a/...1101_120705_maximilian_schulz_check_CI.md → ...g.d/20231113_111223_lingyi_zhang_0_1_0.md b/...1101_120705_maximilian_schulz_check_CI.md → ...g.d/20231113_111223_lingyi_zhang_0_1_0.md
diff --git a/...01_175538_anna_xiong_prompt_refinement.md → .../20231113_115109_lingyi_zhang_vizro_ai.md b/...01_175538_anna_xiong_prompt_refinement.md → .../20231113_115109_lingyi_zhang_vizro_ai.md
diff --git a/vizro-ai/docs/assets/tutorials/chart/ChineseExample.png b/vizro-ai/docs/assets/tutorials/chart/ChineseExample.png
diff --git a/vizro-ai/docs/assets/tutorials/chart/GDP_Composition_Bar.png b/vizro-ai/docs/assets/tutorials/chart/GDP_Composition_Bar.png
diff --git a/vizro-ai/docs/assets/tutorials/chart/GermanExample.png b/vizro-ai/docs/assets/tutorials/chart/GermanExample.png
diff --git a/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_1.png b/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_1.png
diff --git a/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_2.png b/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_2.png
diff --git a/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_3.png b/vizro-ai/docs/assets/tutorials/chart/animated_bar_chart_3.png
diff --git a/vizro-ai/docs/assets/user_guides/bar_chart_gdp_per_continent.png b/vizro-ai/docs/assets/user_guides/bar_chart_gdp_per_continent.png
diff --git a/vizro-ai/docs/index.md b/vizro-ai/docs/index.md
@@ -1,6 +1,18 @@
 # Vizro-AI
 
-Vizro-AI is a tool for generating data visualizations.
+Vizro-AI is a tool designed for generating data visualizations. It serves as an extension to Vizro, leveraging natural language capabilities to empower users in creating charts effortlessly.
+
+## Why Vizro-AI?
+
+### Easy-to-use
+One of the key strengths of Vizro-AI lies in its natural language capabilities, making it accessible to coding novices. Vizro-AI provides a user-friendly interface that allows to create interactive charts while offering detailed explanations about the data and the generated code.
+
+### Visually-optimized
+Vizro-AI also caters data scientist who often spend more time on formatting than creating a visualization. Vizro-AI enables the user to speed up the formatting process and create a visually appealing chart, also leveraging the design library of Vizro.
+
+### Dashboard-ready
+Vizro-AI focuses currently on plotly and is used to create interactive chart. Thus, it is primarily aimed at dashboards, ensuring that the generated charts are well-suited for dashboard applications.
+
 !!! notice "Notice"
     Please review this [disclaimer](pages/explanation/disclaimer.md)
     before using the `vizro-ai` package.

diff --git a/vizro-ai/docs/pages/explanation/disclaimer.md b/vizro-ai/docs/pages/explanation/disclaimer.md
@@ -1,6 +1,6 @@
 # Disclaimer
 
-Users must select one of the [supported Large Language Models (LLMs)](../user_guides/model_config.md) in order to use the `vizro-ai` package,
+Users must select one of the [supported Large Language Models (LLMs)](../user_guides/model_config.md) in order to use the `vizro_ai` package,
 and are responsible for obtaining their own suitable API key for the relevant model.
 
 ## Third Party API