openedx.features.announcements package

openedx.features.announcements package#

Subpackages#

openedx.features.announcements.settings package

Submodules#

openedx.features.announcements.apps module#

Announcements Application Configuration

class openedx.features.announcements.apps.AnnouncementsConfig(app_name, app_module)#

Bases: AppConfig

Application Configuration for Announcements

name = 'openedx.features.announcements'#

plugin_app = {'settings_config': {'lms.djangoapp': {'common': {'relative_path': 'settings.common'}, 'test': {'relative_path': 'settings.test'}}}, 'url_config': {'lms.djangoapp': {'app_name': 'openedx.features.announcements', 'namespace': 'announcements', 'regex': '^announcements/', 'relative_path': 'urls'}}}#

openedx.features.announcements.forms module#

Forms for the Announcement Editor

class openedx.features.announcements.forms.AnnouncementForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)#

Bases: ModelForm

Form for editing Announcements

class Meta#

Bases: object

fields = ['content', 'active']#

model#: alias of Announcement

base_fields = {'active': <django.forms.fields.BooleanField object>, 'content': <django.forms.fields.CharField object>}#

declared_fields = {'active': <django.forms.fields.BooleanField object>, 'content': <django.forms.fields.CharField object>}#

property media#: Return all media required to render the widgets on this form.

openedx.features.announcements.models module#

Models for Announcements

class openedx.features.announcements.models.Announcement(*args, **kwargs)#

Bases: Model

Site-wide announcements to be displayed on the dashboard

exception DoesNotExist#: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned#: Bases: MultipleObjectsReturned

active#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

content#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id#: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>#

openedx.features.announcements.urls module#

Defines URLs for announcements in the LMS.

openedx.features.announcements.views module#

Views to show announcements.

class openedx.features.announcements.views.AnnouncementsJSONView(**kwargs)#

Bases: ListView

View returning a page of announcements for the dashboard

get(request, *args, **kwargs)#: Return active announcements as json

model#: alias of Announcement

object_list#

paginate_by = 5#