Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.39 KB

README.md

File metadata and controls

49 lines (35 loc) · 1.39 KB
Raw

DatabaseExporter

Exports Open edX data from MySQL database into a spreadsheet. It is possible to export the sheets to a single multi sheet xlsx file or alternatively update a Google Sheet file. On the NAU project it is used the second option. The NAU dashboard, based on Google Data Studio, use that Google Sheet has one of its data source.

The mysql database user needs a read grant for the edxapp database.

Those scripts should be run at least once a day, preference after the midnight, so your Google Sheet file always contains the yesterday's data in full.

The queries don't have any reference to individual users, and don't have specific identification numbers, like user id, emails or similar data; so it's GDPR compliant.

Usage

  • Setup a Virtual Environment
  • Set the config.ini file based on the config.init.sample.
  • Execute report_xlsx.py or report_google.py.

Activate virtual environment and install its dependencies

Use python 3.11.

virtualenv venv --python=python3
source venv/bin/activate
pip install -r requirements.txt --upgrade

Set the "config.ini" file based on the "config.init.sample".

cp config.init.sample config.ini
vim config.ini

Export data to a xlsx file

python export.py --config config.ini --export xlsx

Export data to a Google Sheet

python export.py --config config.ini --export google_sheets