openedx-learning 0.12.0__py2.py3-none-any.whl → 0.13.1__py2.py3-none-any.whl

openedx_learning/__init__.py

@@ -1,4 +1,4 @@
 """
 Open edX Learning ("Learning Core").
 """
-__version__ = "0.12.0"
+__version__ = "0.13.1"

openedx_learning/apps/authoring/collections/admin.py

@@ -0,0 +1,42 @@
+"""
+Django Admin pages for Collection models.
+"""
+from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
+
+from .models import Collection
+
+
+class CollectionAdmin(admin.ModelAdmin):
+    """
+    The Collection model admin.
+
+    Allows users to easily disable/enable (aka soft delete and restore) or bulk delete Collections.
+    """
+    readonly_fields = ["key", "learning_package"]
+    list_filter = ["enabled"]
+    list_display = ["key", "title", "enabled", "modified"]
+    fieldsets = [
+        (
+            "",
+            {
+                "fields": ["key", "learning_package"],
+            }
+        ),
+        (
+            _("Edit only in Studio"),
+            {
+                "fields": ["title", "enabled", "description", "created_by"],
+                "description": _("⚠  Changes made here should be done in Studio Django Admin, not the LMS."),
+            }
+        ),
+    ]
+
+    def has_add_permission(self, request, *args, **kwargs):
+        """
+        Disallow adding new collections via Django Admin.
+        """
+        return False  # pragma: no cover
+
+
+admin.site.register(Collection, CollectionAdmin)

openedx_learning/apps/authoring/collections/api.py

@@ -20,10 +20,12 @@ from .models import Collection
 __all__ = [
     "add_to_collection",
     "create_collection",
+    "delete_collection",
     "get_collection",
     "get_collections",
     "get_entity_collections",
     "remove_from_collection",
+    "restore_collection",
     "update_collection",
 ]
 
@@ -84,6 +86,42 @@ def update_collection(
     return collection
 
 
+def delete_collection(
+    learning_package_id: int,
+    key: str,
+    *,
+    hard_delete=False,
+) -> Collection:
+    """
+    Disables or deletes a collection identified by the given learning_package + key.
+
+    By default (hard_delete=False), the collection is "soft deleted", i.e disabled.
+    Soft-deleted collections can be re-enabled using restore_collection.
+    """
+    collection = get_collection(learning_package_id, key)
+
+    if hard_delete:
+        collection.delete()
+    else:
+        collection.enabled = False
+        collection.save()
+    return collection
+
+
+def restore_collection(
+    learning_package_id: int,
+    key: str,
+) -> Collection:
+    """
+    Undo a "soft delete" by re-enabling a Collection.
+    """
+    collection = get_collection(learning_package_id, key)
+
+    collection.enabled = True
+    collection.save()
+    return collection
+
+
 def add_to_collection(
     learning_package_id: int,
     key: str,

openedx_learning/apps/authoring/collections/migrations/0005_alter_collection_options_alter_collection_enabled.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.15 on 2024-09-24 07:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_collections', '0004_collection_key'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='collection',
+            name='enabled',
+            field=models.BooleanField(default=True, help_text='Disabled collections are "soft deleted", and should be re-enabled before use, or be deleted.'),
+        ),
+    ]

openedx_learning/apps/authoring/collections/models.py

@@ -133,12 +133,10 @@ class Collection(models.Model):
         }
     )
 
-    # We don't have api functions to handle the enabled field. This is a placeholder for future use and
-    # a way to "soft delete" collections.
     enabled = models.BooleanField(
         default=True,
         help_text=_(
-            "Whether the collection is enabled or not."
+            'Disabled collections are "soft deleted", and should be re-enabled before use, or be deleted.',
         ),
     )
 

openedx_learning/apps/authoring/components/api.py

@@ -42,6 +42,7 @@ __all__ = [
     "get_component_by_uuid",
     "get_component_version_by_uuid",
     "component_exists_by_key",
+    "get_collection_components",
     "get_components",
     "create_component_version_content",
     "look_up_component_version_content",
@@ -339,6 +340,21 @@ def get_components(
     return qset
 
 
+def get_collection_components(
+    learning_package_id: int,
+    collection_key: str,
+) -> QuerySet[Component]:
+    """
+    Returns a QuerySet of Components relating to the PublishableEntities in a Collection.
+
+    Components have a one-to-one relationship with PublishableEntity, but the reverse may not always be true.
+    """
+    return Component.objects.filter(
+        learning_package_id=learning_package_id,
+        publishable_entity__collections__key=collection_key,
+    ).order_by('pk')
+
+
 def look_up_component_version_content(
     learning_package_key: str,
     component_key: str,

{openedx_learning-0.12.0.dist-info → openedx_learning-0.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.12.0
+Version: 0.13.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: celery
+Requires-Dist: attrs
 Requires-Dist: Django<5.0
 Requires-Dist: djangorestframework<4.0
-Requires-Dist: rules<4.0
 Requires-Dist: edx-drf-extensions
-Requires-Dist: attrs
+Requires-Dist: celery
+Requires-Dist: rules<4.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.12.0.dist-info → openedx_learning-0.13.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-openedx_learning/__init__.py,sha256=A3F2eIt1aRYsY0WQV1upYl-XM-eKJqIdLO55kEcvNuc,68
+openedx_learning/__init__.py,sha256=ktqHmS9Hb8-3sCQfbMV2mr3Bd1bnH7z_ed1NYYChMB4,68
 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=vbRpiQ2wOfN3oR2bbN0-bI2ra0QRtha9tVixKW1ENis,929
@@ -6,17 +6,19 @@ openedx_learning/api/authoring_models.py,sha256=PrhEYozI7nzC7N1v_sP1QgjwjRvLX6it
 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/collections/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/collections/api.py,sha256=8jNn_S43JqWIGWyDvR7McxGJ-3TboibdHF3LWyQMFWE,4978
+openedx_learning/apps/authoring/collections/admin.py,sha256=f0hySjDMfIphVDEGkCSMIUHoEiqHRA7EE2NiO7lvL4g,1156
+openedx_learning/apps/authoring/collections/api.py,sha256=Lui-9mvlUjXSfCcaHrYJc2y2aJ1obJPCIp5hvxYwnkI,5894
 openedx_learning/apps/authoring/collections/apps.py,sha256=67imy9vnyXml4cfLNGFJhuZr2yx1q92-xz4ih3yJgNU,416
-openedx_learning/apps/authoring/collections/models.py,sha256=YAwDf8igFbs8Fox3QpbkzBOvYL39cBsRdelxlXx6IYs,8545
+openedx_learning/apps/authoring/collections/models.py,sha256=os8EKUVZ2IhMfFo2XN9tklByCUXphEtzAkKAOc0KyW8,8451
 openedx_learning/apps/authoring/collections/migrations/0001_initial.py,sha256=xcJoqMLROW9FTILYrz6UsyotVu9wBN5tRBwRoAWG6dg,1496
 openedx_learning/apps/authoring/collections/migrations/0002_remove_collection_name_collection_created_by_and_more.py,sha256=NRl-_-EkE-w4JLeJsZf6lHxYNV3TIAJVIWbv_-xytGo,2162
 openedx_learning/apps/authoring/collections/migrations/0003_collection_entities.py,sha256=-YddfCFS0HW3JsEcpatjakOyeGVklOmba9uRQ-0zIxQ,1805
 openedx_learning/apps/authoring/collections/migrations/0004_collection_key.py,sha256=G1STMrsCjU8Ykp0Zm_nIf5YqZCBy1TRTVX7q7zrly8c,2021
+openedx_learning/apps/authoring/collections/migrations/0005_alter_collection_options_alter_collection_enabled.py,sha256=HdU_3zxN32nzzvOFpiVpQXleHleJhnq2d8k7jAxhUTM,504
 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=QE7e76C6X2V1AQPxQe6SayQPfCMmbs4RZPEPIGcvTWw,4672
-openedx_learning/apps/authoring/components/api.py,sha256=FXYUUL6Q-MdsH78WKr9yRftJ9YcP5YfGDlJIIUT2zeA,21878
+openedx_learning/apps/authoring/components/api.py,sha256=uIgJYLV6jfazt8rZgtKwhTKpgHhFurLwAfHL1cUMH9I,22410
 openedx_learning/apps/authoring/components/apps.py,sha256=YoYPsI9gcleA3uEs8CiLIrjUncRMo2DKbYt4mDfzePg,770
 openedx_learning/apps/authoring/components/models.py,sha256=T-wc7vxaWMlulQmMsVH7m6Pd857P3Eguo0vtflTLURI,13415
 openedx_learning/apps/authoring/components/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -108,8 +110,8 @@ openedx_tagging/core/tagging/rest_api/v1/serializers.py,sha256=gbvEBLvsmfPc3swWz
 openedx_tagging/core/tagging/rest_api/v1/urls.py,sha256=dNUKCtUCx_YzrwlbEbpDfjGVQbb2QdJ1VuJCkladj6E,752
 openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=ZRkSILdb8g5k_BcuuVVfdffEdY9vFQ_YtMa3JrN0Xz8,35581
 openedx_tagging/core/tagging/rest_api/v1/views_import.py,sha256=kbHUPe5A6WaaJ3J1lFIcYCt876ecLNQfd19m7YYub6c,1470
-openedx_learning-0.12.0.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
-openedx_learning-0.12.0.dist-info/METADATA,sha256=QwEYCY9OeCr03fC0GgdLy7eEpptZEaVFx1KcR8JoYeI,8777
-openedx_learning-0.12.0.dist-info/WHEEL,sha256=muXAwoPanksrVvf9Mcykr8l6Q0JyBrGUVYr50kE4bxo,109
-openedx_learning-0.12.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.12.0.dist-info/RECORD,,
+openedx_learning-0.13.1.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.13.1.dist-info/METADATA,sha256=ESWEGMxOJNF9R6AwR48b_BDHw5022_jCQ3803_b_Jws,8777
+openedx_learning-0.13.1.dist-info/WHEEL,sha256=muXAwoPanksrVvf9Mcykr8l6Q0JyBrGUVYr50kE4bxo,109
+openedx_learning-0.13.1.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.13.1.dist-info/RECORD,,