Add Pre-commit hook (Azure-Samples#244)

* Move tests to root

* Pre-Commit Hook

* remove pytest.ini

* Add dev requirements to build

* Add contributing guide

.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

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

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

code/dev-requirements.txt

@@ -0,0 +1,5 @@
+pytest==8.0.0
+pytest-cov==4.1.0
+flake8==7.0.0
+pre-commit==3.5.0
+black==23.12.1

code/requirements.txt

@@ -23,6 +23,3 @@ azure-search-documents==11.4.0b8
 opencensus-ext-azure==1.1.13
 pandas==2.2.0
 python-docx==1.1.0
-
-# Add dev dependencies here - this will be refactored out by Poetry
-pytest==8.0.0