Merge pull request #1 from pamelafox/workflow

.github/workflows/check.yaml

@@ -0,0 +1,43 @@
+name: Python checks
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:11
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+        - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+        - uses: actions/checkout@v3
+        - name: Set up Python 3
+          uses: actions/setup-python@v3
+          with:
+            python-version: 3.9
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -r requirements-dev.txt
+        - name: Lint with flake8
+          run: |
+            # stop the build if there are Python syntax errors or undefined names
+            flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+            # exit-zero treats all errors as warnings.
+            flake8 . --count --exit-zero  --statistics
+        - name: Check formatting with black
+          uses: psf/black@stable
+          with:
+            src: ". quizsite/ quizzes/"
+            options: "--check --verbose"
+        - name: Run unit tests
+          env:
+            DBUSER: postgres
+            DBPASS: postgres
+          run: |
+            coverage run --source='.' manage.py test quizzes
+            coverage report

README.md

@@ -12,10 +12,11 @@ https://django-example-quizsite.azurewebsites.net/quizzes/
 
 ## Local development
 
-Install the requirements:
+Install the requirements and Git hooks:
 
 ```
 pip install -r requirements-dev.txt
+pre-commit install
 ```
 
 Create a local PostGreSQL database called "quizsite"
@@ -33,6 +34,13 @@ Run the local server:
 python manage.py runserver
 ```
 
+Run tests:
+
+```
+coverage run --source='.' manage.py test quizzes
+coverage report
+```
+
 ## Deployment
 
 The app is currently hosted on Microsoft Azure. Specifically:
@@ -42,4 +50,4 @@ The app is currently hosted on Microsoft Azure. Specifically:
 
 To deploy your own instance, follow the [tutorial for Django app + PostGreSQL deployment](https://docs.microsoft.com/en-us/azure/app-service/tutorial-python-postgresql-app?tabs=django%2Cwindows%2Cvscode-aztools%2Cterminal-bash%2Cazure-portal-access%2Cvscode-aztools-deploy%2Cdeploy-instructions-azportal%2Cdeploy-instructions--zip-azcli%2Cdeploy-instructions-curl-bash) but using this app instead of the sample app.
 
-Make sure you specify the following environment variables in the App Service configuration: `DBHOST`, `DBNAME`, `DBPASS`, `DBUSER`. The previously linked tutorial shows how to set these.
+Make sure you specify the following environment variables in the App Service configuration: `DBHOST`, `DBNAME`, `DBPASS`, `DBUSER`. The previously linked tutorial shows how to set these.

requirements-dev.txt

@@ -1,4 +1,5 @@
 -r requirements.txt
-black==22.3.0
+black
 pre-commit
-flake8
+flake8
+coverage