Sample Brightspace Data Sets headless client using OAuth 2.0 refresh tokens

• Brightspace Data Sets
• Registered OAuth 2.0 application and corresponding refresh token with scope datahub:dataexports:*
• Python 3
  • This example was tested using Python 3.6
• PostgreSQL server and database
  • This example was tested using PostgreSQL 9.6.2

• Dependent libraries installed by running python -m pip install -r requirements.txt
• A file named config.json based on the sample file
  • Note: this file contains sensitive information, and its file permissions should be set so that it is only readable by the user running this script (e.g. chmod 600 config.json)
• Create the required tables by running the SQL scripts in schema/tables on the database being used either manually or using create_schema.py

The following outlines the minimum number of files that should be present before using this script.

.
+-- schema
|   +-- upserts
|       +-- ...
+-- config.json
+-- main.py

python main.py --help
python main.py # full data sets
python main.py --differential

Once the data has been loaded into the database, the following queries should return a preview of the data:

SELECT
    u.user_name AS student_name,
    ou.name AS org_unit_name,
    go.name AS grade_object_name,
    CASE
        WHEN gr.points_denominator = 0
        THEN 0
        ELSE ROUND(gr.points_numerator / gr.points_denominator, 2)
    END AS grade
FROM grade_results gr

INNER JOIN users u
ON gr.user_id = u.user_id

INNER JOIN org_units ou
ON gr.org_unit_id = ou.org_unit_id

INNER JOIN grade_objects go
ON gr.grade_object_id = go.grade_object_id

LIMIT 50;

SELECT
    u.first_name AS first_name,
    u.last_name AS last_name,
    u.user_name AS user_name,
    ue.role_name AS enrolled_role_name,
    ou.name AS org_unit_name,
    ue.enrollment_date AS enrollment_date
FROM user_enrollments ue

INNER JOIN users u
ON ue.user_id = u.user_id

INNER JOIN org_units ou
ON ue.org_unit_id = ou.org_unit_id

LIMIT 50;