openedx-learning 0.30.2__py2.py3-none-any.whl → 0.31.0__py2.py3-none-any.whl

openedx_learning/__init__.py

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

openedx_learning/api/authoring.py

@@ -2,21 +2,14 @@
 This is the public API for content authoring in Learning Core.
 
 This is the single ``api`` module that code outside of the
-``openedx_learning.apps.authoring.*`` package should import from. It will
+``openedx_learning.apps.openedx_content.*`` package should import from. It will
 re-export the public functions from all api.py modules of all authoring apps. It
 may also implement its own convenience APIs that wrap calls to multiple app
 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 *
-from ..apps.authoring.publishing.api import *
-from ..apps.authoring.sections.api import *
-from ..apps.authoring.subsections.api import *
-from ..apps.authoring.units.api import *
+from ..apps.openedx_content.api import *
 
 # This was renamed after the authoring API refactoring pushed this and other
 # app APIs into the openedx_learning.api.authoring module. Here I'm aliasing to

openedx_learning/api/authoring_models.py

@@ -7,10 +7,10 @@ consistent.
 """
 # These wildcard imports are okay because these modules declare __all__.
 # pylint: disable=wildcard-import
-from ..apps.authoring.collections.models import *
-from ..apps.authoring.components.models import *
-from ..apps.authoring.contents.models import *
-from ..apps.authoring.publishing.models import *
-from ..apps.authoring.sections.models import *
-from ..apps.authoring.subsections.models import *
-from ..apps.authoring.units.models import *
+from ..apps.openedx_content.applets.collections.models import *
+from ..apps.openedx_content.applets.components.models import *
+from ..apps.openedx_content.applets.contents.models import *
+from ..apps.openedx_content.applets.publishing.models import *
+from ..apps.openedx_content.applets.sections.models import *
+from ..apps.openedx_content.applets.subsections.models import *
+from ..apps.openedx_content.applets.units.models import *

openedx_learning/api/django.py

@@ -0,0 +1,24 @@
+"""
+Module for parts of the Learning Core API that exist to make it easier to use in
+Django projects.
+"""
+
+
+def openedx_learning_apps_to_install():
+    """
+    Return all app names for appending to INSTALLED_APPS.
+
+    This function exists to better insulate edx-platform and potential plugins
+    over time, as we eventually plan to remove the backcompat apps.
+    """
+    return [
+        "openedx_learning.apps.openedx_content",
+        "openedx_learning.apps.openedx_content.backcompat.backup_restore",
+        "openedx_learning.apps.openedx_content.backcompat.collections",
+        "openedx_learning.apps.openedx_content.backcompat.components",
+        "openedx_learning.apps.openedx_content.backcompat.contents",
+        "openedx_learning.apps.openedx_content.backcompat.publishing",
+        "openedx_learning.apps.openedx_content.backcompat.sections",
+        "openedx_learning.apps.openedx_content.backcompat.subsections",
+        "openedx_learning.apps.openedx_content.backcompat.units",
+    ]

openedx_learning/apps/openedx_content/admin.py

@@ -0,0 +1,13 @@
+"""
+This module aggregates all applet Django Admin modules.
+"""
+# pylint: disable=wildcard-import
+
+from .applets.backup_restore.admin import *
+from .applets.collections.admin import *
+from .applets.components.admin import *
+from .applets.contents.admin import *
+from .applets.publishing.admin import *
+from .applets.sections.admin import *
+from .applets.subsections.admin import *
+from .applets.units.admin import *

openedx_learning/apps/openedx_content/api.py

@@ -0,0 +1,16 @@
+"""
+This module aggregates all applet API modules.
+
+Question: Should this replace openedx_learning.api.authoring?
+"""
+
+# pylint: disable=wildcard-import
+
+from .applets.backup_restore.api import *
+from .applets.collections.api import *
+from .applets.components.api import *
+from .applets.contents.api import *
+from .applets.publishing.api import *
+from .applets.sections.api import *
+from .applets.subsections.api import *
+from .applets.units.api import *

openedx_learning/apps/{authoring → openedx_content/applets}/backup_restore/api.py

@@ -5,8 +5,8 @@ import zipfile
 
 from django.contrib.auth.models import User as UserType  # pylint: disable=imported-auth-user
 
-from openedx_learning.apps.authoring.backup_restore.zipper import LearningPackageUnzipper, LearningPackageZipper
-from openedx_learning.apps.authoring.publishing.api import get_learning_package_by_key
+from ..publishing.api import get_learning_package_by_key
+from .zipper import LearningPackageUnzipper, LearningPackageZipper
 
 
 def create_zip_file(lp_key: str, path: str, user: UserType | None = None, origin_server: str | None = None) -> None:

openedx_learning/apps/{authoring → openedx_content/applets}/backup_restore/serializers.py

@@ -5,7 +5,7 @@ from datetime import timezone
 
 from rest_framework import serializers
 
-from openedx_learning.apps.authoring.components import api as components_api
+from ..components import api as components_api
 
 
 class LearningPackageSerializer(serializers.Serializer):  # pylint: disable=abstract-method

openedx_learning/apps/{authoring → openedx_content/applets}/backup_restore/toml.py

@@ -8,10 +8,10 @@ from typing import Any, Dict
 import tomlkit
 from django.contrib.auth.models import User as UserType  # pylint: disable=imported-auth-user
 
-from openedx_learning.apps.authoring.collections.models import Collection
-from openedx_learning.apps.authoring.publishing import api as publishing_api
-from openedx_learning.apps.authoring.publishing.models import PublishableEntity, PublishableEntityVersion
-from openedx_learning.apps.authoring.publishing.models.learning_package import LearningPackage
+from ..collections.models import Collection
+from ..publishing import api as publishing_api
+from ..publishing.models import PublishableEntity, PublishableEntityVersion
+from ..publishing.models.learning_package import LearningPackage
 
 
 def toml_learning_package(

openedx_learning/apps/{authoring → openedx_content/applets}/backup_restore/zipper.py

@@ -28,7 +28,15 @@ from openedx_learning.api.authoring_models import (
     PublishableEntity,
     PublishableEntityVersion,
 )
-from openedx_learning.apps.authoring.backup_restore.serializers import (
+
+from ..collections import api as collections_api
+from ..components import api as components_api
+from ..contents import api as contents_api
+from ..publishing import api as publishing_api
+from ..sections import api as sections_api
+from ..subsections import api as subsections_api
+from ..units import api as units_api
+from .serializers import (
     CollectionSerializer,
     ComponentSerializer,
     ComponentVersionSerializer,
@@ -37,7 +45,7 @@ from openedx_learning.apps.authoring.backup_restore.serializers import (
     LearningPackageMetadataSerializer,
     LearningPackageSerializer,
 )
-from openedx_learning.apps.authoring.backup_restore.toml import (
+from .toml import (
     parse_collection_toml,
     parse_learning_package_toml,
     parse_publishable_entity_toml,
@@ -45,13 +53,6 @@ from openedx_learning.apps.authoring.backup_restore.toml import (
     toml_learning_package,
     toml_publishable_entity,
 )
-from openedx_learning.apps.authoring.collections import api as collections_api
-from openedx_learning.apps.authoring.components import api as components_api
-from openedx_learning.apps.authoring.contents import api as contents_api
-from openedx_learning.apps.authoring.publishing import api as publishing_api
-from openedx_learning.apps.authoring.sections import api as sections_api
-from openedx_learning.apps.authoring.subsections import api as subsections_api
-from openedx_learning.apps.authoring.units import api as units_api
 
 TOML_PACKAGE_NAME = "package.toml"
 DEFAULT_USERNAME = "command"

openedx_learning/apps/{authoring → openedx_content/applets}/collections/api.py

@@ -12,7 +12,7 @@ from ..publishing import api as publishing_api
 from ..publishing.models import PublishableEntity
 from .models import Collection, CollectionPublishableEntity
 
-# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# The public API that will be re-exported by openedx_learning.apps.openedx_content.api
 # is listed in the __all__ entries below. Internal helper functions that are
 # private to this module should start with an underscore. If a function does not
 # start with an underscore AND it is not in __all__, that function is considered

openedx_learning/apps/{authoring → openedx_content/applets}/collections/models.py

@@ -180,7 +180,10 @@ class Collection(models.Model):
             ),
         ]
         indexes = [
-            models.Index(fields=["learning_package", "title"]),
+            models.Index(
+                fields=["learning_package", "title"],
+                name="openedx_content_coll_lp_title",
+            ),
         ]
 
     def __repr__(self) -> str:

openedx_learning/apps/{authoring → openedx_content/applets}/components/admin.py

@@ -27,7 +27,7 @@ class ComponentVersionInline(admin.TabularInline):
     def format_uuid(self, cv_obj):
         return format_html(
             '<a href="{}">{}</a>',
-            reverse("admin:oel_components_componentversion_change", args=(cv_obj.pk,)),
+            reverse("admin:openedx_content_componentversion_change", args=(cv_obj.pk,)),
             cv_obj.uuid,
         )
 

openedx_learning/apps/{authoring → openedx_content/applets}/components/api.py

@@ -27,7 +27,7 @@ from ..contents import api as contents_api
 from ..publishing import api as publishing_api
 from .models import Component, ComponentType, ComponentVersion, ComponentVersionContent
 
-# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# The public API that will be re-exported by openedx_learning.apps.openedx_content.api
 # is listed in the __all__ entries below. Internal helper functions that are
 # private to this module should start with an underscore. If a function does not
 # start with an underscore AND it is not in __all__, that function is considered

openedx_learning/apps/{authoring → openedx_content/applets}/components/models.py

@@ -21,8 +21,9 @@ from typing import ClassVar
 
 from django.db import models
 
-from ....lib.fields import case_sensitive_char_field, key_field
-from ....lib.managers import WithRelationsManager
+from openedx_learning.lib.fields import case_sensitive_char_field, key_field
+from openedx_learning.lib.managers import WithRelationsManager
+
 from ..contents.models import Content
 from ..publishing.models import LearningPackage, PublishableEntityMixin, PublishableEntityVersionMixin
 
@@ -63,6 +64,7 @@ class ComponentType(models.Model):
     # the UsageKey.
     name = case_sensitive_char_field(max_length=100, blank=True)
 
+    # TODO: this needs to go into a class Meta
     constraints = [
         models.UniqueConstraint(
             fields=[

openedx_learning/apps/{authoring → openedx_content/applets}/contents/api.py

@@ -12,10 +12,11 @@ from logging import getLogger
 from django.core.files.base import ContentFile
 from django.db.transaction import atomic
 
-from ....lib.fields import create_hash_digest
+from openedx_learning.lib.fields import create_hash_digest
+
 from .models import Content, MediaType
 
-# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# The public API that will be re-exported by openedx_learning.apps.openedx_content.api
 # is listed in the __all__ entries below. Internal helper functions that are
 # private to this module should start with an underscore. If a function does not
 # start with an underscore AND it is not in __all__, that function is considered

openedx_learning/apps/{authoring → openedx_content/applets}/contents/models.py

@@ -16,8 +16,14 @@ from django.core.validators import MaxValueValidator
 from django.db import models
 from django.utils.module_loading import import_string
 
-from ....lib.fields import MultiCollationTextField, case_insensitive_char_field, hash_field, manual_date_time_field
-from ....lib.managers import WithRelationsManager
+from openedx_learning.lib.fields import (
+    MultiCollationTextField,
+    case_insensitive_char_field,
+    hash_field,
+    manual_date_time_field,
+)
+from openedx_learning.lib.managers import WithRelationsManager
+
 from ..publishing.models import LearningPackage
 
 logger = getLogger()

openedx_learning/apps/{authoring → openedx_content/applets}/publishing/api.py

@@ -47,7 +47,7 @@ from .models.publish_log import Published
 ContainerModel = TypeVar('ContainerModel', bound=Container)
 ContainerVersionModel = TypeVar('ContainerVersionModel', bound=ContainerVersion)
 
-# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# The public API that will be re-exported by openedx_learning.apps.openedx_content.api
 # is listed in the __all__ entries below. Internal helper functions that are
 # private to this module should start with an underscore. If a function does not
 # start with an underscore AND it is not in __all__, that function is considered

openedx_learning/apps/{authoring → openedx_content/applets}/publishing/models/entity_list.py

@@ -18,6 +18,7 @@ class EntityList(models.Model):
     anonymous in a sense–they're pointed to by ContainerVersions and
     other models, rather than being looked up by their own identifiers.
     """
+
     @cached_property
     def rows(self):
         """

openedx_learning/apps/{authoring → openedx_content/applets}/sections/api.py

@@ -7,9 +7,8 @@ from datetime import datetime
 
 from django.db.transaction import atomic
 
-from openedx_learning.apps.authoring.subsections.models import Subsection, SubsectionVersion
-
 from ..publishing import api as publishing_api
+from ..subsections.models import Subsection, SubsectionVersion
 from .models import Section, SectionVersion
 
 # 🛑 UNSTABLE: All APIs related to containers are unstable until we've figured

openedx_learning/apps/{authoring → openedx_content/applets}/subsections/api.py

@@ -7,9 +7,8 @@ from datetime import datetime
 
 from django.db.transaction import atomic
 
-from openedx_learning.apps.authoring.units.models import Unit, UnitVersion
-
 from ..publishing import api as publishing_api
+from ..units.models import Unit, UnitVersion
 from .models import Subsection, SubsectionVersion
 
 # 🛑 UNSTABLE: All APIs related to containers are unstable until we've figured

openedx_learning/apps/{authoring → openedx_content/applets}/units/api.py

@@ -7,8 +7,7 @@ from datetime import datetime
 
 from django.db.transaction import atomic
 
-from openedx_learning.apps.authoring.components.models import Component, ComponentVersion
-
+from ..components.models import Component, ComponentVersion
 from ..publishing import api as publishing_api
 from .models import Unit, UnitVersion
 

openedx_learning/apps/openedx_content/apps.py

@@ -0,0 +1,52 @@
+"""
+App Config for our umbrella openedx_content app.
+"""
+from django.apps import AppConfig
+
+# pylint: disable=import-outside-toplevel
+#
+# Local imports in AppConfig.ready() are common and expected in Django, since
+# Django needs to run initialization before before we can query for things like
+# models, settings, and app config.
+
+
+class ContentConfig(AppConfig):
+    """
+    Initialization for all applets must happen in here.
+    """
+
+    name = "openedx_learning.apps.openedx_content"
+    verbose_name = "Learning Core > Content"
+    default_auto_field = "django.db.models.BigAutoField"
+    label = "openedx_content"
+
+    def register_publishable_models(self):
+        """
+        Register all Publishable -> Version model pairings in our app.
+        """
+        from .api import register_publishable_models
+        from .models import (
+            Component,
+            ComponentVersion,
+            Container,
+            ContainerVersion,
+            Section,
+            SectionVersion,
+            Subsection,
+            SubsectionVersion,
+            Unit,
+            UnitVersion,
+        )
+        register_publishable_models(Component, ComponentVersion)
+        register_publishable_models(Container, ContainerVersion)
+        register_publishable_models(Section, SectionVersion)
+        register_publishable_models(Subsection, SubsectionVersion)
+        register_publishable_models(Unit, UnitVersion)
+
+    def ready(self):
+        """
+        Currently used to register publishable models.
+
+        May later be used to register signal handlers as well.
+        """
+        self.register_publishable_models()

openedx_learning/apps/{authoring → openedx_content/backcompat}/backup_restore/apps.py

@@ -6,7 +6,7 @@ from django.apps import AppConfig
 
 
 class BackupRestoreConfig(AppConfig):
-    name = 'openedx_learning.apps.authoring.backup_restore'
+    name = 'openedx_learning.apps.openedx_content.backcompat.backup_restore'
     verbose_name = "Learning Core > Authoring > Backup Restore"
     default_auto_field = 'django.db.models.BigAutoField'
     label = "oel_backup_restore"

openedx_learning/apps/{authoring → openedx_content/backcompat}/collections/apps.py

@@ -9,7 +9,7 @@ class CollectionsConfig(AppConfig):
     Configuration for the Collections Django application.
     """
 
-    name = "openedx_learning.apps.authoring.collections"
+    name = "openedx_learning.apps.openedx_content.backcompat.collections"
     verbose_name = "Learning Core > Authoring > Collections"
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_collections"

openedx_learning/apps/openedx_content/backcompat/collections/migrations/0006_remove_all_field_state_for_move_to_applet.py

@@ -0,0 +1,82 @@
+# Generated by Django 5.2.10 on 2026-01-30 00:36
+
+from django.db import migrations
+from django.db.migrations.operations.special import SeparateDatabaseAndState
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_collections', '0005_alter_collection_options_alter_collection_enabled'),
+    ]
+
+    operations = [
+        SeparateDatabaseAndState(
+            database_operations=[],
+            state_operations=[
+                migrations.RemoveField(
+                    model_name='collectionpublishableentity',
+                    name='collection',
+                ),
+                migrations.RemoveField(
+                    model_name='collectionpublishableentity',
+                    name='created_by',
+                ),
+                migrations.RemoveField(
+                    model_name='collectionpublishableentity',
+                    name='entity',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='entities',
+                ),
+                migrations.AlterModelOptions(
+                    name='collection',
+                    options={},
+                ),
+                migrations.RemoveConstraint(
+                    model_name='collection',
+                    name='oel_coll_uniq_lp_key',
+                ),
+                migrations.RemoveIndex(
+                    model_name='collection',
+                    name='oel_collect_learnin_dfaf89_idx',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='created',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='created_by',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='description',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='enabled',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='key',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='learning_package',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='modified',
+                ),
+                migrations.RemoveField(
+                    model_name='collection',
+                    name='title',
+                ),
+                migrations.DeleteModel(
+                    name='CollectionPublishableEntity',
+                ),
+            ]
+        ),
+    ]

openedx_learning/apps/openedx_content/backcompat/collections/models.py

@@ -0,0 +1,9 @@
+"""
+These are stub models necessary to ensure a smooth migration for
+openedx-platform apps that were built to have foreign keys to these models.
+"""
+from django.db import models
+
+
+class Collection(models.Model):
+    id = models.AutoField(primary_key=True)

openedx_learning/apps/openedx_content/backcompat/components/apps.py

@@ -0,0 +1,15 @@
+"""
+Django metadata for the Components Django application.
+"""
+from django.apps import AppConfig
+
+
+class ComponentsConfig(AppConfig):
+    """
+    Configuration for the Components Django application.
+    """
+
+    name = "openedx_learning.apps.openedx_content.backcompat.components"
+    verbose_name = "Learning Core > Authoring > Components"
+    default_auto_field = "django.db.models.BigAutoField"
+    label = "oel_components"

openedx_learning/apps/openedx_content/backcompat/components/migrations/0005_remove_all_field_state_for_move_to_applet.py

@@ -0,0 +1,72 @@
+# Generated by Django 5.2.10 on 2026-01-30 00:36
+
+from django.db import migrations
+from django.db.migrations.operations.special import SeparateDatabaseAndState
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_components', '0004_remove_componentversioncontent_uuid'),
+    ]
+
+    operations = [
+        SeparateDatabaseAndState(
+            database_operations=[],
+            state_operations=[
+                migrations.RemoveField(
+                    model_name='component',
+                    name='component_type',
+                ),
+                migrations.RemoveField(
+                    model_name='componentversion',
+                    name='component',
+                ),
+                migrations.RemoveField(
+                    model_name='componentversion',
+                    name='contents',
+                ),
+                migrations.RemoveField(
+                    model_name='componentversion',
+                    name='publishable_entity_version',
+                ),
+                migrations.RemoveField(
+                    model_name='componentversioncontent',
+                    name='component_version',
+                ),
+                migrations.RemoveField(
+                    model_name='componentversioncontent',
+                    name='content',
+                ),
+                migrations.AlterModelOptions(
+                    name='component',
+                    options={},
+                ),
+                migrations.RemoveConstraint(
+                    model_name='component',
+                    name='oel_component_uniq_lc_ct_lk',
+                ),
+                migrations.RemoveIndex(
+                    model_name='component',
+                    name='oel_component_idx_ct_lk',
+                ),
+                migrations.RemoveField(
+                    model_name='component',
+                    name='learning_package',
+                ),
+                migrations.RemoveField(
+                    model_name='component',
+                    name='local_key',
+                ),
+                migrations.DeleteModel(
+                    name='ComponentType',
+                ),
+                migrations.DeleteModel(
+                    name='ComponentVersion',
+                ),
+                migrations.DeleteModel(
+                    name='ComponentVersionContent',
+                ),
+            ]
+        ),
+    ]

openedx_learning/apps/openedx_content/backcompat/components/models.py

@@ -0,0 +1,11 @@
+"""
+These are stub models necessary to ensure a smooth migration for
+openedx-platform apps that were built to have foreign keys to these models.
+"""
+from django.db import models
+
+
+class Component(models.Model):
+    publishable_entity = models.OneToOneField(
+        'oel_publishing.PublishableEntity', on_delete=models.CASCADE, primary_key=True
+    )

openedx_learning/apps/{authoring → openedx_content/backcompat}/contents/apps.py

@@ -9,7 +9,7 @@ class ContentsConfig(AppConfig):
     Configuration for the Contents Django application.
     """
 
-    name = "openedx_learning.apps.authoring.contents"
+    name = "openedx_learning.apps.openedx_content.backcompat.contents"
     verbose_name = "Learning Core > Authoring > Contents"
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_contents"

openedx_learning/apps/openedx_content/backcompat/contents/migrations/0002_remove_all_field_state_for_move_to_applet.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.2.10 on 2026-01-30 00:36
+
+from django.db import migrations
+from django.db.migrations.operations.special import SeparateDatabaseAndState
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_components', '0005_remove_all_field_state_for_move_to_applet'),
+        ('oel_contents', '0001_initial'),
+    ]
+
+    operations = [
+        SeparateDatabaseAndState(
+            database_operations=[],
+            state_operations=[
+                migrations.DeleteModel(
+                    name='Content',
+                ),
+                migrations.DeleteModel(
+                    name='MediaType',
+                ),
+            ]
+        ),
+    ]