Merge branch 'main' into bugfix/message-index

.devcontainer/devcontainer.json

@@ -12,7 +12,7 @@
 		}
 	},
 
-	"postCreateCommand": "pip install -r code/requirements.txt -r code/app/requirements.txt -r extensions/backend/requirements.txt",
+	"postCreateCommand": "./.devcontainer/postCreate.sh",
 
 	"customizations": {
 		"vscode": {

.devcontainer/postCreate.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+pip install --upgrade pip
+
+pip install -r code/requirements.txt -r code/app/requirements.txt -r extensions/backend/requirements.txt
+
+pip install -r code/dev-requirements.txt
+
+pre-commit install

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E501

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2 
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pre-build image and run make in dev container
+        uses: devcontainers/ci@v0.3
+        with:
+          imageName: ghcr.io/azure-samples/chat-with-your-data-solution-accelerator
+          cacheFrom: ghcr.io/azure-samples/chat-with-your-data-solution-accelerator
+          runCmd: make ci
+          refFilterForPush: refs/heads/main

.github/workflows/unittests.yml

@@ -20,6 +20,6 @@ jobs:
             architecture: x64
         - name: Install dependencies
           run: |
-            pip install -r code/requirements.txt
+            pip install -r code/requirements.txt -r code/dev-requirements.txt
         - name: Run Python tests
           run: python -m pytest --rootdir=code -m "not azure"

.gitignore

@@ -4,10 +4,7 @@
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # generated frontend files
-static/*.html
-static/assets/*.js
-static/assets/*.map
-static/assets/*.css
+code/app/static/
 
 # User-specific files
 *.rsuser

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+    -   id: flake8
+        args: [--extend-ignore=E501]

CONTRIBUTING.md

@@ -62,6 +62,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 * Make your changes in a new git fork:
 
 * Commit your changes using a descriptive commit message
+* If you are using the devcontainer, committing code will run black and flake8 to lint python code. You can run `black .` or `flake8 .` at anytime.
 * Push your fork to GitHub:
 * In GitHub, create a pull request
 * If we suggest changes then:

Makefile

@@ -0,0 +1,27 @@
+SHELL := /bin/bash
+
+.PHONY: help
+.DEFAULT_GOAL := help
+
+ENV_FILE := .env
+ifeq ($(filter $(MAKECMDGOALS),config clean),)
+	ifneq ($(strip $(wildcard $(ENV_FILE))),)
+		ifneq ($(MAKECMDGOALS),config)
+			include $(ENV_FILE)
+			export
+		endif
+	endif
+endif
+
+help: ## 💬 This help message :)
+	@grep -E '[a-zA-Z_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-23s\033[0m %s\n", $$1, $$2}'
+
+ci: unittest build-frontend ## 🚀 Continuous Integration (called by Github Actions)
+
+unittest: ## 🧪 Run the unit tests
+	@echo -e "\e[34m$@\e[0m" || true
+	@python -m pytest -m "not azure"
+
+build-frontend: ## 🏗️ Build the Frontend webapp
+	@echo -e "\e[34m$@\e[0m" || true
+	@cd code/app/frontend && npm install && npm run build

code/admin/Admin.py

@@ -1,17 +1,24 @@
 import streamlit as st
 import os
 import logging
+import sys
 from dotenv import load_dotenv
-load_dotenv()
 
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+load_dotenv()
 
-logger = logging.getLogger('azure.core.pipeline.policies.http_logging_policy').setLevel(logging.WARNING)
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
 
+logger = logging.getLogger("azure.core.pipeline.policies.http_logging_policy").setLevel(
+    logging.WARNING
+)
 
 
-st.set_page_config(page_title="Admin", page_icon=os.path.join('images','favicon.ico'), layout="wide", menu_items=None)
+st.set_page_config(
+    page_title="Admin",
+    page_icon=os.path.join("images", "favicon.ico"),
+    layout="wide",
+    menu_items=None,
+)
 
 mod_page_style = """
             <style>
@@ -23,14 +30,16 @@
 st.markdown(mod_page_style, unsafe_allow_html=True)
 
 
-col1, col2, col3 = st.columns([1,2,1])
+col1, col2, col3 = st.columns([1, 2, 1])
 with col1:
-    st.image(os.path.join('images','logo.png'))
-    
+    st.image(os.path.join("images", "logo.png"))
+
 st.write("# Chat with your data Solution Accelerator")
 
-st.write("""
+st.write(
+    """
          * If you want to ingest data (pdf, websites, etc.), then use the `Ingest Data` tab
          * If you want to explore how your data was chunked, check the `Explore Data` tab
          * If you want to adapt the underlying prompts, logging settings and others, use the `Configuration` tab
-         """)
+         """
+)