process all courses' assignments; misc. other cleaning up (iss. #6, #7, #8, #10)

.github/workflows/pycodestyle.yaml

@@ -0,0 +1,27 @@
+name: peer-review-data
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest
+          if [ -f requirements_dev.txt ]; then pip install -r requirements_dev.txt; fi
+          python -m pip install .
+      - name: Python Style Checker
+        uses: andymckay/[email protected]

Dockerfile

@@ -11,7 +11,8 @@ WORKDIR /app
 COPY requirements.txt .
 RUN pip install -r /app/requirements.txt
 
-# With `docker compose`, dev. directory already mounted at /app
-#COPY . .
+# With `docker compose`, dev. directory already mounted at /app.
+# In dev., the `COPY` line may be commented out to build faster.
+COPY . .
 
 CMD ["./start.sh"]

README.md

@@ -1,4 +1,5 @@
 # peer-review-data
+
 Extract LMS peer review data for analysis by external applications.
 
 ## Running
@@ -7,27 +8,47 @@ Extract LMS peer review data for analysis by external applications.
 
 Use Docker compose to run in a local development environment.
 
-1. Copy `config/.env.sample` to `.env` in the root directory of the project.  Edit the file to replace the values contained therein with valid ones for the test environment.  Refer to comments in the file as guides to the appropriate values.
+1. Copy `config/.env.sample` to `.env` in the root directory of the project.
+   Edit the file to replace the values contained therein with valid ones for
+   the test environment. Refer to comments in the file as guides to the
+   appropriate values.
 
     ```sh
     cp config/.env.sample .env
     vim .env
     ```
 
-1. Use Docker's `compose` tool to build the application, run it, and produce an output file.
+2. Use Docker's `compose` tool to run the application after building it. The
+   application will query the Canvas course(s) specified in `.env` and save
+   data from all of the peer-reviewed assignments to the database.
 
     ```sh
     docker compose up --build
     ```
 
-1. Examine the data in the output file, `assessments.json`. 
+3. Examine the data in the database, referring to the model diagram below. To
+   connect to the database, make a MySQL or MariaDB connection with the
+   following parameter values, most of which come from `docker-compose.yaml`:
+    * Host: `localhost` (because Docker is running on the local computer)
+    * Port: `5555` (via `.services.db.ports`)
+    * Database: `peer-review-data`
+    * Username: `peer-review-data`
+    * Password: `peer-review-data_pw`
 
 ## Resources
 
+### Database Model Diagram
+
+![](dataModel.png)
+
 ### Canvas API functions
 
 1. `/api/v1/courses/<course_id>` — canvasapi.canvas.Canvas.get_course()
-2. `/api/v1/courses/<course_id>/assignments/<assignment_id>` — canvasapi.course.Course.get_assignment()
-3. `/api/v1/courses/<course_id>/rubrics/<rubric_id>` — canvasapi.course.Course.get_rubric()
-4. `/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions` — canvasapi.assignment.Assignment.get_submissions()
-5. `/api/v1/courses/<course_id>/search_users` — canvasapi.course.Course.get_users()
+2. `/api/v1/courses/<course_id>/assignments/<assignment_id>` —
+   canvasapi.course.Course.get_assignment()
+3. `/api/v1/courses/<course_id>/rubrics/<rubric_id>` —
+   canvasapi.course.Course.get_rubric()
+4. `/api/v1/courses/<course_id>/assignments/<assignment_id>/submissions` —
+   canvasapi.assignment.Assignment.get_submissions()
+5. `/api/v1/courses/<course_id>/search_users` —
+   canvasapi.course.Course.get_users()

canvasData.py

@@ -1,7 +1,4 @@
 # -*- coding: utf-8 -*-
-import os
-import sys
-from logging import Logger, getLogger
 from typing import List
 
 from canvasapi import Canvas
@@ -11,33 +8,9 @@
 from canvasapi.submission import Submission
 from canvasapi.user import User
 
-# from canvasapi.canvas_object import CanvasObject
+import config
 
-LOGGER: Logger = getLogger(__name__)
-
-CANVAS_API_URL: str = os.getenv('CANVAS_API_URL',
-                                'https://canvas-test.it.umich.edu/')
-CANVAS_API_TOKEN: str = os.getenv('CANVAS_API_TOKEN')
-COURSE_ID: str = os.getenv('COURSE_ID')
-ASSIGNMENT_ID: str = os.getenv('ASSIGNMENT_ID')
-
-envErrors = []
-
-if CANVAS_API_TOKEN is None:
-    envErrors.append('CANVAS_API_TOKEN')
-
-if COURSE_ID is None:
-    envErrors.append('COURSE_ID')
-
-if ASSIGNMENT_ID is None:
-    envErrors.append('ASSIGNMENT_ID')
-
-if len(envErrors) > 0:
-    LOGGER.critical('The following environment variable(s) are not set: '
-                    f'{", ".join(envErrors)}')
-    sys.exit()
-
-canvas = Canvas(CANVAS_API_URL, CANVAS_API_TOKEN)
+canvas = Canvas(config.CANVAS_BASE_URL, config.CANVAS_API_TOKEN)
 
 
 class CanvasUser(User):

config.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+import os
+from logging import Logger, getLogger
+
+import sys
+
+LOGGER: Logger = getLogger(__name__)
+
+CANVAS_BASE_URL: str | None = os.getenv('CANVAS_BASE_URL')
+CANVAS_API_TOKEN: str | None = os.getenv('CANVAS_API_TOKEN')
+COURSE_IDS_CSV: str | None = os.getenv('COURSE_IDS_CSV')
+COURSE_IDS: list[str] | None = [
+    c.strip() for c in COURSE_IDS_CSV.split(',') if c.isdigit()
+] if COURSE_IDS_CSV else None
+
+
+def checkConfig():
+    envErrors = []
+
+    if CANVAS_BASE_URL is None:
+        envErrors.append('CANVAS_BASE_URL')
+
+    if CANVAS_API_TOKEN is None:
+        envErrors.append('CANVAS_API_TOKEN')
+
+    if COURSE_IDS_CSV is None:
+        envErrors.append('COURSE_IDS_CSV')
+
+    if len(envErrors) > 0:
+        LOGGER.critical('The following environment variable(s) are not set: '
+                        f'{", ".join(envErrors)}')
+        sys.exit()
+
+    if COURSE_IDS is None:
+        LOGGER.critical('COURSE_IDS could not be set. '
+                        '(Problem parsing COURSE_IDS_CSV?)')
+        sys.exit()
+
+
+checkConfig()

config/.env.sample

@@ -1,27 +1,29 @@
 # DOCKER_COMPOSE: any - Setting a value indicates running via `docker compose`
 DOCKER_COMPOSE=TRUE
 
+# DOCKER_KEEP_ALIVE_TIME: any - Keep container running after the app exits.
+# Useful for debugging.  Time value may use the following optional suffixes…
+# "s": seconds (the default), "m": minutes, "h": hours, or "d": days.
+DOCKER_KEEP_ALIVE_TIME=''
+
 # LOG_LEVEL: any - A string or number indicating the log level.  If not set,
 # the default value is "INFO".  Note: String values are upper-cased before use.
 # NB: The "DEBUG" level turns on Django framework debugging, which is very,
 # very verbose.
 # TODO: Implement another log level setting for the application only.
 LOG_LEVEL=INFO
 
-# CANVAS_API_URL: url - URL of the Canvas instance's API
-# This is the BASE URL of the Canvas instance.  The "canvasapi" module this
-# app uses will add the necessary path elements.
-# TODO: Rename to `CANVAS_BASE_URL`.
-CANVAS_API_URL=https://canvas.example.edu/
+# CANVAS_BASE_URL: URL - URL of the Canvas instance's API
+# This is the BASE URL of the Canvas instance.  The "canvasapi" module used
+# by this app will add the necessary path elements.
+CANVAS_BASE_URL=https://canvas.example.edu/
 
 # CANVAS_API_TOKEN: str - Token for Canvas API access
 CANVAS_API_TOKEN=CANVAS_API_TOKEN_VALUE_HERE
 
-# COURSE_ID: int - ID number of the Canvas course containing the assignment
-COURSE_ID=1234567890
-
-# ASSIGNMENT_ID: int - ID number of the Canvas assignment
-ASSIGNMENT_ID=1234567890
+# COURSE_IDS_CSV: array[str] - ID numbers of Canvas courses to look for
+# assignments.  Use simple CSV format.
+COURSE_IDS_CSV=123,456,7890
 
 # DB_HOST: str - Hostname or docker compose label of DB server
 DB_HOST=peer-review-data_db

docker-compose.yaml

@@ -19,6 +19,7 @@ services:
       - ./.data/mysql:/var/lib/mysql:delegated
       - ./mysql:/docker-entrypoint-initdb.d:ro
     container_name: peer-review-data_db
+
   main:
     build:
       context: .

mypy.ini

@@ -0,0 +1,4 @@
+[mypy]
+python_version = 3.11
+warn_return_any = True
+warn_unused_configs = True