edx-enterprise-data 9.7.11__py3-none-any.whl → 9.9.1__py3-none-any.whl

{edx_enterprise_data-9.7.11.dist-info → edx_enterprise_data-9.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-data
-Version: 9.7.11
+Version: 9.9.1
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-9.7.11.dist-info → edx_enterprise_data-9.9.1.dist-info}/RECORD

@@ -1,14 +1,14 @@
-enterprise_data/__init__.py,sha256=ueETKv3rC8y23OfdEXsWBU9_G2MqZGuKLQQ905LzAZE,124
+enterprise_data/__init__.py,sha256=C2aHImiEECgYsjhXVl_9wAosZE3Qd9wtT1_s7eAwDU0,123
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
-enterprise_data/clients.py,sha256=GvQupy5TVYfO_IKC3yzXSAgNP54r-PtIjidM5ws9Iks,3947
+enterprise_data/clients.py,sha256=pBuCQOP7NYl264ZbMtZCRPCET1pg0by8w6PVlA-icKA,4995
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
 enterprise_data/filters.py,sha256=D2EiK12MMpBoz6eOUmTpoJEhj_sH7bA93NRRAdvkDVo,6163
-enterprise_data/models.py,sha256=INIETN4B6G1EtxVzgBQr6-JMy3ZsHj9K_FCyrS5OFAk,26312
+enterprise_data/models.py,sha256=gbZl-ei0qe_l-BFeE0gWeyfWqmgi9X9LAF8MYOEfk2s,26555
 enterprise_data/paginators.py,sha256=YPrC5TeXFt-ymenT2H8H2nCbDCnAzJQlH9kFPElRxWE,269
 enterprise_data/renderers.py,sha256=qggCLZklL9ohVcLHLO1pSecPJSDCCR7e_-PVobl9Lj8,3063
 enterprise_data/signals.py,sha256=8eqNPnlvmfsKf19lGWv5xTIuBgQIqR8EZSp9UYzC8Rc,1024
 enterprise_data/urls.py,sha256=bqtKF5OEWEwrNmHG3os-pZNuNsmjlhxEqp7yM4TbPf4,243
-enterprise_data/utils.py,sha256=sDrpBd62DpybCV41QCxRUaCuvch3qKjEhfUp9cA_GV0,2952
+enterprise_data/utils.py,sha256=djGuQUnvT8HJMMV60CzcD5BWerPIwiK9uG26bhkpWMg,3518
 enterprise_data/admin_analytics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/admin_analytics/constants.py,sha256=-6uLAq5DUeA_rv5eUb9SeqlG3iVWV30qUS8asbK4430,160
 enterprise_data/admin_analytics/data_loaders.py,sha256=b6RjEIxCol8ETQMY7QfwhqN9eEAvrUN_UldIG7rgsSY,736
@@ -30,7 +30,7 @@ enterprise_data/api/v0/serializers.py,sha256=dngZTk6DhRxApchQKCMp1B_c8aVnQtH0NCq
 enterprise_data/api/v0/urls.py,sha256=vzJjqIo_S3AXWs9Us8XTaJc3FnxLbYzAkmLyuDQqum0,699
 enterprise_data/api/v0/views.py,sha256=4RslZ4NZOU-844bnebEQ71ji2utRY7jEijqC45oQQD0,14380
 enterprise_data/api/v1/__init__.py,sha256=1aAzAYU5hk-RW6cKUxa1645cbZMxn7GIZ7OMjWc9MKI,46
-enterprise_data/api/v1/serializers.py,sha256=mya_ZvP7CTvUTF_ccYkMJZFuzOKIU-aM3eSCQmFazWY,11274
+enterprise_data/api/v1/serializers.py,sha256=DUhk8cP-JFQmbLR_JNGmmwis9Un5dyvd01kRdmxn8Lk,11866
 enterprise_data/api/v1/urls.py,sha256=Wl1xLboPg-Lq1ZvjAWf51JKYkHlmx02Kpq1nwfDyS8s,4372
 enterprise_data/api/v1/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/api/v1/views/analytics_completions.py,sha256=esFbJ5q8ssnm2Mfbc3rZXtiGHF-MeM4KQ4Ft3N7wwHU,6260
@@ -39,7 +39,7 @@ enterprise_data/api/v1/views/analytics_enrollments.py,sha256=hw87VZ0hFWpwf3QEHFn
 enterprise_data/api/v1/views/analytics_leaderboard.py,sha256=3dyo7_OhyGEEeibemBrRsUOo0jbM4LbDgV5gw3YnVig,4186
 enterprise_data/api/v1/views/base.py,sha256=Kkmd5zgEBAhvwS_GoGXSK6lgbDNwSPioYn-QbnizI3w,3416
 enterprise_data/api/v1/views/enterprise_admin.py,sha256=xxpb48cjuHkFJH-IQG0DwOvdH8RgyYD-aQjyfMMJNFg,9030
-enterprise_data/api/v1/views/enterprise_learner.py,sha256=lCB2guZeIDf-CbcdDzT2K5K-OW1Vt5i4R8K9aT1ZzuM,18627
+enterprise_data/api/v1/views/enterprise_learner.py,sha256=noFAKFe1T8CXRSFt8aMajF-utPO4x2WK-kxdIYw5qE4,20601
 enterprise_data/api/v1/views/enterprise_offers.py,sha256=VifxgqTLFLVw4extYPlHcN1N_yjXcsYsAlYEnAbpb10,1266
 enterprise_data/cache/__init__.py,sha256=fiBUploll1kmDy2vCmnNpeZVTD4ewsgtRF14vVs0Rb4,1850
 enterprise_data/cache/decorators.py,sha256=vLbXK9VSv-HzVkkXS1-TkuSMxudwyxz04WFsAXqmjuM,1273
@@ -106,6 +106,8 @@ enterprise_data/migrations/0040_auto_20240718_0536_squashed_0043_alter_enterpris
 enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py,sha256=1aJ0wIu9K2cT3AJdBIHuNCUpJysPWmq_37Ucp5ntEO8,6122
 enterprise_data/migrations/0045_alter_enterpriseexecedlcmoduleperformance_options_and_more.py,sha256=HJkY2OvuE39ciWgaEescd--ixQhTVrwzbL0_bvNofSo,876
 enterprise_data/migrations/0046_enterprisegroupmembership.py,sha256=38qfi3EySDLrpP3gDuO_oUl_7rphGPZIrPsCuBhQ_dk,1766
+enterprise_data/migrations/0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py,sha256=_lHmsJozjV_JEWyUfHDKleOhd53594fOaRhz7M0z-nY,897
+enterprise_data/migrations/0048_alter_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py,sha256=Hjgjj1LwNSCno45EHECCBy5jKKb51Me61xo8ukQLIEI,740
 enterprise_data/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_data/settings/test.py,sha256=4-flfrlf81AthGx9wTaT5PscyoOWyhsDDqbzBl-z7Eg,4191
@@ -173,8 +175,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=WtL-RqGgu2x5PP
 enterprise_reporting/tests/test_utils.py,sha256=Zt_TA0LVb-B6fQGkUkAKKVlUKKnQh8jnw1US1jKe7g8,9493
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-9.7.11.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-9.7.11.dist-info/METADATA,sha256=lQKZwcAoJZxQA-ec3JXt_jrmJAcsk0qKnnB47mywOwU,1570
-edx_enterprise_data-9.7.11.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-edx_enterprise_data-9.7.11.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-9.7.11.dist-info/RECORD,,
+edx_enterprise_data-9.9.1.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-9.9.1.dist-info/METADATA,sha256=ncWbp84mP_4B5WW0va6GldAOyH5AxZ-3j6XacbwQjWY,1569
+edx_enterprise_data-9.9.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+edx_enterprise_data-9.9.1.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-9.9.1.dist-info/RECORD,,

enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "9.7.11"
+__version__ = "9.9.1"

enterprise_data/api/v1/serializers.py

@@ -16,6 +16,7 @@ from enterprise_data.models import (
     EnterpriseOffer,
     EnterpriseSubsidyBudget,
 )
+from enterprise_data.utils import calculate_percentage_difference
 
 
 class EnterpriseLearnerEnrollmentSerializer(serializers.ModelSerializer):
@@ -231,6 +232,7 @@ class EnterpriseExecEdLCModulePerformanceSerializer(serializers.ModelSerializer)
     Serializer for EnterpriseExecEdLCModulePerformance model.
     """
     extensions_requested = serializers.SerializerMethodField()
+    avg_lo_percentage_difference = serializers.SerializerMethodField()
 
     class Meta:
         model = EnterpriseExecEdLCModulePerformance
@@ -240,6 +242,18 @@ class EnterpriseExecEdLCModulePerformanceSerializer(serializers.ModelSerializer)
         """Return extensions_requested if not None, otherwise return 0"""
         return obj.extensions_requested if obj.extensions_requested is not None else 0
 
+    def get_avg_lo_percentage_difference(self, obj):
+        """
+        Return percentage difference between `avg_before_lo_score` and `avg_after_lo_score` if not None,
+        otherwise return None
+        """
+        if obj.avg_before_lo_score is None or obj.avg_after_lo_score is None:
+            return None
+        return round(
+            calculate_percentage_difference(obj.avg_before_lo_score, obj.avg_after_lo_score),
+            2
+        )
+
 
 class EnterpriseBudgetSerializer(serializers.ModelSerializer):
     """

enterprise_data/api/v1/views/enterprise_learner.py

@@ -8,6 +8,7 @@ from uuid import UUID
 
 from rest_framework import filters, viewsets
 from rest_framework.decorators import action
+from rest_framework.exceptions import NotFound
 from rest_framework.response import Response
 
 from django.conf import settings
@@ -20,6 +21,7 @@ from django.utils import timezone
 
 from enterprise_data.admin_analytics.database.utils import LOGGER
 from enterprise_data.api.v1 import serializers
+from enterprise_data.clients import EnterpriseApiClient
 from enterprise_data.models import EnterpriseGroupMembership, EnterpriseLearner, EnterpriseLearnerEnrollment
 from enterprise_data.paginators import EnterpriseEnrollmentsPagination
 from enterprise_data.renderers import EnrollmentsCSVRenderer
@@ -176,12 +178,51 @@ class EnterpriseLearnerEnrollmentViewSet(EnterpriseViewSetMixin, viewsets.ReadOn
 
         group_uuid = query_filters.get('group_uuid')
         if group_uuid:
-            flex_group_exists = EnterpriseGroupMembership.objects.filter(
-                enterprise_customer_user_id=OuterRef('enterprise_user_id'),
-                enterprise_group_uuid=group_uuid,
-                group_type='flex'
-            )
-            queryset = queryset.filter(Exists(flex_group_exists))
+            queryset = self.filter_by_group_uuid(queryset, group_uuid)
+
+        return queryset
+
+    def filter_by_group_uuid(self, queryset, group_uuid):
+        """
+        Filters the queryset based on the provided group_uuid. If no records are found,
+        it attempts to fetch group learners from the API and filter the queryset again.
+
+        Args:
+            queryset (QuerySet): The initial queryset to filter.
+            group_uuid (str): The UUID of the group to filter by.
+
+        Returns:
+            QuerySet: The filtered queryset.
+        """
+        flex_group_exists = EnterpriseGroupMembership.objects.filter(
+            enterprise_customer_user_id=OuterRef('enterprise_user_id'),
+            enterprise_group_uuid=group_uuid,
+            group_type='flex'
+        )
+
+        # First, filter the queryset using flex_group_exists
+        filtered_queryset = queryset.filter(Exists(flex_group_exists))
+
+        # If no records are found, attempt to fetch group_learners from the API
+        if not filtered_queryset.exists():
+            try:
+                enterprise_api_client = EnterpriseApiClient(
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL,
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_KEY,
+                    settings.BACKEND_SERVICE_EDX_OAUTH2_SECRET,
+                )
+                group_learners = enterprise_api_client.get_enterprise_group_learners(group_uuid)
+                if group_learners:
+                    group_learners_ids = [learner['enterprise_customer_user_id'] for learner in group_learners]
+                    queryset = queryset.filter(enterprise_user_id__in=group_learners_ids)
+                else:
+                    LOGGER.warning(f"No group learners found for group: {group_uuid}")
+                    raise NotFound(f"No learners found for group: {group_uuid}")
+            except (Exception) as e:  # pylint: disable=broad-exception-caught
+                LOGGER.error("Failed to fetch group learners from API: %s", e)
+                queryset = queryset.none()  # API call failed or unexpected error, return an empty queryset
+        else:
+            queryset = filtered_queryset
 
         return queryset
 

enterprise_data/clients.py

@@ -101,3 +101,30 @@ class EnterpriseApiClient(OAuthAPIClient):
         TieredCache.set_all_tiers(cache_key, data, DEFAULT_REPORTING_CACHE_TIMEOUT)
 
         return data
+
+    def get_enterprise_group_learners(self, group_uuid):
+        """
+        Get the learners associated with a given enterprise group.
+
+        Returns: list of learners or None if unable to retrieve or no learners exist
+        """
+        LOGGER.info(f'[EnterpriseApiClient] getting learners for enterprise group:{group_uuid}')
+        url = urljoin(self.API_BASE_URL, f'enterprise-group/{group_uuid}/learners/')
+        all_learners = []
+
+        try:
+            while url:
+                response = self.get(url)
+                response.raise_for_status()
+                data = response.json()
+                all_learners.extend(data.get('results', []))
+                url = data.get('next')  # Get the URL for the next page, if any
+
+        except (HTTPError, RequestException) as exc:
+            LOGGER.warning(
+                "[Data Overview Failure] Unable to retrieve Enterprise Group Learners details. "
+                f"Group: {group_uuid}, Exception: {exc}"
+            )
+            return None
+
+        return all_learners

enterprise_data/migrations/0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.15 on 2025-02-20 08:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise_data', '0046_enterprisegroupmembership'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_after_lo_score',
+            field=models.DecimalField(decimal_places=6, max_digits=38, null=True),
+        ),
+        migrations.AddField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_before_lo_score',
+            field=models.DecimalField(decimal_places=6, max_digits=38, null=True),
+        ),
+        migrations.AddField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='question_name',
+            field=models.CharField(max_length=500, null=True),
+        ),
+    ]

enterprise_data/migrations/0048_alter_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.15 on 2025-02-25 08:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('enterprise_data', '0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_after_lo_score',
+            field=models.DecimalField(decimal_places=2, max_digits=38, null=True),
+        ),
+        migrations.AlterField(
+            model_name='enterpriseexecedlcmoduleperformance',
+            name='avg_before_lo_score',
+            field=models.DecimalField(decimal_places=2, max_digits=38, null=True),
+        ),
+    ]

enterprise_data/models.py

@@ -558,6 +558,9 @@ class EnterpriseExecEdLCModulePerformance(models.Model):
     discussion_forum_activities_completed_count = models.PositiveIntegerField(null=True)
     discussion_forum_activities_total_count = models.PositiveIntegerField(null=True)
     pass_grade = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    question_name = models.CharField(max_length=500, null=True)
+    avg_before_lo_score = models.DecimalField(max_digits=38, decimal_places=2, null=True)
+    avg_after_lo_score = models.DecimalField(max_digits=38, decimal_places=2, null=True)
 
     def __str__(self):
         """

enterprise_data/utils.py

@@ -114,3 +114,22 @@ def find_first(iterable, condition):
         return next(item for item in iterable if condition(item))
     except StopIteration:
         return None
+
+
+def calculate_percentage_difference(first, second):
+    """
+    Calculate the percentage difference between two numbers.
+
+    It will calculate the percentage difference between the two numbers using the formula:
+    ((second - first) / (first + second)/2) * 100
+
+    Arguments:
+        first (float): The first number.
+        second (float): The second number.
+
+    Returns:
+        float: The percentage difference between the two numbers.
+    """
+    if first == 0 and second == 0:
+        return 0
+    return ((second - first) / ((first + second) / 2)) * 100