openedx-learning 0.26.0__tar.gz → 0.27.1__tar.gz

{openedx_learning-0.26.0/openedx_learning.egg-info → openedx_learning-0.27.1}/PKG-INFO

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

{openedx_learning-0.26.0 → openedx_learning-0.27.1}/openedx_learning/__init__.py

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

{openedx_learning-0.26.0 → openedx_learning-0.27.1}/openedx_learning/api/authoring.py

@@ -9,6 +9,7 @@ APIs.
 """
 # These wildcard imports are okay because these api modules declare __all__.
 # pylint: disable=wildcard-import
+from ..apps.authoring.backup_restore.api import *
 from ..apps.authoring.collections.api import *
 from ..apps.authoring.components.api import *
 from ..apps.authoring.contents.api import *

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/admin.py

@@ -0,0 +1,3 @@
+"""
+Django Admin pages for Backup Restore models (WIP)
+"""

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/api.py

@@ -0,0 +1,15 @@
+"""
+Backup Restore API
+"""
+from openedx_learning.apps.authoring.backup_restore.zipper import LearningPackageZipper
+from openedx_learning.apps.authoring.publishing.api import get_learning_package_by_key
+
+
+def create_zip_file(lp_key: str, path: str) -> None:
+    """
+    Creates a zip file with a toml file so far (WIP)
+
+    Can throw a NotFoundError at get_learning_package_by_key
+    """
+    learning_package = get_learning_package_by_key(lp_key)
+    LearningPackageZipper(learning_package).create_zip(path)

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/apps.py

@@ -0,0 +1,12 @@
+"""
+Backup/Restore application initialization.
+"""
+
+from django.apps import AppConfig
+
+
+class BackupRestoreConfig(AppConfig):
+    name = 'openedx_learning.apps.authoring.backup_restore'
+    verbose_name = "Learning Core > Authoring > Backup Restore"
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = "oel_backup_restore"

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py

@@ -0,0 +1,44 @@
+"""
+Django management commands to handle backup and restore learning packages (WIP)
+"""
+import logging
+
+from django.core.management import CommandError
+from django.core.management.base import BaseCommand
+
+from openedx_learning.apps.authoring.backup_restore.api import create_zip_file
+from openedx_learning.apps.authoring.publishing.api import LearningPackage
+
+logger = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    """
+    Django management command to export a learning package to a zip file.
+    """
+    help = 'Export a learning package to a zip file.'
+
+    def add_arguments(self, parser):
+        parser.add_argument('lp_key', type=str, help='The key of the LearningPackage to dump')
+        parser.add_argument('file_name', type=str, help='The name of the output zip file')
+
+    def handle(self, *args, **options):
+        lp_key = options['lp_key']
+        file_name = options['file_name']
+        if not file_name.endswith(".zip"):
+            raise CommandError("Output file name must end with .zip")
+        try:
+            create_zip_file(lp_key, file_name)
+            message = f'{lp_key} written to {file_name}'
+            self.stdout.write(self.style.SUCCESS(message))
+        except LearningPackage.DoesNotExist as exc:
+            message = f"Learning package with key {lp_key} not found"
+            raise CommandError(message) from exc
+        except Exception as e:
+            message = f"Failed to export learning package '{lp_key}': {e}"
+            logger.exception(
+                "Failed to create zip file %s (learning‑package key %s)",
+                file_name,
+                lp_key,
+            )
+            raise CommandError(message) from e

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/models.py

@@ -0,0 +1,3 @@
+"""
+Core models for Backup Restore (WIP)
+"""

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/toml.py

@@ -0,0 +1,75 @@
+"""
+TOML serialization for learning packages and publishable entities.
+"""
+
+from datetime import datetime
+
+import tomlkit
+
+from openedx_learning.apps.authoring.publishing.models import PublishableEntity, PublishableEntityVersion
+from openedx_learning.apps.authoring.publishing.models.learning_package import LearningPackage
+
+
+def toml_learning_package(learning_package: LearningPackage) -> str:
+    """Create a TOML representation of the learning package."""
+    doc = tomlkit.document()
+    doc.add(tomlkit.comment(f"Datetime of the export: {datetime.now()}"))
+    section = tomlkit.table()
+    section.add("title", learning_package.title)
+    section.add("key", learning_package.key)
+    section.add("description", learning_package.description)
+    section.add("created", learning_package.created)
+    section.add("updated", learning_package.updated)
+    doc.add("learning_package", section)
+    return tomlkit.dumps(doc)
+
+
+def toml_publishable_entity(entity: PublishableEntity) -> str:
+    """Create a TOML representation of a publishable entity."""
+
+    current_draft_version = getattr(entity, "draft", None)
+    current_published_version = getattr(entity, "published", None)
+
+    doc = tomlkit.document()
+    entity_table = tomlkit.table()
+    entity_table.add("uuid", str(entity.uuid))
+    entity_table.add("can_stand_alone", entity.can_stand_alone)
+
+    if current_draft_version:
+        draft_table = tomlkit.table()
+        draft_table.add("version_num", current_draft_version.version.version_num)
+        entity_table.add("draft", draft_table)
+
+    published_table = tomlkit.table()
+    if current_published_version:
+        published_table.add("version_num", current_published_version.version.version_num)
+    else:
+        published_table.add(tomlkit.comment("unpublished: no published_version_num"))
+    entity_table.add("published", published_table)
+
+    doc.add("entity", entity_table)
+    doc.add(tomlkit.nl())
+    doc.add(tomlkit.comment("### Versions"))
+
+    for entity_version in entity.versions.all():
+        version = tomlkit.aot()
+        version_table = toml_publishable_entity_version(entity_version)
+        version.append(version_table)
+        doc.add("version", version)
+
+    return tomlkit.dumps(doc)
+
+
+def toml_publishable_entity_version(version: PublishableEntityVersion) -> tomlkit.items.Table:
+    """Create a TOML representation of a publishable entity version."""
+    version_table = tomlkit.table()
+    version_table.add("title", version.title)
+    version_table.add("uuid", str(version.uuid))
+    version_table.add("version_num", version.version_num)
+    container_table = tomlkit.table()
+    container_table.add("children", [])
+    unit_table = tomlkit.table()
+    unit_table.add("graded", True)
+    container_table.add("unit", unit_table)
+    version_table.add("container", container_table)
+    return version_table  # For use in AoT

openedx_learning-0.27.1/openedx_learning/apps/authoring/backup_restore/zipper.py

@@ -0,0 +1,53 @@
+"""
+This module provides functionality to create a zip file containing the learning package data,
+including a TOML representation of the learning package and its entities.
+"""
+import zipfile
+from pathlib import Path
+
+from openedx_learning.apps.authoring.backup_restore.toml import toml_learning_package, toml_publishable_entity
+from openedx_learning.apps.authoring.publishing import api as publishing_api
+from openedx_learning.apps.authoring.publishing.models.learning_package import LearningPackage
+
+TOML_PACKAGE_NAME = "package.toml"
+
+
+class LearningPackageZipper:
+    """
+    A class to handle the zipping of learning content for backup and restore.
+    """
+
+    def __init__(self, learning_package: LearningPackage):
+        self.learning_package = learning_package
+
+    def create_zip(self, path: str) -> None:
+        """
+        Creates a zip file containing the learning package data.
+        Args:
+            path (str): The path where the zip file will be created.
+        Raises:
+            Exception: If the learning package cannot be found or if the zip creation fails.
+        """
+        package_toml_content: str = toml_learning_package(self.learning_package)
+
+        with zipfile.ZipFile(path, "w", compression=zipfile.ZIP_DEFLATED) as zipf:
+            # Add the package.toml string
+            zipf.writestr(TOML_PACKAGE_NAME, package_toml_content)
+
+            # Add the entities directory
+            entities_folder = Path("entities")
+            zip_info = zipfile.ZipInfo(str(entities_folder) + "/")  # Ensure trailing slash
+            zipf.writestr(zip_info, "")  # Add explicit empty directory entry
+
+            # Add the collections directory
+            collections_folder = Path("collections")
+            collections_info = zipfile.ZipInfo(str(collections_folder) + "/")  # Ensure trailing slash
+            zipf.writestr(collections_info, "")  # Add explicit empty directory
+
+            # Add each entity's TOML file
+            for entity in publishing_api.get_entities(self.learning_package.pk):
+                # Create a TOML representation of the entity
+                entity_toml_content: str = toml_publishable_entity(entity)
+                entity_toml_filename = f"{entity.key}.toml"
+                entity_toml_path = entities_folder / entity_toml_filename
+                zipf.writestr(str(entity_toml_path), entity_toml_content)

{openedx_learning-0.26.0 → openedx_learning-0.27.1}/openedx_learning/apps/authoring/components/apps.py

@@ -18,7 +18,7 @@ class ComponentsConfig(AppConfig):
         """
         Register Component and ComponentVersion.
         """
-        from ..publishing.api import register_content_models  # pylint: disable=import-outside-toplevel
+        from ..publishing.api import register_publishable_models  # pylint: disable=import-outside-toplevel
         from .models import Component, ComponentVersion  # pylint: disable=import-outside-toplevel
 
-        register_content_models(Component, ComponentVersion)
+        register_publishable_models(Component, ComponentVersion)