openedx-learning 0.30.0__tar.gz → 0.30.2__tar.gz

{openedx_learning-0.30.0/openedx_learning.egg-info → openedx_learning-0.30.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.30.0
+Version: 0.30.2
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -19,12 +19,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: tomlkit
-Requires-Dist: Django
-Requires-Dist: edx-drf-extensions
-Requires-Dist: celery
 Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: edx-drf-extensions
+Requires-Dist: tomlkit
+Requires-Dist: celery
+Requires-Dist: Django
 Requires-Dist: rules<4.0
 Dynamic: author
 Dynamic: author-email

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning/__init__.py

@@ -2,4 +2,4 @@
 Open edX Learning ("Learning Core").
 """
 
-__version__ = "0.30.0"
+__version__ = "0.30.2"

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning/apps/authoring/backup_restore/api.py

@@ -9,7 +9,7 @@ from openedx_learning.apps.authoring.backup_restore.zipper import LearningPackag
 from openedx_learning.apps.authoring.publishing.api import get_learning_package_by_key
 
 
-def create_zip_file(lp_key: str, path: str, user: UserType | None = None) -> None:
+def create_zip_file(lp_key: str, path: str, user: UserType | None = None, origin_server: str | None = None) -> None:
     """
     Creates a dump zip file for the given learning package key at the given path.
     The zip file contains a TOML representation of the learning package and its contents.
@@ -17,7 +17,7 @@ def create_zip_file(lp_key: str, path: str, user: UserType | None = None) -> Non
     Can throw a NotFoundError at get_learning_package_by_key
     """
     learning_package = get_learning_package_by_key(lp_key)
-    LearningPackageZipper(learning_package, user).create_zip(path)
+    LearningPackageZipper(learning_package, user, origin_server).create_zip(path)
 
 
 def load_learning_package(path: str, key: str | None = None, user: UserType | None = None) -> dict:

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py

@@ -32,11 +32,18 @@ class Command(BaseCommand):
             help='The username of the user performing the backup operation.',
             default=None
         )
+        parser.add_argument(
+            '--origin_server',
+            type=str,
+            help='The origin server for the backup operation.',
+            default=None
+        )
 
     def handle(self, *args, **options):
         lp_key = options['lp_key']
         file_name = options['file_name']
         username = options['username']
+        origin_server = options['origin_server']
         if not file_name.lower().endswith(".zip"):
             raise CommandError("Output file name must end with .zip")
         try:
@@ -45,7 +52,7 @@ class Command(BaseCommand):
             if username:
                 user = User.objects.get(username=username)
             start_time = time.time()
-            create_zip_file(lp_key, file_name, user=user)
+            create_zip_file(lp_key, file_name, user=user, origin_server=origin_server)
             elapsed = time.time() - start_time
             message = f'{lp_key} written to {file_name} (create_zip_file: {elapsed:.2f} seconds)'
             self.stdout.write(self.style.SUCCESS(message))

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning/apps/authoring/backup_restore/serializers.py

@@ -44,7 +44,6 @@ class EntitySerializer(serializers.Serializer):  # pylint: disable=abstract-meth
     can_stand_alone = serializers.BooleanField(required=True)
     key = serializers.CharField(required=True)
     created = serializers.DateTimeField(required=True, default_timezone=timezone.utc)
-    created_by = serializers.CharField(required=True, allow_null=True)
 
 
 class EntityVersionSerializer(serializers.Serializer):  # pylint: disable=abstract-method
@@ -54,7 +53,6 @@ class EntityVersionSerializer(serializers.Serializer):  # pylint: disable=abstra
     title = serializers.CharField(required=True)
     entity_key = serializers.CharField(required=True)
     created = serializers.DateTimeField(required=True, default_timezone=timezone.utc)
-    created_by = serializers.CharField(required=True, allow_null=True)
     version_num = serializers.IntegerField(required=True)
 
 
@@ -160,7 +158,6 @@ class CollectionSerializer(serializers.Serializer):  # pylint: disable=abstract-
     title = serializers.CharField(required=True)
     key = serializers.CharField(required=True)
     description = serializers.CharField(required=True, allow_blank=True)
-    created_by = serializers.IntegerField(required=True, allow_null=True)
     entities = serializers.ListField(
         child=serializers.CharField(),
         required=True,

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning/apps/authoring/backup_restore/zipper.py

@@ -88,9 +88,22 @@ class LearningPackageZipper:
     A class to handle the zipping of learning content for backup and restore.
     """
 
-    def __init__(self, learning_package: LearningPackage, user: UserType | None = None):
+    def __init__(
+            self,
+            learning_package: LearningPackage,
+            user: UserType | None = None,
+            origin_server: str | None = None):
+        """
+        Initialize the LearningPackageZipper.
+
+        Args:
+            learning_package (LearningPackage): The learning package to zip.
+            user (UserType | None): The user initiating the backup.
+            origin_server (str | None): The origin server for the backup.
+        """
         self.learning_package = learning_package
         self.user = user
+        self.origin_server = origin_server
         self.folders_already_created: set[Path] = set()
         self.entities_filenames_already_created: set[str] = set()
         self.utc_now = datetime.now(tz=timezone.utc)
@@ -269,7 +282,9 @@ class LearningPackageZipper:
 
         with zipfile.ZipFile(path, "w", compression=zipfile.ZIP_DEFLATED) as zipf:
             # Add the package.toml file
-            package_toml_content: str = toml_learning_package(self.learning_package, self.utc_now, user=self.user)
+            package_toml_content: str = toml_learning_package(
+                self.learning_package, self.utc_now, user=self.user, origin_server=self.origin_server
+            )
             self.add_file_to_zip(zipf, Path(TOML_PACKAGE_NAME), package_toml_content, self.learning_package.updated)
 
             # Add the entities directory
@@ -493,6 +508,7 @@ class LearningPackageUnzipper:
     def __init__(self, zipf: zipfile.ZipFile, key: str | None = None, user: UserType | None = None):
         self.zipf = zipf
         self.user = user
+        self.user_id = getattr(self.user, "id", None)
         self.lp_key = key  # If provided, use this key for the restored learning package
         self.learning_package_id: int | None = None  # Will be set upon restoration
         self.utc_now: datetime = datetime.now(timezone.utc)
@@ -756,7 +772,9 @@ class LearningPackageUnzipper:
         """Save collections and their entities."""
         for valid_collection in collections.get("collections", []):
             entities = valid_collection.pop("entities", [])
-            collection = collections_api.create_collection(learning_package.id, **valid_collection)
+            collection = collections_api.create_collection(
+                learning_package.id, created_by=self.user_id, **valid_collection
+            )
             collection = collections_api.add_to_collection(
                 learning_package_id=learning_package.id,
                 key=collection.key,
@@ -767,7 +785,7 @@ class LearningPackageUnzipper:
         """Save components and published component versions."""
         for valid_component in components.get("components", []):
             entity_key = valid_component.pop("key")
-            component = components_api.create_component(learning_package.id, **valid_component)
+            component = components_api.create_component(learning_package.id, created_by=self.user_id, **valid_component)
             self.components_map_by_key[entity_key] = component
 
         for valid_published in components.get("components_published", []):
@@ -781,6 +799,7 @@ class LearningPackageUnzipper:
                 self.components_map_by_key[entity_key].publishable_entity.id,
                 content_to_replace=content_to_replace,
                 force_version_num=valid_published.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_published
             )
 
@@ -788,7 +807,7 @@ class LearningPackageUnzipper:
         """Save units and published unit versions."""
         for valid_unit in containers.get("unit", []):
             entity_key = valid_unit.get("key")
-            unit = units_api.create_unit(learning_package.id, **valid_unit)
+            unit = units_api.create_unit(learning_package.id, created_by=self.user_id, **valid_unit)
             self.units_map_by_key[entity_key] = unit
 
         for valid_published in containers.get("unit_published", []):
@@ -801,6 +820,7 @@ class LearningPackageUnzipper:
                 self.units_map_by_key[entity_key],
                 force_version_num=valid_published.pop("version_num", None),
                 components=children,
+                created_by=self.user_id,
                 **valid_published
             )
 
@@ -808,7 +828,9 @@ class LearningPackageUnzipper:
         """Save subsections and published subsection versions."""
         for valid_subsection in containers.get("subsection", []):
             entity_key = valid_subsection.get("key")
-            subsection = subsections_api.create_subsection(learning_package.id, **valid_subsection)
+            subsection = subsections_api.create_subsection(
+                learning_package.id, created_by=self.user_id, **valid_subsection
+            )
             self.subsections_map_by_key[entity_key] = subsection
 
         for valid_published in containers.get("subsection_published", []):
@@ -821,6 +843,7 @@ class LearningPackageUnzipper:
                 self.subsections_map_by_key[entity_key],
                 units=children,
                 force_version_num=valid_published.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_published
             )
 
@@ -828,7 +851,7 @@ class LearningPackageUnzipper:
         """Save sections and published section versions."""
         for valid_section in containers.get("section", []):
             entity_key = valid_section.get("key")
-            section = sections_api.create_section(learning_package.id, **valid_section)
+            section = sections_api.create_section(learning_package.id, created_by=self.user_id, **valid_section)
             self.sections_map_by_key[entity_key] = section
 
         for valid_published in containers.get("section_published", []):
@@ -841,6 +864,7 @@ class LearningPackageUnzipper:
                 self.sections_map_by_key[entity_key],
                 subsections=children,
                 force_version_num=valid_published.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_published
             )
 
@@ -859,6 +883,7 @@ class LearningPackageUnzipper:
                 # Drafts can diverge from published, so we allow ignoring previous content
                 # Use case: published v1 had files A, B; draft v2 only has file A
                 ignore_previous_content=True,
+                created_by=self.user_id,
                 **valid_draft
             )
 
@@ -872,6 +897,7 @@ class LearningPackageUnzipper:
                 self.units_map_by_key[entity_key],
                 components=children,
                 force_version_num=valid_draft.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_draft
             )
 
@@ -885,6 +911,7 @@ class LearningPackageUnzipper:
                 self.subsections_map_by_key[entity_key],
                 units=children,
                 force_version_num=valid_draft.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_draft
             )
 
@@ -898,6 +925,7 @@ class LearningPackageUnzipper:
                 self.sections_map_by_key[entity_key],
                 subsections=children,
                 force_version_num=valid_draft.pop("version_num", None),
+                created_by=self.user_id,
                 **valid_draft
             )
 

{openedx_learning-0.30.0 → openedx_learning-0.30.2/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.30.0
+Version: 0.30.2
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -19,12 +19,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: tomlkit
-Requires-Dist: Django
-Requires-Dist: edx-drf-extensions
-Requires-Dist: celery
 Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: edx-drf-extensions
+Requires-Dist: tomlkit
+Requires-Dist: celery
+Requires-Dist: Django
 Requires-Dist: rules<4.0
 Dynamic: author
 Dynamic: author-email

{openedx_learning-0.30.0 → openedx_learning-0.30.2}/openedx_learning.egg-info/requires.txt

@@ -1,7 +1,7 @@
-tomlkit
-Django
-edx-drf-extensions
-celery
 attrs
 djangorestframework<4.0
+edx-drf-extensions
+tomlkit
+celery
+Django
 rules<4.0