feat: Create a signal receiver and connect it up.

Add a signal receiver to the plugin and hook it up to a valid
openedx-events event.

Author: feanil

backend/sample_plugin/apps.py

@@ -3,15 +3,15 @@
 """
 
 from django.apps import AppConfig
-from edx_django_utils.plugins.constants import PluginSettings, PluginSignals, PluginURLs
+from edx_django_utils.plugins.constants import PluginSettings, PluginURLs
 
 
 class SamplePluginConfig(AppConfig):
     # pylint: disable=line-too-long
     """
-    Configuration for the sample_plugin Django application.
+    Configuration for the sample_plugin Django application as an edx-platform plugin
 
-    See https://github.com/openedx/edx-django-utils/blob/master/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst#manual-setup
+    See https://docs.openedx.org/projects/edx-django-utils/en/latest/plugins/how_tos/how_to_create_a_plugin_app.html#manual-setup
     for more details and examples.
     """  # noqa:
 
@@ -54,18 +54,21 @@ class SamplePluginConfig(AppConfig):
                 },
             },
         },
-        PluginSignals.CONFIG: {
-            "lms.djangoapp": {
-                PluginURLs.RELATIVE_PATH: "signals",
-                PluginSignals.RECEIVERS: [
-                    # Signals handlers can be registered here
-                ],
-            },
-            "cms.djangoapp": {
-                PluginURLs.RELATIVE_PATH: "signals",
-                PluginSignals.RECEIVERS: [
-                    # Signals handlers can be registered here
-                ],
-            },
-        },
+        # You could also define PluginSignals.CONFIG here as a part of this block
+        # and define all our openedx-events connections here explicitly.  However,
+        # it's much easier to just put all your signal recievers in one file and import
+        # that file below as a par of the ready() function.
+        #
+        # Docs for using PluginSignals can be found here:
+        #   https://docs.openedx.org/projects/edx-django-utils/en/latest/plugins/how_tos/how_to_create_a_plugin_app.html
     }
+
+    def ready(self):
+        """
+        Do any app specific loading that needs to happen.
+        """
+
+        # Import the handlers file so that our signal recievers
+        # get registered and can run when the relevant signals get
+        # fired.
+        from . import signals

backend/sample_plugin/signals.py

@@ -1,15 +1,29 @@
 """
 Signal handlers for the sample_plugin application.
+
+Possible signals you can listen to from the edx-platform repo are defined in the openedx-events repo. You can listen to
+those signals from this file which gets read as a part of django startup due to it being imported in the ready()
+function in apps.py
+
+Useful Links:
+
+- openedx-events docs: https://docs.openedx.org/projects/openedx-events/en/latest/index.html
+- openedx-events list of events: https://docs.openedx.org/projects/openedx-events/en/latest/reference/events.html
+- how to consume events: https://docs.openedx.org/projects/openedx-events/en/latest/how-tos/consume-an-event.html
+
+Note: Different signals send different params to the called function so you need to look at the `data` attribute in the
+signal definition to know what named params are getting sent and what the data in those objects is going to be.
 """
 
-# Signal handlers can be defined here if needed
-# For example:
-# from django.dispatch import receiver
-# from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_LMS_CRITICAL
-#
-# @receiver(USER_RETIRE_LMS_CRITICAL)
-# def _handle_user_retirement(sender, **kwargs):
-#     """
-#     Handle user retirement actions for this app.
-#     """
-#     pass
+from openedx_events.content_authoring.signals import COURSE_CATALOG_INFO_CHANGED
+from openedx_events.content_authoring.data import CourseCatalogData
+from django.dispatch import receiver
+import logging
+
+logger = logging.getLogger(__name__)
+
+@receiver(COURSE_CATALOG_INFO_CHANGED)
+def log_course_info_changed(signal, sender, catalog_info: CourseCatalogData, **kwargs):
+    logging.info(f"{catalog_info.course_key} has been updated!")
+
+    # Then you could take some action related to your personal systems here