openedx-learning 0.19.0__py2.py3-none-any.whl → 0.19.1__py2.py3-none-any.whl

openedx_learning/__init__.py

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

openedx_learning/apps/authoring/components/api.py

@@ -83,6 +83,8 @@ def create_component(
     local_key: str,
     created: datetime,
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> Component:
     """
     Create a new Component (an entity like a Problem or Video)
@@ -90,7 +92,11 @@ def create_component(
     key = f"{component_type.namespace}:{component_type.name}:{local_key}"
     with atomic():
         publishable_entity = publishing_api.create_publishable_entity(
-            learning_package_id, key, created, created_by
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone
         )
         component = Component.objects.create(
             publishable_entity=publishable_entity,
@@ -239,13 +245,20 @@ def create_component_and_version(  # pylint: disable=too-many-positional-argumen
     title: str,
     created: datetime,
     created_by: int | None = None,
+    *,
+    can_stand_alone: bool = True,
 ) -> tuple[Component, ComponentVersion]:
     """
     Create a Component and associated ComponentVersion atomically
     """
     with atomic():
         component = create_component(
-            learning_package_id, component_type, local_key, created, created_by
+            learning_package_id,
+            component_type,
+            local_key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
         )
         component_version = create_component_version(
             component.pk,

openedx_learning/apps/authoring/publishing/admin.py

@@ -85,6 +85,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "learning_package",
         "created",
         "created_by",
+        "can_stand_alone",
     ]
     list_filter = ["learning_package"]
     search_fields = ["key", "uuid"]
@@ -98,6 +99,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "created",
         "created_by",
         "see_also",
+        "can_stand_alone",
     ]
     readonly_fields = [
         "key",
@@ -108,6 +110,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "created",
         "created_by",
         "see_also",
+        "can_stand_alone",
     ]
 
     def get_queryset(self, request):

openedx_learning/apps/authoring/publishing/api.py

@@ -71,6 +71,8 @@ __all__ = [
     "create_container_version",
     "create_next_container_version",
     "get_container",
+    "get_container_by_key",
+    "get_containers",
     "ContainerEntityListEntry",
     "get_entities_in_container",
     "contains_unpublished_changes",
@@ -173,6 +175,8 @@ def create_publishable_entity(
     created: datetime,
     # User ID who created this
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> PublishableEntity:
     """
     Create a PublishableEntity.
@@ -185,6 +189,7 @@ def create_publishable_entity(
         key=key,
         created=created,
         created_by_id=created_by,
+        can_stand_alone=can_stand_alone,
     )
 
 
@@ -583,6 +588,8 @@ def create_container(
     key: str,
     created: datetime,
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
     # The types on the following line are correct, but mypy will complain - https://github.com/python/mypy/issues/3737
     container_cls: type[ContainerModel] = Container,  # type: ignore[assignment]
 ) -> ContainerModel:
@@ -595,6 +602,7 @@ def create_container(
         key: The key of the container.
         created: The date and time the container was created.
         created_by: The ID of the user who created the container
+        can_stand_alone: Set to False when created as part of containers
         container_cls: The subclass of Container to use, if applicable
 
     Returns:
@@ -603,7 +611,11 @@ def create_container(
     assert issubclass(container_cls, Container)
     with atomic():
         publishable_entity = create_publishable_entity(
-            learning_package_id, key, created, created_by
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
         )
         container = container_cls.objects.create(
             publishable_entity=publishable_entity,
@@ -837,6 +849,43 @@ def get_container(pk: int) -> Container:
     return Container.objects.get(pk=pk)
 
 
+def get_container_by_key(learning_package_id: int, /, key: str) -> Container:
+    """
+    [ 🛑 UNSTABLE ]
+    Get a container by its learning package and primary key.
+
+    Args:
+        learning_package_id: The ID of the learning package that contains the container.
+        key: The primary key of the container.
+
+    Returns:
+        The container with the given primary key.
+    """
+    return Container.objects.get(
+        publishable_entity__learning_package_id=learning_package_id,
+        publishable_entity__key=key,
+    )
+
+
+def get_containers(
+    learning_package_id: int,
+    container_cls: type[ContainerModel] = Container,  # type: ignore[assignment]
+) -> QuerySet[ContainerModel]:
+    """
+    [ 🛑 UNSTABLE ]
+    Get all containers in the given learning package.
+
+    Args:
+        learning_package_id: The primary key of the learning package
+        container_cls: The subclass of Container to use, if applicable
+
+    Returns:
+        A queryset containing the container associated with the given learning package.
+    """
+    assert issubclass(container_cls, Container)
+    return container_cls.objects.filter(publishable_entity__learning_package=learning_package_id)
+
+
 @dataclass(frozen=True)
 class ContainerEntityListEntry:
     """

openedx_learning/apps/authoring/publishing/migrations/0004_publishableentity_can_stand_alone.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.19 on 2025-03-17 11:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_publishing', '0003_containers'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='publishableentity',
+            name='can_stand_alone',
+            field=models.BooleanField(
+                default=True,
+                help_text="Set to True when created independently, False when created as part of a container.",
+            ),
+        ),
+    ]

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

@@ -9,6 +9,7 @@ from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.core.validators import MinValueValidator
 from django.db import models
+from django.utils.translation import gettext as _
 
 from openedx_learning.lib.fields import (
     case_insensitive_char_field,
@@ -126,6 +127,10 @@ class PublishableEntity(models.Model):
         null=True,
         blank=True,
     )
+    can_stand_alone = models.BooleanField(
+        default=True,
+        help_text=_("Set to True when created independently, False when created as part of a container."),
+    )
 
     class Meta:
         constraints = [

openedx_learning/apps/authoring/units/api.py

@@ -30,7 +30,12 @@ __all__ = [
 
 
 def create_unit(
-    learning_package_id: int, key: str, created: datetime, created_by: int | None
+    learning_package_id: int,
+    key: str,
+    created: datetime,
+    created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> Unit:
     """
     [ 🛑 UNSTABLE ] Create a new unit.
@@ -40,12 +45,14 @@ def create_unit(
         key: The key.
         created: The creation date.
         created_by: The user who created the unit.
+        can_stand_alone: Set to False when created as part of containers
     """
     return publishing_api.create_container(
         learning_package_id,
         key,
         created,
         created_by,
+        can_stand_alone=can_stand_alone,
         container_cls=Unit,
     )
 
@@ -156,6 +163,7 @@ def create_unit_and_version(
     components: list[Component | ComponentVersion] | None = None,
     created: datetime,
     created_by: int | None = None,
+    can_stand_alone: bool = True,
 ) -> tuple[Unit, UnitVersion]:
     """
     [ 🛑 UNSTABLE ] Create a new unit and its version.
@@ -165,10 +173,17 @@ def create_unit_and_version(
         key: The key.
         created: The creation date.
         created_by: The user who created the unit.
+        can_stand_alone: Set to False when created as part of containers
     """
     publishable_entities_pks, entity_version_pks = _pub_entities_for_components(components)
     with atomic():
-        unit = create_unit(learning_package_id, key, created, created_by)
+        unit = create_unit(
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
+        )
         unit_version = create_unit_version(
             unit,
             1,

{openedx_learning-0.19.0.dist-info → openedx_learning-0.19.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: openedx-learning
-Version: 0.19.0
+Version: 0.19.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,11 +18,11 @@ 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: Django<5.0
 Requires-Dist: rules<4.0
-Requires-Dist: edx-drf-extensions
 Requires-Dist: celery
+Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
 Dynamic: author
 Dynamic: author-email

{openedx_learning-0.19.0.dist-info → openedx_learning-0.19.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-openedx_learning/__init__.py,sha256=de9JrtQMO5tVm1WwyxT5eY8XnVN7AdgqRkaQee-ZUGk,69
+openedx_learning/__init__.py,sha256=px6MoC3pWrrXjiOIJXCYYjh1zVYJmN1_36ERKhfnEOQ,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=AuEegFTT3tAer_3zSxcxqLq3Yd_eilk-Hxt4ESYearA,970
@@ -18,7 +18,7 @@ openedx_learning/apps/authoring/collections/migrations/0005_alter_collection_opt
 openedx_learning/apps/authoring/collections/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/components/admin.py,sha256=zfEpuBEySMYpUZzygaE2MDoI8SH-2H3xIL20YCSCMLo,4582
-openedx_learning/apps/authoring/components/api.py,sha256=ygSb5G8RzsIQzXqyJiqNwuGJp9r388ayuW3UuJNYHh8,24997
+openedx_learning/apps/authoring/components/api.py,sha256=PmCtJiyw0Vy4PGSRt9JCStJQv9OJ4FchtOyiY1sfJ-s,25254
 openedx_learning/apps/authoring/components/apps.py,sha256=Rcydv_FH-rVvuWIFqUezBNOh8DtrZHyozZM2yqX2JKE,778
 openedx_learning/apps/authoring/components/models.py,sha256=ttZzVnMZTa14-qudrLb4CFuCanEQJT8cuC_iVPH8XTA,10887
 openedx_learning/apps/authoring/components/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -36,12 +36,13 @@ 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=F-0QlVQmuovLIF258XK_vKJdOnn7lLa_0A5veE72TKc,4830
-openedx_learning/apps/authoring/publishing/api.py,sha256=JAm3a3ItiQYe9agqGHHNoTZ6LYhhMzw3JIZ-BVH9BMM,35911
+openedx_learning/apps/authoring/publishing/admin.py,sha256=yPtqznDzlWHj0xpJ_FGFRviyftgPmuql5EoqKLeZQFo,4911
+openedx_learning/apps/authoring/publishing/api.py,sha256=OregsRNQev41Nm1Uq6B_zoezJgV-EVsYaf8_iJ3sbxI,37430
 openedx_learning/apps/authoring/publishing/apps.py,sha256=v9PTe3YoICaYT9wfu268ZkVAlnZFvxi-DqYdbRi25bY,750
 openedx_learning/apps/authoring/publishing/migrations/0001_initial.py,sha256=wvekNV19YRSdxRmQaFnLSn_nCsQlHIucPDVMmgKf_OE,9272
 openedx_learning/apps/authoring/publishing/migrations/0002_alter_learningpackage_key_and_more.py,sha256=toI7qJhNukk6hirKfFx9EpqTpzF2O2Yq1VpFJusDn2M,806
 openedx_learning/apps/authoring/publishing/migrations/0003_containers.py,sha256=k5P1LFkjQT-42yyHE2f57dAMQKafLuJCTRaCBMKWcjc,2519
+openedx_learning/apps/authoring/publishing/migrations/0004_publishableentity_can_stand_alone.py,sha256=RapDZKcjTp5QGgob9DUaf-zl_pQgg-5nz8PZWoXMlVA,549
 openedx_learning/apps/authoring/publishing/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/publishing/models/__init__.py,sha256=Ou6Ks3qxEhel9uHLpzi77jlkb_IHc9_WIfqxOZJuqaE,1059
 openedx_learning/apps/authoring/publishing/models/container.py,sha256=GCUD3WTlgvgZSQOKcoOsfhNAfc5pz3Wbs9ClE9mhtB0,2594
@@ -49,9 +50,9 @@ openedx_learning/apps/authoring/publishing/models/draft_published.py,sha256=dDZf
 openedx_learning/apps/authoring/publishing/models/entity_list.py,sha256=EWpkUHUqJr5xKGJCRQ494xugdULxMXxYviFOot9ypUU,3009
 openedx_learning/apps/authoring/publishing/models/learning_package.py,sha256=1fuNLHD6k0qGuL0jXYGf4-TA5WczgxJrXUdAIM_JNBI,2688
 openedx_learning/apps/authoring/publishing/models/publish_log.py,sha256=-uMj1X8umqRM259ucOqNt6POeKDpY5RLdA8XnWXt7Go,4109
-openedx_learning/apps/authoring/publishing/models/publishable_entity.py,sha256=tErsaWW_Bh2B4ce_6kdx6mKmGDDFaLKW6W6Ambl0BFk,25191
+openedx_learning/apps/authoring/publishing/models/publishable_entity.py,sha256=-6Fde_sYqaq1AUC4sw4Rf1X9Hh4jun2Py7Xhsl4VWuY,25419
 openedx_learning/apps/authoring/units/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/units/api.py,sha256=1sFdNchAZ1aNLEN5imxJWo5D000ACjyoZNfrMzrlilM,9578
+openedx_learning/apps/authoring/units/api.py,sha256=WjeM9E_5yH-zawlCzBY0BwCywRVeNxoojq4IDN9gOds,9957
 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
@@ -124,8 +125,8 @@ 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.19.0.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
-openedx_learning-0.19.0.dist-info/METADATA,sha256=xvtsGiNCb627JQXOZqEi7Ws6bPM6TwMlBxKfkBn7zz0,8975
-openedx_learning-0.19.0.dist-info/WHEEL,sha256=SrDKpSbFN1G94qcmBqS9nyHcDMp9cUS9OC06hC0G3G0,109
-openedx_learning-0.19.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.19.0.dist-info/RECORD,,
+openedx_learning-0.19.1.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.19.1.dist-info/METADATA,sha256=Jm1GoiVhtSJfYV6nlRXB7H5XPy8XVvGTivFNF7j0f0w,8975
+openedx_learning-0.19.1.dist-info/WHEEL,sha256=SrDKpSbFN1G94qcmBqS9nyHcDMp9cUS9OC06hC0G3G0,109
+openedx_learning-0.19.1.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.19.1.dist-info/RECORD,,