openedx-learning 0.25.0__tar.gz → 0.27.0__tar.gz

{openedx_learning-0.25.0/openedx_learning.egg-info → openedx_learning-0.27.0}/PKG-INFO

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

{openedx_learning-0.25.0 → openedx_learning-0.27.0}/openedx_learning/__init__.py

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

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

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

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

@@ -0,0 +1,25 @@
+"""
+Backup Restore API
+"""
+import zipfile
+
+from openedx_learning.apps.authoring.publishing.api import get_learning_package_by_key
+
+from .toml import TOMLLearningPackageFile
+
+TOML_PACKAGE_NAME = "package.toml"
+
+
+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)
+    toml_file = TOMLLearningPackageFile(learning_package)
+    toml_file.create()
+    toml_content: str = toml_file.get()
+    with zipfile.ZipFile(path, "w", compression=zipfile.ZIP_DEFLATED) as zipf:
+        # Add the TOML string as a file in the ZIP
+        zipf.writestr(TOML_PACKAGE_NAME, toml_content)

openedx_learning-0.27.0/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.0/openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py

@@ -0,0 +1,45 @@
+"""
+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"
+            logger.exception(message)
+            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.0/openedx_learning/apps/authoring/backup_restore/models.py

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

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

@@ -0,0 +1,72 @@
+"""
+Utilities for backup and restore app
+"""
+
+from datetime import datetime
+from typing import Any, Dict
+
+from tomlkit import comment, document, dumps, nl, table
+from tomlkit.items import Table
+
+from openedx_learning.apps.authoring.publishing.models.learning_package import LearningPackage
+
+
+class TOMLLearningPackageFile():
+    """
+    Class to create a .toml representation of a LearningPackage instance.
+
+    This class builds a structured TOML document using `tomlkit` with metadata and fields
+    extracted from a `LearningPackage` object. The output can later be saved to a file or used elsewhere.
+    """
+
+    def __init__(self, learning_package: LearningPackage):
+        self.doc = document()
+        self.learning_package = learning_package
+
+    def _create_header(self) -> None:
+        """
+        Adds a comment with the current datetime to indicate when the export occurred.
+        This helps with traceability and file versioning.
+        """
+        self.doc.add(comment(f"Datetime of the export: {datetime.now()}"))
+        self.doc.add(nl())
+
+    def _create_table(self, params: Dict[str, Any]) -> Table:
+        """
+        Builds a TOML table section from a dictionary of key-value pairs.
+
+        Args:
+            params (Dict[str, Any]): A dictionary containing keys and values to include in the TOML table.
+
+        Returns:
+            Table: A TOML table populated with the provided keys and values.
+        """
+        section = table()
+        for key, value in params.items():
+            section.add(key, value)
+        return section
+
+    def create(self) -> None:
+        """
+        Populates the TOML document with a header and a table containing
+        metadata from the LearningPackage instance.
+
+        This method must be called before calling `get()`, otherwise the document will be empty.
+        """
+        self._create_header()
+        section = self._create_table({
+            "title": self.learning_package.title,
+            "key": self.learning_package.key,
+            "description": self.learning_package.description,
+            "created": self.learning_package.created,
+            "updated": self.learning_package.updated
+        })
+        self.doc.add("learning_package", section)
+
+    def get(self) -> str:
+        """
+        Returns:
+            str: The string representation of the generated TOML document.
+            Ensure `create()` has been called beforehand to get meaningful output.
+        """
+        return dumps(self.doc)