openedx.core.djangoapps.notifications.management.commands package

Submodules

openedx.core.djangoapps.notifications.management.commands.delete_expired_notifications module

Management command for deleting expired notifications

class openedx.core.djangoapps.notifications.management.commands.delete_expired_notifications.Command(stdout=None, stderr=None, no_color=False, force_color=False)

Bases: BaseCommand

Invoke with:

python manage.py lms delete_expired_notifications

handle(*args, **kwargs)

The actual logic of the command. Subclasses must implement this method.

help = 'Deletes notifications that have been expired'

openedx.core.djangoapps.notifications.management.commands.delete_notifications module

Management command for deleting notifications with parameters

class openedx.core.djangoapps.notifications.management.commands.delete_notifications.Command(stdout=None, stderr=None, no_color=False, force_color=False)

Bases: BaseCommand

Invoke with:

python manage.py lms delete_notifications

add_arguments(parser)

Add command line arguments to management command

handle(*args, **kwargs)

Calls delete notifications task

help = 'Delete notifications that meets a criteria. Requires app_name, notification_type and created (duration)'

openedx.core.djangoapps.notifications.management.commands.delete_notifications.argparse_date(string: str)

Argparse Type to return datetime dictionary from string Returns { ‘created__gte’: datetime, ‘created__lte’: datetime, }

openedx.core.djangoapps.notifications.management.commands.delete_notifications.parse_date(string)

Converts string date to datetime object

openedx.core.djangoapps.notifications.management.commands.generate_course_notification_preferences module

Management command for creating Course Notification Preferences for users in course.

class openedx.core.djangoapps.notifications.management.commands.generate_course_notification_preferences.Command(stdout=None, stderr=None, no_color=False, force_color=False)

Bases: BaseCommand

Invoke with:

python manage.py [lms|cms] generate_course_notification_preferences [course_id] [course_id] …

add_arguments(parser)

Entry point for subclassed commands to add custom arguments.

handle(*args, **options)

The actual logic of the command. Subclasses must implement this method.

help = 'Back-fill missing course notification preferences. This will queue a celery task to create course notification preferences for all active enrollments in the courses provided.'

openedx.core.djangoapps.notifications.management.commands.send_email_digest module

Management command for sending email digest

class openedx.core.djangoapps.notifications.management.commands.send_email_digest.Command(stdout=None, stderr=None, no_color=False, force_color=False)

Bases: BaseCommand

Invoke with:

python manage.py lms send_email_digest [cadence_type] cadence_type: Daily or Weekly

add_arguments(parser)

Adds management commands parser arguments

handle(*args, **kwargs)

Start task to send email digest to users

help = 'Send email digest to user.'

Module contents