docs

Author: asadali145

src/ol_openedx_course_sync/BUILD

@@ -13,7 +13,7 @@ python_distribution(
     provides=setup_py(
         name="ol-openedx-course-sync",
         version="0.1.0",
-        description="An edX plugin to sync changes in a course to its child courses",
+        description="An edX plugin to sync changes in a course to its target/child/rerun courses",
         license="BSD-3-Clause",
         author="MIT Office of Digital Learning",
         entry_points={

src/ol_openedx_course_sync/README.rst

@@ -1,7 +1,7 @@
-edX Username Changer
+OL Open edX Course Sync
 =======================
 
-A plugin to enable course updates sync to the target/rerun courses.
+A plugin to enable course updates to sync with the target/child/rerun courses.
 
 Version Compatibility
 ---------------------
@@ -16,3 +16,15 @@ For detailed installation instructions, please refer to the `plugin installation
 Installation required in:
 
 * CMS
+
+Usage
+-----
+
+- Install the plugin and Run the migrations in the CMS.
+- Add the parent/source organization in the CMS admin model `CourseSyncParentOrg`.
+  - Course sync will only work for this organization. It will treat all the courses under this organization as parent/source courses.
+- Plugin will automatically add course reruns created from the CMS as the target/child courses for any of the parent course from the organization added above.
+  -  Organization can be different for the reruns.
+- Target/child/rerun courses can be managed in the CMS admin model `CourseSyncMap`.
+  - You can update the comma separated target course list.
+- Now any changes made in the parent/source course will be synced to the target/child/rerun courses.

src/ol_openedx_course_sync/__init__.py

@@ -1,3 +1,6 @@
-# pylint: disable=missing-module-docstring
+"""
+ol-openedx-course-sync plugin
+"""
+
 __version__ = 0.1
 default_app_config = "ol_openedx_course_sync.apps.OLOpenEdxCourseSyncConfig"

src/ol_openedx_course_sync/admin.py

@@ -1,5 +1,5 @@
 """
-Django admin pages for ol-openedx-course-sync plugin
+Django admin for ol-openedx-course-sync plugin
 """
 
 from django.contrib import admin

src/ol_openedx_course_sync/models.py

@@ -1,3 +1,7 @@
+"""
+Models for ol-openedx-course-sync plugin
+"""
+
 from django.db import models
 from opaque_keys.edx.django.models import (
     CourseKeyField,

src/ol_openedx_course_sync/signals.py

@@ -1,5 +1,5 @@
 """
-Signal handlers ol-openedx-course-sync plugin
+Signal handlers for ol-openedx-course-sync plugin
 """
 
 import logging
@@ -21,7 +21,7 @@ def listen_for_course_publish(
     **kwargs,  # noqa: ARG001
 ):
     """
-    Copy course content from source course to destination course.
+    Listen for course publish signal and trigger course sync task
     """
     if not CourseSyncParentOrg.objects.filter(organization=course_key.org).exists():
         return
@@ -41,7 +41,7 @@ def listen_for_course_publish(
 @receiver(post_save, sender=CourseRerunState)
 def listen_for_course_rerun_state_post_save(sender, instance, **kwargs):  # noqa: ARG001
     """
-    Update target courses in `CourseSyncMap`
+    Listen for `CourseRerunState` post_save and update target courses in `CourseSyncMap`
     """
     if instance.state != "succeeded":
         return

src/ol_openedx_course_sync/utils.py

@@ -1,10 +1,14 @@
+"""
+Utility methods for the ol-openedx-course-sync plugin
+"""
+
 from xmodule.modulestore.django import modulestore
 
 
 def copy_course_content(user_id, source_course_key, dest_course_key, branch):
     """
     Copy course content from source course to destination
-    course on the specified modulestore branch.
+    course on the specified branch.
     """
     module_store = modulestore()
     subtree_list = [module_store.make_course_usage_key(source_course_key)]