openedx-learning 0.26.0__py2.py3-none-any.whl → 0.27.0__py2.py3-none-any.whl

openedx_learning/__init__.py

@@ -2,4 +2,4 @@
 Open edX Learning ("Learning Core").
 """
 
-__version__ = "0.26.0"
+__version__ = "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/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/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/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/apps/authoring/backup_restore/models.py

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

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)

openedx_learning/apps/authoring/publishing/admin.py

@@ -3,14 +3,22 @@ Django admin for publishing models
 """
 from __future__ import annotations
 
+import functools
+
 from django.contrib import admin
 from django.db.models import Count
+from django.utils.html import format_html
+from django.utils.safestring import SafeText
 
-from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, one_to_one_related_model_html
+from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, model_detail_link, one_to_one_related_model_html
 
 from .models import (
+    Container,
+    ContainerVersion,
     DraftChangeLog,
     DraftChangeLogRecord,
+    EntityList,
+    EntityListRow,
     LearningPackage,
     PublishableEntity,
     PublishLog,
@@ -122,6 +130,12 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "can_stand_alone",
     ]
 
+    def draft_version(self, entity: PublishableEntity):
+        return entity.draft.version.version_num if entity.draft.version else None
+
+    def published_version(self, entity: PublishableEntity):
+        return entity.published.version.version_num if entity.published and entity.published.version else None
+
     def get_queryset(self, request):
         queryset = super().get_queryset(request)
         return queryset.select_related(
@@ -131,16 +145,6 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
     def see_also(self, entity):
         return one_to_one_related_model_html(entity)
 
-    def draft_version(self, entity):
-        if entity.draft.version:
-            return entity.draft.version.version_num
-        return None
-
-    def published_version(self, entity):
-        if entity.published.version:
-            return entity.published.version.version_num
-        return None
-
 
 @admin.register(Published)
 class PublishedAdmin(ReadOnlyModelAdmin):
@@ -229,7 +233,7 @@ class DraftChangeSetAdmin(ReadOnlyModelAdmin):
     """
     inlines = [DraftChangeLogRecordTabularInline]
     fields = (
-        "uuid",
+        "pk",
         "learning_package",
         "num_changes",
         "changed_at",
@@ -246,3 +250,264 @@ class DraftChangeSetAdmin(ReadOnlyModelAdmin):
         queryset = super().get_queryset(request)
         return queryset.select_related("learning_package", "changed_by") \
                        .annotate(num_changes=Count("records"))
+
+
+def _entity_list_detail_link(el: EntityList) -> SafeText:
+    """
+    A link to the detail page for an EntityList which includes its PK and length.
+    """
+    num_rows = el.entitylistrow_set.count()
+    rows_noun = "row" if num_rows == 1 else "rows"
+    return model_detail_link(el, f"EntityList #{el.pk} with {num_rows} {rows_noun}")
+
+
+class ContainerVersionInlineForContainer(admin.TabularInline):
+    """
+    Inline admin view of ContainerVersions in a given Container
+    """
+    model = ContainerVersion
+    ordering = ["-publishable_entity_version__version_num"]
+    fields = [
+        "pk",
+        "version_num",
+        "title",
+        "children",
+        "created",
+        "created_by",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    extra = 0
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related(
+            "publishable_entity_version"
+        )
+
+    def children(self, obj: ContainerVersion):
+        return _entity_list_detail_link(obj.entity_list)
+
+
+@admin.register(Container)
+class ContainerAdmin(ReadOnlyModelAdmin):
+    """
+    Django admin configuration for Container
+    """
+    list_display = ("key", "created", "draft", "published", "see_also")
+    fields = [
+        "pk",
+        "publishable_entity",
+        "learning_package",
+        "draft",
+        "published",
+        "created",
+        "created_by",
+        "see_also",
+        "most_recent_parent_entity_list",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    search_fields = ["publishable_entity__uuid", "publishable_entity__key"]
+    inlines = [ContainerVersionInlineForContainer]
+
+    def learning_package(self, obj: Container) -> SafeText:
+        return model_detail_link(
+            obj.publishable_entity.learning_package,
+            obj.publishable_entity.learning_package.key,
+        )
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related(
+            "publishable_entity",
+            "publishable_entity__learning_package",
+            "publishable_entity__published__version",
+            "publishable_entity__draft__version",
+        )
+
+    def draft(self, obj: Container) -> str:
+        """
+        Link to this Container's draft ContainerVersion
+        """
+        if draft := obj.versioning.draft:
+            return format_html(
+                'Version {} "{}" ({})', draft.version_num, draft.title, _entity_list_detail_link(draft.entity_list)
+            )
+        return "-"
+
+    def published(self, obj: Container) -> str:
+        """
+        Link to this Container's published ContainerVersion
+        """
+        if published := obj.versioning.published:
+            return format_html(
+                'Version {} "{}" ({})',
+                published.version_num,
+                published.title,
+                _entity_list_detail_link(published.entity_list),
+            )
+        return "-"
+
+    def see_also(self, obj: Container):
+        return one_to_one_related_model_html(obj)
+
+    def most_recent_parent_entity_list(self, obj: Container) -> str:
+        if latest_row := EntityListRow.objects.filter(entity_id=obj.publishable_entity_id).order_by("-pk").first():
+            return _entity_list_detail_link(latest_row.entity_list)
+        return "-"
+
+
+class ContainerVersionInlineForEntityList(admin.TabularInline):
+    """
+    Inline admin view of ContainerVersions which use a given EntityList
+    """
+    model = ContainerVersion
+    verbose_name = "Container Version that references this Entity List"
+    verbose_name_plural = "Container Versions that reference this Entity List"
+    ordering = ["-pk"]  # Newest first
+    fields = [
+        "pk",
+        "version_num",
+        "container_key",
+        "title",
+        "created",
+        "created_by",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    extra = 0
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related(
+            "container",
+            "container__publishable_entity",
+            "publishable_entity_version",
+        )
+
+    def container_key(self, obj: ContainerVersion) -> SafeText:
+        return model_detail_link(obj.container, obj.container.key)
+
+
+class EntityListRowInline(admin.TabularInline):
+    """
+    Table of entity rows in the entitylist admin
+    """
+    model = EntityListRow
+    readonly_fields = [
+        "order_num",
+        "pinned_version_num",
+        "entity_models",
+        "container_models",
+        "container_children",
+    ]
+    fields = readonly_fields  # type: ignore[assignment]
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related(
+            "entity",
+            "entity_version",
+        )
+
+    def pinned_version_num(self, obj: EntityListRow):
+        return str(obj.entity_version.version_num) if obj.entity_version else "(Unpinned)"
+
+    def entity_models(self, obj: EntityListRow):
+        return format_html(
+            "{}<ul>{}</ul>",
+            model_detail_link(obj.entity, obj.entity.key),
+            one_to_one_related_model_html(obj.entity),
+        )
+
+    def container_models(self, obj: EntityListRow) -> SafeText:
+        if not hasattr(obj.entity, "container"):
+            return SafeText("(Not a Container)")
+        return format_html(
+            "{}<ul>{}</ul>",
+            model_detail_link(obj.entity.container, str(obj.entity.container)),
+            one_to_one_related_model_html(obj.entity.container),
+        )
+
+    def container_children(self, obj: EntityListRow) -> SafeText:
+        """
+        If this row holds a Container, then link *its* EntityList, allowing easy hierarchy browsing.
+
+        When determining which ContainerVersion to grab the EntityList from, prefer the pinned
+        version if there is one; otherwise use the Draft version.
+        """
+        if not hasattr(obj.entity, "container"):
+            return SafeText("(Not a Container)")
+        child_container_version: ContainerVersion = (
+            obj.entity_version.containerversion
+            if obj.entity_version
+            else obj.entity.container.versioning.draft
+        )
+        return _entity_list_detail_link(child_container_version.entity_list)
+
+
+@admin.register(EntityList)
+class EntityListAdmin(ReadOnlyModelAdmin):
+    """
+    Django admin configuration for EntityList
+    """
+    list_display = [
+        "entity_list",
+        "row_count",
+        "recent_container_version_num",
+        "recent_container",
+        "recent_container_package"
+    ]
+    inlines = [ContainerVersionInlineForEntityList, EntityListRowInline]
+
+    def entity_list(self, obj: EntityList) -> SafeText:
+        return model_detail_link(obj, f"EntityList #{obj.pk}")
+
+    def row_count(self, obj: EntityList) -> int:
+        return obj.entitylistrow_set.count()
+
+    def recent_container_version_num(self, obj: EntityList) -> str:
+        """
+        Number of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return f"Version {latest.version_num}"
+        else:
+            return "-"
+
+    def recent_container(self, obj: EntityList) -> SafeText | None:
+        """
+        Link to the Container of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return format_html("of: {}", model_detail_link(latest.container, latest.container.key))
+        else:
+            return None
+
+    def recent_container_package(self, obj: EntityList) -> SafeText | None:
+        """
+        Link to the LearningPackage of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return format_html(
+                "in: {}",
+                model_detail_link(
+                    latest.container.publishable_entity.learning_package,
+                    latest.container.publishable_entity.learning_package.key
+                )
+            )
+        else:
+            return None
+
+    # We'd like it to appear as if these three columns are just a single
+    # nicely-formatted column, so only give the left one a description.
+    recent_container_version_num.short_description = (  # type: ignore[attr-defined]
+        "Most recent container version using this entity list"
+    )
+    recent_container.short_description = ""  # type: ignore[attr-defined]
+    recent_container_package.short_description = ""  # type: ignore[attr-defined]
+
+
+@functools.cache
+def _latest_container_version(obj: EntityList) -> ContainerVersion | None:
+    """
+    Any given EntityList can be used by multiple ContainerVersion (which may even
+    span multiple Containers). We only have space here to show one ContainerVersion
+    easily, so let's show the one that's most likely to be interesting to the Django
+    admin user: the most-recently-created one.
+    """
+    return obj.container_versions.order_by("-pk").first()

openedx_learning/apps/authoring/publishing/models/publishable_entity.py

@@ -221,6 +221,9 @@ class PublishableEntityVersion(models.Model):
         blank=True,
     )
 
+    def __str__(self):
+        return f"{self.entity.key} @ v{self.version_num} - {self.title}"
+
     class Meta:
         constraints = [
             # Prevent the situation where we have multiple
@@ -303,6 +306,9 @@ class PublishableEntityMixin(models.Model):
     def created_by(self):
         return self.publishable_entity.created_by
 
+    def __str__(self) -> str:
+        return str(self.publishable_entity)
+
     class Meta:
         abstract = True
 
@@ -570,10 +576,17 @@ class PublishableEntityVersionMixin(models.Model):
     def created(self) -> datetime:
         return self.publishable_entity_version.created
 
+    @property
+    def created_by(self):
+        return self.publishable_entity_version.created_by
+
     @property
     def version_num(self) -> int:
         return self.publishable_entity_version.version_num
 
+    def __str__(self) -> str:
+        return str(self.publishable_entity_version)
+
     class Meta:
         abstract = True
 

openedx_learning/apps/authoring/sections/admin.py

@@ -0,0 +1,48 @@
+"""
+Django admin for sections models
+"""
+from django.contrib import admin
+from django.utils.safestring import SafeText
+
+from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, model_detail_link
+
+from ..publishing.models import ContainerVersion
+from .models import Section, SectionVersion
+
+
+class SectionVersionInline(admin.TabularInline):
+    """
+    Minimal table for section versions in a section.
+
+    (Generally, this information is useless, because each SectionVersion should have a
+     matching ContainerVersion, shown in much more detail on the Container detail page.
+     But we've hit at least one bug where ContainerVersions were being created without
+     their connected SectionVersions, so we'll leave this table here for debugging
+     at least until we've made the APIs more robust against that sort of data corruption.)
+    """
+    model = SectionVersion
+    fields = ["pk"]
+    readonly_fields = ["pk"]
+    ordering = ["-pk"]  # Newest first
+
+    def pk(self, obj: ContainerVersion) -> SafeText:
+        return obj.pk
+
+
+@admin.register(Section)
+class SectionAdmin(ReadOnlyModelAdmin):
+    """
+    Very minimal interface... just direct the admin user's attention towards the related Container model admin.
+    """
+    inlines = [SectionVersionInline]
+    list_display = ["pk", "key"]
+    fields = ["key"]
+    readonly_fields = ["key"]
+
+    def key(self, obj: Section) -> SafeText:
+        return model_detail_link(obj.container, obj.key)
+
+    def get_form(self, request, obj=None, change=False, **kwargs):
+        help_texts = {'key': f'For more details of this {self.model.__name__}, click above to see its Container view'}
+        kwargs.update({'help_texts': help_texts})
+        return super().get_form(request, obj, **kwargs)

openedx_learning/apps/authoring/sections/api.py

@@ -24,7 +24,6 @@ __all__ = [
     "get_latest_section_version",
     "SectionListEntry",
     "get_subsections_in_section",
-    "get_subsections_in_section",
     "get_subsections_in_published_section_as_of",
 ]
 

openedx_learning/apps/authoring/sections/apps.py

@@ -1,5 +1,5 @@
 """
-Subsection Django application initialization.
+Sections Django application initialization.
 """
 
 from django.apps import AppConfig
@@ -7,7 +7,7 @@ from django.apps import AppConfig
 
 class SectionsConfig(AppConfig):
     """
-    Configuration for the subsections Django application.
+    Configuration for the Sections Django application.
     """
 
     name = "openedx_learning.apps.authoring.sections"

openedx_learning/apps/authoring/subsections/admin.py

@@ -0,0 +1,48 @@
+"""
+Django admin for subsection models
+"""
+from django.contrib import admin
+from django.utils.safestring import SafeText
+
+from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, model_detail_link
+
+from ..publishing.models import ContainerVersion
+from .models import Subsection, SubsectionVersion
+
+
+class SubsectionVersionInline(admin.TabularInline):
+    """
+    Minimal table for subsection versions in a subsection.
+
+    (Generally, this information is useless, because each SubsectionVersion should have a
+     matching ContainerVersion, shown in much more detail on the Container detail page.
+     But we've hit at least one bug where ContainerVersions were being created without
+     their connected SubsectionVersions, so we'll leave this table here for debugging
+     at least until we've made the APIs more robust against that sort of data corruption.)
+    """
+    model = SubsectionVersion
+    fields = ["pk"]
+    readonly_fields = ["pk"]
+    ordering = ["-pk"]  # Newest first
+
+    def pk(self, obj: ContainerVersion) -> SafeText:
+        return obj.pk
+
+
+@admin.register(Subsection)
+class SubsectionAdmin(ReadOnlyModelAdmin):
+    """
+    Very minimal interface... just direct the admin user's attention towards the related Container model admin.
+    """
+    inlines = [SubsectionVersionInline]
+    list_display = ["pk", "key"]
+    fields = ["key"]
+    readonly_fields = ["key"]
+
+    def key(self, obj: Subsection) -> SafeText:
+        return model_detail_link(obj.container, obj.key)
+
+    def get_form(self, request, obj=None, change=False, **kwargs):
+        help_texts = {'key': f'For more details of this {self.model.__name__}, click above to see its Container view'}
+        kwargs.update({'help_texts': help_texts})
+        return super().get_form(request, obj, **kwargs)

openedx_learning/apps/authoring/subsections/api.py

@@ -24,7 +24,6 @@ __all__ = [
     "get_latest_subsection_version",
     "SubsectionListEntry",
     "get_units_in_subsection",
-    "get_units_in_subsection",
     "get_units_in_published_subsection_as_of",
 ]
 

openedx_learning/apps/authoring/units/admin.py

@@ -0,0 +1,48 @@
+"""
+Django admin for units models
+"""
+from django.contrib import admin
+from django.utils.safestring import SafeText
+
+from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, model_detail_link
+
+from ..publishing.models import ContainerVersion
+from .models import Unit, UnitVersion
+
+
+class UnitVersionInline(admin.TabularInline):
+    """
+    Minimal table for unit versions in a unit
+
+    (Generally, this information is useless, because each UnitVersion should have a
+     matching ContainerVersion, shown in much more detail on the Container detail page.
+     But we've hit at least one bug where ContainerVersions were being created without
+     their connected UnitVersions, so we'll leave this table here for debugging
+     at least until we've made the APIs more robust against that sort of data corruption.)
+    """
+    model = UnitVersion
+    fields = ["pk"]
+    readonly_fields = ["pk"]
+    ordering = ["-pk"]  # Newest first
+
+    def pk(self, obj: ContainerVersion) -> SafeText:
+        return obj.pk
+
+
+@admin.register(Unit)
+class UnitAdmin(ReadOnlyModelAdmin):
+    """
+    Very minimal interface... just direct the admin user's attention towards the related Container model admin.
+    """
+    inlines = [UnitVersionInline]
+    list_display = ["pk", "key"]
+    fields = ["key"]
+    readonly_fields = ["key"]
+
+    def key(self, obj: Unit) -> SafeText:
+        return model_detail_link(obj.container, obj.key)
+
+    def get_form(self, request, obj=None, change=False, **kwargs):
+        help_texts = {'key': f'For more details of this {self.model.__name__}, click above to see its Container view'}
+        kwargs.update({'help_texts': help_texts})
+        return super().get_form(request, obj, **kwargs)

openedx_learning/apps/authoring/units/api.py

@@ -24,7 +24,6 @@ __all__ = [
     "get_latest_unit_version",
     "UnitListEntry",
     "get_components_in_unit",
-    "get_components_in_unit",
     "get_components_in_published_unit_as_of",
 ]
 

openedx_learning/lib/admin_utils.py

@@ -2,9 +2,11 @@
 Convenience utilities for the Django Admin.
 """
 from django.contrib import admin
+from django.db import models
 from django.db.models.fields.reverse_related import OneToOneRel
 from django.urls import NoReverseMatch, reverse
 from django.utils.html import format_html, format_html_join
+from django.utils.safestring import SafeText
 
 
 class ReadOnlyModelAdmin(admin.ModelAdmin):
@@ -31,7 +33,7 @@ class ReadOnlyModelAdmin(admin.ModelAdmin):
         return False
 
 
-def one_to_one_related_model_html(model_obj):
+def one_to_one_related_model_html(model_obj: models.Model) -> SafeText:
     """
     HTML for clickable list of a models that are 1:1-related to ``model_obj``.
 
@@ -98,3 +100,17 @@ def one_to_one_related_model_html(model_obj):
         text.append(html)
 
     return format_html_join("\n", "<li>{}</li>", ((t,) for t in text))
+
+
+def model_detail_link(obj: models.Model, link_text: str) -> SafeText:
+    """
+    Render an HTML link to the admin focus page for `obj`.
+    """
+    return format_html(
+        '<a href="{}">{}</a>',
+        reverse(
+            f"admin:{obj._meta.app_label}_{(obj._meta.model_name or obj.__class__.__name__).lower()}_change",
+            args=(obj.pk,),
+        ),
+        link_text,
+    )

{openedx_learning-0.26.0.dist-info → openedx_learning-0.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.26.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: djangorestframework<4.0
-Requires-Dist: celery
-Requires-Dist: edx-drf-extensions
-Requires-Dist: attrs
 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.26.0.dist-info → openedx_learning-0.27.0.dist-info}/RECORD

@@ -1,10 +1,20 @@
-openedx_learning/__init__.py,sha256=gxlH6AqH1wFwipo5FfaLp8R8Uxg7pp57boi7X8I4LT0,69
+openedx_learning/__init__.py,sha256=SyGXwpGB_cwgn1A-xCULm9ZZQwV783LkH-64qx6sehg,69
 openedx_learning/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/api/authoring.py,sha256=1sh-hUH3pJLVIQHzzjlqWb_9uxf9y3-hanLpU4mRvXc,1061
 openedx_learning/api/authoring_models.py,sha256=lA500-C7LBlVzeaEVqmCiQMAPPmeoDMi8wS0TbzgdGw,778
 openedx_learning/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openedx_learning/apps/authoring/backup_restore/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openedx_learning/apps/authoring/backup_restore/admin.py,sha256=OnEixkOuysPRr-F6C_CMwPkiXawkqgSEF46n3yiUK0o,59
+openedx_learning/apps/authoring/backup_restore/api.py,sha256=T5hYOuelkK2-UnJNDObk2DnkoKPxKdc8LJ6MwtwaXRI,760
+openedx_learning/apps/authoring/backup_restore/apps.py,sha256=UnExBA7jhd3qI30_87JMvzVhS_k82t89qDVKSMpvg_A,340
+openedx_learning/apps/authoring/backup_restore/models.py,sha256=jlr0ppxW0IOW3HPHoJNChHvDrYVnKMb5_3uC2itxqQk,45
+openedx_learning/apps/authoring/backup_restore/toml.py,sha256=zjaeVJqZJhtITVaL2Pmopkg3bhgbSM8-t4J3IUeNHts,2496
+openedx_learning/apps/authoring/backup_restore/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openedx_learning/apps/authoring/backup_restore/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py,sha256=NiZ-fEDGgh9Q0IUjpjOIvm9BtzwnVp6LK6IY-OA_o98,1734
+openedx_learning/apps/authoring/backup_restore/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/collections/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/collections/admin.py,sha256=f0hySjDMfIphVDEGkCSMIUHoEiqHRA7EE2NiO7lvL4g,1156
 openedx_learning/apps/authoring/collections/api.py,sha256=DaGg73iom7fN9fODajo8B2e9Jkx2syfLEVjip0cAzlQ,7747
@@ -36,7 +46,7 @@ openedx_learning/apps/authoring/contents/models.py,sha256=8CYrHK7CZ4U3F7Den4ZV_a
 openedx_learning/apps/authoring/contents/migrations/0001_initial.py,sha256=FtOTmIGX2KHpjw-PHbfRjxkFEomI5CEDhNKCZ7IpFeE,3060
 openedx_learning/apps/authoring/contents/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/publishing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/publishing/admin.py,sha256=sLmtttaYIQi8XWw_wOdDD9xbF34g1giMEj5yIN-b-4M,7012
+openedx_learning/apps/authoring/publishing/admin.py,sha256=nvAAl3Xswqqq3WyaI1NT7pLCcu1o-ynciJZOlc-9L24,16244
 openedx_learning/apps/authoring/publishing/api.py,sha256=BQ5Q0JsSRBmb8ZRKzUlEOOV6QxNUjYkkqCjxmnX9O48,55565
 openedx_learning/apps/authoring/publishing/apps.py,sha256=v9PTe3YoICaYT9wfu268ZkVAlnZFvxi-DqYdbRi25bY,750
 openedx_learning/apps/authoring/publishing/contextmanagers.py,sha256=AH5zhr0Tz_gUG9--dfr_oZAu8DMy94n6mnOJuPbWkeU,6723
@@ -55,21 +65,24 @@ openedx_learning/apps/authoring/publishing/models/draft_log.py,sha256=7hpbtnnc3y
 openedx_learning/apps/authoring/publishing/models/entity_list.py,sha256=8MyJqDdC8dqJY-N9UAu-WS-ZeFOYuRNMKloSY9wMH1w,3042
 openedx_learning/apps/authoring/publishing/models/learning_package.py,sha256=1fuNLHD6k0qGuL0jXYGf4-TA5WczgxJrXUdAIM_JNBI,2688
 openedx_learning/apps/authoring/publishing/models/publish_log.py,sha256=QD7Fb00yUMWM4HHae_m60JW-TDX8upbQdWCEIdhB0yE,5615
-openedx_learning/apps/authoring/publishing/models/publishable_entity.py,sha256=-6Fde_sYqaq1AUC4sw4Rf1X9Hh4jun2Py7Xhsl4VWuY,25419
+openedx_learning/apps/authoring/publishing/models/publishable_entity.py,sha256=ncks-eNn5h-b1FjWPMAYtnuiMSvFYHwsGeNWGJA8GBE,25773
 openedx_learning/apps/authoring/sections/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/sections/api.py,sha256=cwsxfHZa6fY_GyC4gSvSRAjayNQWKGY9DWLAyJ_u8Oc,10357
-openedx_learning/apps/authoring/sections/apps.py,sha256=iamzAiVlAWXGlZExP_bKSn38u4mUF8H0-Pa7eFtAkro,743
+openedx_learning/apps/authoring/sections/admin.py,sha256=OQOTtXYM-Zj8BBb1wNBkOxgkF2Pv3JdUrZ45VOEmThM,1757
+openedx_learning/apps/authoring/sections/api.py,sha256=qfT29Vgcc-1d3-BTiKY_a5M9H7oFBXVD8KqWe-1OqM0,10323
+openedx_learning/apps/authoring/sections/apps.py,sha256=h2-1csh-f3tLkauxXvn1xvi_P-l-_oe819XYO6BIYm4,738
 openedx_learning/apps/authoring/sections/models.py,sha256=2GK-dDMJwNRw_9gNFho8iKcDV-iYz_zBzqGMDmQ_jbc,1450
 openedx_learning/apps/authoring/sections/migrations/0001_initial.py,sha256=iW5AFhC26mfZNWEVNu8cTsr32Ca4htL4CUanHoXfaeY,1152
 openedx_learning/apps/authoring/sections/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/subsections/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/subsections/api.py,sha256=Cgjq3Y6ZZTzIQXMX6p7Y4jhFwIBFwKhSY_HCTeziMGc,10260
+openedx_learning/apps/authoring/subsections/admin.py,sha256=vPfOeTzh10aRhtZjXAzYsbwfw4Hc5yuySbpjAvtDH98,1795
+openedx_learning/apps/authoring/subsections/api.py,sha256=7heZHREJy4t0L8b6mOLtpi0JxLjqsJ7sHQFZc8z07a4,10229
 openedx_learning/apps/authoring/subsections/apps.py,sha256=WueCaPOE-7x3cu-6rA9FdeKzipCZSNIhvqpAbxTysOg,773
 openedx_learning/apps/authoring/subsections/models.py,sha256=1uhdpS9Eg6keSqkzQaE8-XSVLAQlmi0llIIU2V7Nl44,1492
 openedx_learning/apps/authoring/subsections/migrations/0001_initial.py,sha256=7kEHIC-EwG2KvlW4hg5tnl45--dW4Yv5gqV5SDqNYNo,1158
 openedx_learning/apps/authoring/subsections/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/units/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/units/api.py,sha256=KJA7Bh7IBE22E6cMSZNp6pamjjA1Vf8EhHw0rvQtlPM,9797
+openedx_learning/apps/authoring/units/admin.py,sha256=chp-bTfufBiQ3uycVF1DBEFSPvwXaROJnyyY8AaH_yw,1717
+openedx_learning/apps/authoring/units/api.py,sha256=Bk6CndTU3sO0SvAphEl5UWKGBkWD_TE9p12BXBxxvLQ,9767
 openedx_learning/apps/authoring/units/apps.py,sha256=cIzphjDw5sjIZ3NLE911N7IMUa8JQSXMReNl03uI7jg,701
 openedx_learning/apps/authoring/units/models.py,sha256=eTOwFWC9coQLf0ovx08Mj7zi8mPAWCw9QOznybajRk0,1418
 openedx_learning/apps/authoring/units/migrations/0001_initial.py,sha256=qM_0JGffxECVgXzncHXfgSE-g8u3L3a14R0M1Bnj_Ys,1129
@@ -80,14 +93,14 @@ openedx_learning/contrib/media_server/apps.py,sha256=GicFBN3N6wzVs5i3RgrQFJZeMlS
 openedx_learning/contrib/media_server/urls.py,sha256=newNjV41sM9A9Oy_rgnZSXdkTFxSHiupIiAsVIGE2CE,365
 openedx_learning/contrib/media_server/views.py,sha256=qZPhdEW_oYj1MEdgLVP6Cq3tRiZtp7dTb7ASaSKZ2HY,1350
 openedx_learning/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/lib/admin_utils.py,sha256=5z9NrXxmT5j8azx9u1t0AgxV5PIDTc2jPyM5z5yW8cw,4021
+openedx_learning/lib/admin_utils.py,sha256=dQ02NrgXIJL6kx9LFBgEYc1Pr_xtFdr7NVXx01VOIE0,4514
 openedx_learning/lib/cache.py,sha256=ppT36KiPLdsAF3GfZCF0IdiHodckd2gLiF1sNhjSJuk,958
 openedx_learning/lib/collations.py,sha256=f65575r3BfAvFWU6pdBMsqrxPwFijB2SbJtDXq4UVc4,2401
 openedx_learning/lib/fields.py,sha256=eiGoXMPhRuq25EH2qf6BAODshAQE3DBVdIYAMIUAXW0,7522
 openedx_learning/lib/managers.py,sha256=-Q3gxalSqyPZ9Im4DTROW5tF8wVTZLlmfTe62_xmowY,1643
 openedx_learning/lib/test_utils.py,sha256=g3KLuepIZbaDBCsaj9711YuqyUx7LD4gXDcfNC-mWdc,527
 openedx_learning/lib/validators.py,sha256=iqEdEAvFV2tC7Ecssx69kjecpdU8nE87AlDJYrqrsnc,404
-openedx_learning-0.26.0.dist-info/licenses/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.27.0.dist-info/licenses/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
 openedx_tagging/__init__.py,sha256=V9N8M7f9LYlAbA_DdPUsHzTnWjYRXKGa5qHw9P1JnNI,30
 openedx_tagging/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -129,7 +142,7 @@ openedx_tagging/core/tagging/migrations/0017_alter_tagimporttask_status.py,sha25
 openedx_tagging/core/tagging/migrations/0018_objecttag_is_copied.py,sha256=zmr4b65T0vX6fYc8MpvSmQnYkAiNMpx3RKEd5tudsl8,517
 openedx_tagging/core/tagging/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/tagging/models/__init__.py,sha256=yYdOnthuc7EUdfEULtZgqRwn5Y4bbYQmJCjVZqR5GTM,236
-openedx_tagging/core/tagging/models/base.py,sha256=RXv4jDncV-JPXMAb62dGYNJhMdiS6kSo24eoG7UeKR4,39655
+openedx_tagging/core/tagging/models/base.py,sha256=ju4mvgRS_I2AgPsRf4sMFy6qle2i0aA0MbyBYZXf32g,39685
 openedx_tagging/core/tagging/models/import_export.py,sha256=Aj0pleh0nh2LNS6zmdB1P4bpdgUMmvmobTkqBerORAI,4570
 openedx_tagging/core/tagging/models/system_defined.py,sha256=_6LfvUZGEltvQMtm2OXy6TOLh3C8GnVTqtZDSAZW6K4,9062
 openedx_tagging/core/tagging/models/utils.py,sha256=-A3Dj24twmTf65UB7G4WLvb_9qEvduEPIwahZ-FJDlg,1926
@@ -143,7 +156,7 @@ openedx_tagging/core/tagging/rest_api/v1/serializers.py,sha256=0HQD_Jrf6-YpocYfz
 openedx_tagging/core/tagging/rest_api/v1/urls.py,sha256=dNUKCtUCx_YzrwlbEbpDfjGVQbb2QdJ1VuJCkladj6E,752
 openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=Hf92cy-tE767DE9FgsZcPKiCYrf5ihfETz8qGKBnuiU,36278
 openedx_tagging/core/tagging/rest_api/v1/views_import.py,sha256=kbHUPe5A6WaaJ3J1lFIcYCt876ecLNQfd19m7YYub6c,1470
-openedx_learning-0.26.0.dist-info/METADATA,sha256=c8OUFRhcuUhOqInl5uLmPhAutB08-Z0zbjhWw5j1br8,9032
-openedx_learning-0.26.0.dist-info/WHEEL,sha256=XAkygS4h1cf0JYWV13kJhTWht2y9NqKAsZuiTHc2920,109
-openedx_learning-0.26.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.26.0.dist-info/RECORD,,
+openedx_learning-0.27.0.dist-info/METADATA,sha256=aj1eSVrsZiti6xVUZKZONiQbNPv-5tD8AbAkiOKbgvk,9055
+openedx_learning-0.27.0.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+openedx_learning-0.27.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.27.0.dist-info/RECORD,,

{openedx_learning-0.26.0.dist-info → openedx_learning-0.27.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

openedx_tagging/core/tagging/models/base.py

@@ -509,7 +509,7 @@ class Taxonomy(models.Model):
                 count=models.Func(F('id'), function='Count')
             )
             qs = qs.annotate(usage_count=models.Subquery(obj_tags.values('count')))
-        return qs
+        return qs  # type: ignore[return-value]
 
     def _get_filtered_tags_deep(
         self,