edx-enterprise-data 10.7.7__tar.gz → 10.8.1__tar.gz

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 =========================
 
+[10.8.1] - 2025-02-20
+---------------------
+  * feat: Added 2 new columns in module performance report model and exposed them via associated REST API.
+
+[10.7.8] - 2025-02-18
+---------------------
+  * chore: bump version from 10.7.7 to 10.7.8 for dependency upgrades
+
 [10.7.7] - 2025-02-11
 ---------------------
   * chore: upgrade python requirements

{edx_enterprise_data-10.7.7/edx_enterprise_data.egg-info → edx_enterprise_data-10.8.1}/PKG-INFO

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

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1/edx_enterprise_data.egg-info}/PKG-INFO

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

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -117,6 +117,7 @@ enterprise_data/migrations/0040_auto_20240718_0536_squashed_0043_alter_enterpris
 enterprise_data/migrations/0044_enterpriseexecedlcmoduleperformance.py
 enterprise_data/migrations/0045_alter_enterpriseexecedlcmoduleperformance_options_and_more.py
 enterprise_data/migrations/0046_enterprisegroupmembership.py
+enterprise_data/migrations/0047_enterpriseexecedlcmoduleperformance_avg_after_lo_score_and_more.py
 enterprise_data/migrations/__init__.py
 enterprise_data/settings/__init__.py
 enterprise_data/settings/test.py

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/enterprise_data/__init__.py

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

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.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):
     """

edx_enterprise_data-10.8.1/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),
+        ),
+    ]

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/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=6, null=True)
+    avg_after_lo_score = models.DecimalField(max_digits=38, decimal_places=6, null=True)
 
     def __str__(self):
         """

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/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

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/enterprise_reporting/send_enterprise_reports.py

@@ -4,13 +4,15 @@ Sends an Enterprise Customer's data file to a configured destination.
 """
 
 
-
 import argparse
+import datetime
 import logging
 import os
 import re
 import sys
 
+import pytz
+
 from enterprise_reporting.clients.enterprise import EnterpriseAPIClient
 from enterprise_reporting.reporter import EnterpriseReportSender
 from enterprise_reporting.utils import is_current_time_in_schedule
@@ -55,11 +57,13 @@ def cleanup_files(enterprise_id):
             os.remove(os.path.join(directory, f))
 
 
-def should_deliver_report(args, reporting_config):
+def should_deliver_report(args, reporting_config, current_est_time):
     """Given CLI arguments and the reporting configuration, determine if delivery should happen."""
     valid_data_type = reporting_config['data_type'] in (args.data_type or DATA_TYPES)
     enterprise_customer_specified = bool(args.enterprise_customer)
+
     meets_schedule_requirement = is_current_time_in_schedule(
+        current_est_time,
         reporting_config['frequency'],
         reporting_config['hour_of_day'],
         reporting_config['day_of_month'],
@@ -101,6 +105,12 @@ def process_reports():
         LOGGER.error(f'The enterprise {args.enterprise_customer} does not have a reporting configuration.')
         sys.exit(1)
 
+    # We are defining the current est time globally because we want the current time for a job
+    # to remain same thoughout the job. This ensures that a single report is not processed multiple times. 
+    # See this comment for more details: https://2u-internal.atlassian.net/browse/ENT-9954?focusedCommentId=5356815
+    est_timezone = pytz.timezone('US/Eastern')
+    current_est_time = datetime.datetime.now(est_timezone)
+
     error_raised = False
     for reporting_config in reporting_configs['results']:
         LOGGER.info('Checking if {}\'s reporting config for {} data in {} format is ready for processing'.format(
@@ -109,7 +119,7 @@ def process_reports():
             reporting_config['report_type'],
         ))
 
-        if should_deliver_report(args, reporting_config):
+        if should_deliver_report(args, reporting_config, current_est_time):
             if send_data(reporting_config):
                 error_raised = True
         else:

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/enterprise_reporting/tests/test_send_enterprise_reports.py

@@ -33,4 +33,4 @@ class TestSendEnterpriseReports(unittest.TestCase):
 		Command = namedtuple("Command", "data_type enterprise_customer")
 		args = Command('', '')
 
-		assert should_deliver_report(args, reporting_config)
+		assert should_deliver_report(args, reporting_config, current_est_time)

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/enterprise_reporting/tests/test_utils.py

@@ -165,6 +165,7 @@ class TestUtilities(unittest.TestCase):
         est_timezone = pytz.timezone('US/Eastern')
         current_est_time = datetime.datetime.now(est_timezone)
         assert utils.is_current_time_in_schedule(
+            current_est_time,
             utils.FREQUENCY_TYPE_DAILY,
             current_est_time.hour,
             current_est_time.day,

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/enterprise_reporting/utils.py

@@ -3,7 +3,6 @@ Utility functions for Enterprise Reporting.
 """
 
 
-import datetime
 import logging
 import os
 import re
@@ -16,7 +15,6 @@ from urllib.parse import parse_qs, urlparse
 import boto3
 import pgpy
 import pyminizip
-import pytz
 from cryptography.fernet import Fernet
 from fernet_fields.hkdf import derive_fernet_key
 
@@ -149,12 +147,11 @@ def send_email_with_attachment(subject, body, from_email, to_email, attachment_d
         LOGGER.debug(result)
 
 
-def is_current_time_in_schedule(frequency, hour_of_day, day_of_month=None, day_of_week=None):
+def is_current_time_in_schedule(current_est_time, frequency, hour_of_day, day_of_month=None, day_of_week=None):
     """
     Determine if the current time is in the range specified by this configuration's schedule.
     """
-    est_timezone = pytz.timezone('US/Eastern')
-    current_est_time = datetime.datetime.now(est_timezone)
+
     current_hour_of_day = current_est_time.hour
     current_day_of_week = current_est_time.weekday()
     current_day_of_month = current_est_time.day

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/requirements/base.txt

@@ -10,15 +10,15 @@ asgiref==3.8.1
     # via django
 asn1crypto==1.5.1
     # via snowflake-connector-python
-awscli==1.37.16
+awscli==1.37.21
     # via -r requirements/reporting.in
 bcrypt==4.2.1
     # via paramiko
 billiard==4.2.1
     # via celery
-boto3==1.36.16
+boto3==1.36.21
     # via -r requirements/reporting.in
-botocore==1.36.16
+botocore==1.36.21
     # via
     #   awscli
     #   boto3
@@ -54,7 +54,7 @@ click-repl==0.3.0
     # via celery
 colorama==0.4.6
     # via awscli
-cryptography==44.0.0
+cryptography==44.0.1
     # via
     #   -r requirements/reporting.in
     #   django-fernet-fields-v2
@@ -83,7 +83,7 @@ django-crum==0.7.9
     #   edx-rbac
 django-fernet-fields-v2==0.9
     # via -r requirements/base.in
-django-filter==24.3
+django-filter==25.1
     # via -r requirements/base.in
 django-model-utils==5.0.0
     # via
@@ -121,11 +121,11 @@ edx-opaque-keys==2.11.0
     #   edx-drf-extensions
 edx-rbac==1.10.0
     # via -r requirements/base.in
-edx-rest-api-client==6.0.0
+edx-rest-api-client==6.1.0
     # via -r requirements/base.in
 factory-boy==3.3.3
     # via -r requirements/base.in
-faker==35.2.0
+faker==36.1.1
     # via factory-boy
 filelock==3.17.0
     # via snowflake-connector-python
@@ -147,7 +147,7 @@ mysql-connector-python==9.2.0
     # via -r requirements/base.in
 newrelic==10.6.0
     # via edx-django-utils
-numpy==2.2.2
+numpy==2.2.3
     # via
     #   -r requirements/base.in
     #   pandas
@@ -171,7 +171,7 @@ platformdirs==4.3.6
     # via snowflake-connector-python
 prompt-toolkit==3.0.50
     # via click-repl
-psutil==6.1.1
+psutil==7.0.0
     # via edx-django-utils
 py2neo @ https://github.com/overhangio/py2neo/releases/download/2021.2.3/py2neo-2021.2.3.tar.gz
     # via -r requirements/reporting.in
@@ -191,7 +191,7 @@ pyjwt[crypto]==2.10.1
     #   snowflake-connector-python
 pyminizip==0.2.6
     # via -r requirements/reporting.in
-pymongo==4.11
+pymongo==4.11.1
     # via edx-opaque-keys
 pynacl==1.5.0
     # via
@@ -203,7 +203,6 @@ python-dateutil==2.9.0.post0
     # via
     #   botocore
     #   celery
-    #   faker
     #   pandas
     #   vertica-python
 pytz==2025.1
@@ -251,11 +250,11 @@ tomlkit==0.13.2
 typing-extensions==4.12.2
     # via
     #   edx-opaque-keys
-    #   faker
     #   snowflake-connector-python
 tzdata==2025.1
     # via
     #   celery
+    #   faker
     #   kombu
     #   pandas
 unicodecsv==0.14.1

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/requirements/ci.txt

@@ -10,7 +10,7 @@ chardet==5.2.0
     # via tox
 colorama==0.4.6
     # via tox
-coverage==7.6.11
+coverage==7.6.12
     # via -r requirements/ci.in
 distlib==0.3.9
     # via virtualenv
@@ -32,5 +32,5 @@ pyproject-api==1.9.0
     # via tox
 tox==4.24.1
     # via -r requirements/ci.in
-virtualenv==20.29.1
+virtualenv==20.29.2
     # via tox

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/requirements/dev.txt

@@ -14,15 +14,15 @@ astroid==3.3.8
     # via
     #   pylint
     #   pylint-celery
-awscli==1.37.16
+awscli==1.37.21
     # via -r requirements/reporting.in
 bcrypt==4.2.1
     # via paramiko
 billiard==4.2.1
     # via celery
-boto3==1.36.16
+boto3==1.36.21
     # via -r requirements/reporting.in
-botocore==1.36.16
+botocore==1.36.21
     # via
     #   awscli
     #   boto3
@@ -76,7 +76,7 @@ colorama==0.4.6
     # via
     #   awscli
     #   tox
-cryptography==44.0.0
+cryptography==44.0.1
     # via
     #   -r requirements/reporting.in
     #   django-fernet-fields-v2
@@ -113,7 +113,7 @@ django-crum==0.7.9
     #   edx-rbac
 django-fernet-fields-v2==0.9
     # via -r requirements/base.in
-django-filter==24.3
+django-filter==25.1
     # via -r requirements/base.in
 django-model-utils==5.0.0
     # via
@@ -159,11 +159,11 @@ edx-opaque-keys==2.11.0
     #   edx-drf-extensions
 edx-rbac==1.10.0
     # via -r requirements/base.in
-edx-rest-api-client==6.0.0
+edx-rest-api-client==6.1.0
     # via -r requirements/base.in
 factory-boy==3.3.3
     # via -r requirements/base.in
-faker==35.2.0
+faker==36.1.1
     # via factory-boy
 filelock==3.17.0
     # via
@@ -204,7 +204,7 @@ keyring==25.6.0
     # via twine
 kombu==5.4.2
     # via celery
-lxml[html-clean,html_clean]==5.3.0
+lxml[html-clean,html_clean]==5.3.1
     # via
     #   edx-i18n-tools
     #   lxml-html-clean
@@ -230,7 +230,7 @@ newrelic==10.6.0
     # via edx-django-utils
 nh3==0.2.20
     # via readme-renderer
-numpy==2.2.2
+numpy==2.2.3
     # via
     #   -r requirements/base.in
     #   pandas
@@ -272,7 +272,7 @@ polib==1.2.0
     # via edx-i18n-tools
 prompt-toolkit==3.0.50
     # via click-repl
-psutil==6.1.1
+psutil==7.0.0
     # via edx-django-utils
 py2neo @ https://github.com/overhangio/py2neo/releases/download/2021.2.3/py2neo-2021.2.3.tar.gz
     # via -r requirements/reporting.in
@@ -314,7 +314,7 @@ pylint-plugin-utils==0.8.2
     #   pylint-django
 pyminizip==0.2.6
     # via -r requirements/reporting.in
-pymongo==4.11
+pymongo==4.11.1
     # via edx-opaque-keys
 pynacl==1.5.0
     # via
@@ -332,7 +332,6 @@ python-dateutil==2.9.0.post0
     # via
     #   botocore
     #   celery
-    #   faker
     #   pandas
     #   vertica-python
 python-slugify==8.0.4
@@ -412,11 +411,11 @@ twine==6.1.0
 typing-extensions==4.12.2
     # via
     #   edx-opaque-keys
-    #   faker
     #   snowflake-connector-python
 tzdata==2025.1
     # via
     #   celery
+    #   faker
     #   kombu
     #   pandas
 unicodecsv==0.14.1
@@ -435,7 +434,7 @@ vine==5.1.0
     #   amqp
     #   celery
     #   kombu
-virtualenv==20.29.1
+virtualenv==20.29.2
     # via tox
 wcwidth==0.2.13
     # via prompt-toolkit

{edx_enterprise_data-10.7.7 → edx_enterprise_data-10.8.1}/requirements/quality.txt

@@ -14,15 +14,15 @@ astroid==3.3.8
     # via
     #   pylint
     #   pylint-celery
-awscli==1.37.16
+awscli==1.37.21
     # via -r requirements/reporting.in
 bcrypt==4.2.1
     # via paramiko
 billiard==4.2.1
     # via celery
-boto3==1.36.16
+boto3==1.36.21
     # via -r requirements/reporting.in
-botocore==1.36.16
+botocore==1.36.21
     # via
     #   awscli
     #   boto3
@@ -76,9 +76,9 @@ colorama==0.4.6
     # via
     #   awscli
     #   tox
-coverage[toml]==7.6.11
+coverage[toml]==7.6.12
     # via pytest-cov
-cryptography==44.0.0
+cryptography==44.0.1
     # via
     #   -r requirements/reporting.in
     #   django-fernet-fields-v2
@@ -117,7 +117,7 @@ django-crum==0.7.9
     #   edx-rbac
 django-fernet-fields-v2==0.9
     # via -r requirements/base.in
-django-filter==24.3
+django-filter==25.1
     # via -r requirements/base.in
 django-model-utils==5.0.0
     # via
@@ -164,13 +164,13 @@ edx-opaque-keys==2.11.0
     #   edx-drf-extensions
 edx-rbac==1.10.0
     # via -r requirements/base.in
-edx-rest-api-client==6.0.0
+edx-rest-api-client==6.1.0
     # via -r requirements/base.in
 factory-boy==3.3.3
     # via
     #   -r requirements/base.in
     #   -r requirements/test.in
-faker==35.2.0
+faker==36.1.1
     # via factory-boy
 filelock==3.17.0
     # via
@@ -217,7 +217,7 @@ keyring==25.6.0
     # via twine
 kombu==5.4.2
     # via celery
-lxml[html-clean,html_clean]==5.3.0
+lxml[html-clean,html_clean]==5.3.1
     # via
     #   edx-i18n-tools
     #   lxml-html-clean
@@ -245,7 +245,7 @@ newrelic==10.6.0
     # via edx-django-utils
 nh3==0.2.20
     # via readme-renderer
-numpy==2.2.2
+numpy==2.2.3
     # via
     #   -r requirements/base.in
     #   pandas
@@ -289,7 +289,7 @@ polib==1.2.0
     # via edx-i18n-tools
 prompt-toolkit==3.0.50
     # via click-repl
-psutil==6.1.1
+psutil==7.0.0
     # via edx-django-utils
 py2neo @ https://github.com/overhangio/py2neo/releases/download/2021.2.3/py2neo-2021.2.3.tar.gz
     # via -r requirements/reporting.in
@@ -331,7 +331,7 @@ pylint-plugin-utils==0.8.2
     #   pylint-django
 pyminizip==0.2.6
     # via -r requirements/reporting.in
-pymongo==4.11
+pymongo==4.11.1
     # via edx-opaque-keys
 pynacl==1.5.0
     # via
@@ -351,13 +351,12 @@ pytest==8.3.4
     #   pytest-django
 pytest-cov==6.0.0
     # via -r requirements/test.in
-pytest-django==4.9.0
+pytest-django==4.10.0
     # via -r requirements/test.in
 python-dateutil==2.9.0.post0
     # via
     #   botocore
     #   celery
-    #   faker
     #   freezegun
     #   pandas
     #   vertica-python
@@ -444,11 +443,11 @@ twine==6.1.0
 typing-extensions==4.12.2
     # via
     #   edx-opaque-keys
-    #   faker
     #   snowflake-connector-python
 tzdata==2025.1
     # via
     #   celery
+    #   faker
     #   kombu
     #   pandas
 unicodecsv==0.14.1
@@ -468,7 +467,7 @@ vine==5.1.0
     #   amqp
     #   celery
     #   kombu
-virtualenv==20.29.1
+virtualenv==20.29.2
     # via tox
 wcwidth==0.2.13
     # via prompt-toolkit