Merge branch 'main' into vizro-core/models-navigation-navbar

mckinsey · Nov 8, 2023 · d962e1f · d962e1f
2 parents 4ff1100 + 858058c
commit d962e1f
Show file tree

Hide file tree

Showing 62 changed files with 1,516 additions and 393 deletions.
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -109,7 +109,6 @@ jobs:
           hatch version patch,dev
           hatch run changelog:add
           hatch run schema
-          hatch run lint || hatch run lint
           git config user.email "[email protected]"
           git config user.name "Vizro Team"
           git add -A

diff --git a/.github/workflows/lint-vizro-all.yml b/.github/workflows/lint-vizro-all.yml
@@ -40,8 +40,5 @@ jobs:
       - name: Install Hatch
         run: pip install --upgrade hatch
 
-      - name: List dependencies
-        run: hatch run all.py${{ matrix.python-version }}:pip freeze
-
       - name: Lint
-        run: hatch run all.py${{ matrix.python-version }}:lint
+        run: hatch run lint:lint
diff --git a/.github/workflows/test-integration-vizro-ai.yml b/.github/workflows/test-integration-vizro-ai.yml
@@ -1,55 +1,57 @@
-#name: test-integration-vizro-ai
-#
-#defaults:
-#  run:
-#    working-directory: vizro-core
-#
-##### TODO: adjust below according to other scripts
-#on:
-#  # push:
-#  #   branches: [main]
-#  pull_request:
-#    # branches:
-#    #   - "main"
-#
-#concurrency:
-#  group: test-integration-${{ github.head_ref }}
-#  cancel-in-progress: true
-#
-#env:
-#  PYTHONUNBUFFERED: "1"
-#  FORCE_COLOR: "1"
-#
-#jobs:
-#  run:
-#    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
-#    runs-on: ${{ matrix.os }}
-#    strategy:
-#      fail-fast: false
-#      matrix:
-#        os: [ubuntu-latest, windows-latest]
-#        python-version: ["3.9", "3.10", "3.11"]
-#
-#    steps:
-#      - uses: actions/checkout@v4
-#      - name: Get branch name
-#        id: branch-name
-#        uses: tj-actions/branch-names@v7
-#
-#      - name: Set up Python ${{ matrix.python-version }}
-#        uses: actions/setup-python@v4
-#        with:
-#          python-version: ${{ matrix.python-version }}
-#
-#      - uses: actions/cache@v3
-#        with:
-#          path: ${{ env.pythonLocation }}
-#          key: ${{ matrix.os }}-${{ matrix.python-version }}-${{ steps.branch-name.outputs.current_branch }}-pip-${{ hashFiles('hatch.toml') }}-${{ hashFiles('pyproject.toml') }}
-#          restore-keys: |
-#            ${{ matrix.os }}-${{ matrix.python-version }}-${{ steps.branch-name.outputs.current_branch }}-pip-
-#
-#      - name: Run ubuntu integration tests
-#        if: ${{ matrix.os == 'ubuntu-latest' }}
-#        run: |
-#          pip install --upgrade hatch
-#          hatch run all.py${{ matrix.python-version }}:test-integration
+name: test-integration-vizro-ai
+
+defaults:
+  run:
+    working-directory: vizro-ai
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - "main"
+
+concurrency:
+  group: test-integration-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  run:
+    name: Python ${{ matrix.python-version }} on Linux
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: ${{ github.event_name == 'pull_request' && 2 || 0 }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Hatch
+        run: pip install --upgrade hatch
+
+      - name: Run vizro-ai integration tests with pypi vizro
+        run: |
+          export OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }}
+          export OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE }}
+          hatch run all.py${{ matrix.python-version }}:test-integration
+
+      - name: Run vizro-ai integration tests with local vizro
+        run: |
+          export OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY }}
+          export OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE }}
+          cd ../vizro-core
+          hatch build
+          cd ../vizro-ai
+          hatch run all.py${{ matrix.python-version }}:pip install ../vizro-core/dist/vizro*.tar.gz
+          hatch run all.py${{ matrix.python-version }}:test-integration
diff --git a/tools/tools_requirements.txt b/tools/tools_requirements.txt
@@ -1,2 +1,2 @@
-werkzeug
+werkzeug>=3.0.1
 requests
diff --git a/vizro-ai/.readthedocs.yaml b/vizro-ai/.readthedocs.yaml
@@ -0,0 +1,16 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  commands:
+    - pip install hatch
+    - cd vizro-ai/ && hatch run docs:mkdocs build
+    - mkdir --parents $READTHEDOCS_OUTPUT
+    - mv vizro-ai/site/ $READTHEDOCS_OUTPUT/html
diff --git a/vizro-ai/README.md b/vizro-ai/README.md
@@ -4,8 +4,12 @@ Vizro-AI is a tool for generating visualizations.
 
 ## Disclaimer
 
-Please review the [Disclaimer](docs/pages/explanation/disclaimer.md) before using `vizro-ai` package.
+Please review the [Disclaimer](https://vizro-ai.readthedocs.io/en/latest/pages/explanation/disclaimer/) before using `vizro-ai` package.
 
 ## Documentation
 
-Here is the link to the [Documentation](docs/pages).
+For more information, please refer to our [Documentation](https://vizro-ai.readthedocs.io/en/latest/).
+
+## Acknowledgment
+
+Vizro-AI is powered by [LangChain](https://github.com/langchain-ai/langchain).
diff --git a/vizro-ai/changelog.d/20231101_175538_anna_xiong_prompt_refinement.md b/vizro-ai/changelog.d/20231101_175538_anna_xiong_prompt_refinement.md
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- 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))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed 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))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added 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))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed 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))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated 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))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed 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))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security 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-ai/changelog.d/20231102_095201_maximilian_schulz_hosting_vizro_ai.md b/vizro-ai/changelog.d/20231102_095201_maximilian_schulz_hosting_vizro_ai.md
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- 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))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed 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))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added 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))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed 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))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated 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))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed 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))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security 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-ai/changelog.d/20231102_143844_maximilian_schulz_schema_linting.md b/vizro-ai/changelog.d/20231102_143844_maximilian_schulz_schema_linting.md
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- 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))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed 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))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added 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))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed 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))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated 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))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed 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))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security 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-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
@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- 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))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed 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))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added 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))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed 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))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated 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))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed 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))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security 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))
+
+-->