Installation

Install this plugin:

pip install git+https://github.com/aulasneo/tutor-contrib-notifications.git

Usage

Enable the jobs plugin and regenerate the environment:

tutor plugins enable notification-jobs
tutor config save
tutor {local|k8s} start

This plugin adds the following manual jobs:

tutor {local|k8s} do process-scheduled-instructor-tasks
tutor {local|k8s} do send-course-update
tutor {local|k8s} do send-recurring-nudge

For Kubernetes users, this plugin sets up CronJobs to run course updates, recurring nudges, and scheduled instructor tasks at the configured schedules. Users of a Tutor local installation will still have to configure cron outside Tutor.

Upgrading from Tutor 21

• Disable the old notifications plugin before uninstalling tutor-contrib-platform-notifications. Use tutor-mfe for notification tray integration on Tutor 22.

• Remove external cron entries calling send_email_digest, send-daily-digest, or send-weekly-digest.

• Remove the unused NOTIFICATIONS_SEND_DAILY_DIGEST, NOTIFICATIONS_SEND_WEEKLY_DIGEST, and NOTIFICATIONS_WEEKLY_SCHEDULE keys from your Tutor configuration.

• Run tutor config save and tutor k8s start to update the remaining Kubernetes jobs. Delete the obsolete weekly-emails CronJob if it still exists in your Tutor namespace. If both course updates and recurring nudges are disabled, also delete any existing notifications-emails CronJob.

The NOTIFICATIONS_DAILY_SCHEDULE setting is retained for course updates and recurring nudges.

Configuration

• NOTIFICATIONS_DAILY_SCHEDULE: Set the schedule for course updates and recurring nudges. Default is “<random-minute> 10 * * *” (every day at 10 UTC, with a randomized minute).

• NOTIFICATIONS_INSTRUCTOR_TASKS_SCHEDULE: Set the schedule for scheduled instructor tasks. Default is “<random-minute> * * * *” (every hour, with a randomized minute).

• NOTIFICATION_JOBS_SITE_DOMAIN: Optional site domain passed to send-course-update and send-recurring-nudge. Default is “{{ LMS_HOST }}”. Set it to an empty value to run those jobs for all sites.

• NOTIFICATIONS_SEND_COURSE_UPDATE: Enable course updates. Default is True.

• NOTIFICATIONS_SEND_RECURRING_NUDGE: Enable recurring nudges. Default is True.

Notes:

• The daily email CronJob is only generated when course updates or recurring nudges are enabled.

• The default randomized minute spreads CronJob launches across clusters with many sites, which helps avoid large bursts of pods starting at the same time.

• If you want a fixed execution time instead of a randomized minute, set the corresponding schedule variable explicitly in your Tutor config.

• After changing the schedules, you will need to restart the cronjobs with tutor k8s start.

Development

In your Python virtual environment, install the development dependencies and run the checks:

make requirements
make test

You can select a specific virtual environment with make requirements test PYTHON=/path/to/venv/bin/python. Packaging checks and Tutor integration tests use temporary directories, leaving your workspace’s config.yml, env/, and dist/ intact. CI runs the suite on Python 3.10 through 3.14.

License

This software is licensed under the terms of the AGPLv3.