edx-enterprise-data 10.16.11__tar.gz → 10.17.1__tar.gz

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 =========================
 
+[10.17.1] - 2025-07-11
+---------------------
+  * feat: add course type filtering for skills api
+
+[10.17.0] - 2025-07-07
+---------------------
+  * chore: remove pandas and numpy from requirements
+
 [10.16.11] - 2025-07-03
 ---------------------
   * chore: upgrade package version

{edx_enterprise_data-10.16.11/edx_enterprise_data.egg-info → edx_enterprise_data-10.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edx-enterprise-data
-Version: 10.16.11
+Version: 10.17.1
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -24,8 +24,6 @@ Requires-Dist: edx-rbac
 Requires-Dist: edx-rest-api-client
 Requires-Dist: factory_boy
 Requires-Dist: mysql-connector-python
-Requires-Dist: numpy
-Requires-Dist: pandas
 Requires-Dist: requests
 Requires-Dist: rules
 Provides-Extra: reporting

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edx-enterprise-data
-Version: 10.16.11
+Version: 10.17.1
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX
@@ -24,8 +24,6 @@ Requires-Dist: edx-rbac
 Requires-Dist: edx-rest-api-client
 Requires-Dist: factory_boy
 Requires-Dist: mysql-connector-python
-Requires-Dist: numpy
-Requires-Dist: pandas
 Requires-Dist: requests
 Requires-Dist: rules
 Provides-Extra: reporting

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/edx_enterprise_data.egg-info/requires.txt

@@ -10,8 +10,6 @@ edx-rbac
 edx-rest-api-client
 factory_boy
 mysql-connector-python
-numpy
-pandas
 requests
 rules
 

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/__init__.py

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

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/admin_analytics/constants.py

@@ -5,6 +5,12 @@ Constants for admin analytics app.
 from enum import Enum
 
 
+class CourseType(Enum):
+    """Course type choices"""
+    OCM = "OCM"
+    EXECUTIVE_EDUCATION = "Executive Education"
+
+
 class ResponseType(Enum):
     """Response type choices"""
     JSON = 'json'

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/admin_analytics/data_loaders.py

@@ -1,10 +1,9 @@
 """
 Utility functions for fetching data from the database.
 """
+from datetime import timezone
 from logging import getLogger
 
-import pandas
-
 from enterprise_data.admin_analytics.database import run_query
 
 LOGGER = getLogger(__name__)
@@ -21,4 +20,4 @@ def fetch_max_enrollment_datetime():
     results = run_query(query)
     if not results:
         return None
-    return pandas.to_datetime(results[0][0], utc=True)
+    return results[0][0].astimezone(timezone.utc)

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/admin_analytics/database/queries/skills_daily_rollup_admin_dash.py

@@ -9,11 +9,11 @@ class SkillsDailyRollupAdminDashQueries:
     Queries related to the skills_daily_rollup_admin_dash table.
     """
     @staticmethod
-    def get_top_skills():
+    def get_top_skills(query_filters: QueryFilters):
         """
         Get the query to fetch the top skills for an enterprise customer.
         """
-        return """
+        return f"""
             SELECT
                 skill_name,
                 skill_type,
@@ -22,8 +22,7 @@ class SkillsDailyRollupAdminDashQueries:
             FROM
                 skills_daily_rollup_admin_dash
             WHERE
-                enterprise_customer_uuid=%(enterprise_customer_uuid)s AND
-                date BETWEEN %(start_date)s AND %(end_date)s
+                {query_filters.to_sql()}
             GROUP BY
                 skill_name, skill_type
             ORDER BY
@@ -31,21 +30,27 @@ class SkillsDailyRollupAdminDashQueries:
         """
 
     @staticmethod
-    def get_top_skills_by_enrollment():
+    def get_top_skills_by_enrollment(query_filters: QueryFilters):
         """
         Get the query to fetch the top skills by enrollment for an enterprise customer.
         """
-        return """
-            WITH TopSkills AS (
-                -- Get top 10 skills by total enrollments
+        return f"""
+            WITH FilteredData AS (
                 SELECT
                     skill_name,
-                    SUM(enrolls) AS total_enrollment_count
+                    primary_subject_name,
+                    enrolls
                 FROM
                     skills_daily_rollup_admin_dash
                 WHERE
-                    enterprise_customer_uuid=%(enterprise_customer_uuid)s
-                    AND date BETWEEN %(start_date)s AND %(end_date)s
+                    {query_filters.to_sql()}
+            ),
+            TopSkills AS (
+                SELECT
+                    skill_name,
+                    SUM(enrolls) AS total_enrollment_count
+                FROM
+                    FilteredData
                 GROUP BY
                     skill_name
                 ORDER BY
@@ -53,44 +58,48 @@ class SkillsDailyRollupAdminDashQueries:
                 LIMIT 10
             )
             SELECT
-                sd.skill_name,
+                fd.skill_name,
                 CASE
-                    WHEN sd.primary_subject_name IN (
+                    WHEN fd.primary_subject_name IN (
                         'business-management', 'computer-science',
                         'data-analysis-statistics', 'engineering', 'communication'
-                    ) THEN sd.primary_subject_name
+                    ) THEN fd.primary_subject_name
                     ELSE 'other'
                 END AS subject_name,
-                SUM(sd.enrolls) AS count
+                SUM(fd.enrolls) AS count
             FROM
-                skills_daily_rollup_admin_dash AS sd
+                FilteredData fd
             JOIN
-                TopSkills AS ts ON sd.skill_name = ts.skill_name
-            WHERE
-                sd.enterprise_customer_uuid=%(enterprise_customer_uuid)s
-                AND date BETWEEN %(start_date)s AND %(end_date)s
+                TopSkills ts ON fd.skill_name = ts.skill_name
             GROUP BY
-                sd.skill_name, subject_name
+                fd.skill_name, subject_name
             ORDER BY
-                total_enrollment_count DESC;
+                ts.total_enrollment_count DESC;
         """
 
     @staticmethod
-    def get_top_skills_by_completion():
+    def get_top_skills_by_completion(query_filters: QueryFilters):
         """
         Get the query to fetch the top skills by completion for an enterprise customer.
         """
-        return """
-            WITH TopSkills AS (
-                -- Get top 10 skills by total completions
+        return f"""
+            WITH FilteredData AS (
                 SELECT
                     skill_name,
-                    SUM(completions) AS total_completion_count
+                    primary_subject_name,
+                    completions
                 FROM
                     skills_daily_rollup_admin_dash
                 WHERE
-                    enterprise_customer_uuid=%(enterprise_customer_uuid)s
-                    AND date BETWEEN %(start_date)s AND %(end_date)s
+                    {query_filters.to_sql()}
+            ),
+            TopSkills AS (
+                -- Get top 10 skills by total completions
+                SELECT
+                    skill_name,
+                    SUM(completions) AS total_completion_count
+                FROM
+                    FilteredData
                 GROUP BY
                     skill_name
                 ORDER BY
@@ -98,26 +107,23 @@ class SkillsDailyRollupAdminDashQueries:
                 LIMIT 10
             )
             SELECT
-                sd.skill_name,
+                fd.skill_name,
                 CASE
-                    WHEN sd.primary_subject_name IN (
+                    WHEN fd.primary_subject_name IN (
                         'business-management', 'computer-science',
                         'data-analysis-statistics', 'engineering', 'communication'
-                    ) THEN sd.primary_subject_name
+                    ) THEN fd.primary_subject_name
                     ELSE 'other'
                 END AS subject_name,
-                SUM(sd.completions) AS count
+                SUM(fd.completions) AS count
             FROM
-                skills_daily_rollup_admin_dash AS sd
+                FilteredData AS fd
             JOIN
-                TopSkills AS ts ON sd.skill_name = ts.skill_name
-            WHERE
-                sd.enterprise_customer_uuid=%(enterprise_customer_uuid)s
-                AND date BETWEEN %(start_date)s AND %(end_date)s
+                TopSkills AS ts ON fd.skill_name = ts.skill_name
             GROUP BY
-                sd.skill_name, subject_name
+                fd.skill_name, subject_name
             ORDER BY
-                total_completion_count DESC;
+                ts.total_completion_count DESC;
         """
 
     @staticmethod

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/admin_analytics/database/tables/skills_daily_rollup_admin_dash.py

@@ -22,8 +22,70 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
     """
     queries = SkillsDailyRollupAdminDashQueries()
 
+    def build_query_filters(
+        self,
+        enterprise_customer_uuid: UUID,
+        start_date: date,
+        end_date: date,
+        course_type: str = None,
+        course_key: str = None,
+    ):
+        """
+        Build query filters and parameters for enterprise analytics queries.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
+            start_date (date): The start date for the query.
+            end_date (date): The end date for the query.
+            course_type (str, optional): The course type to filter by (e.g., 'OCM', 'Executive Education').
+            course_key (str, optional): The course key to filter by.
+
+        Returns:
+            tuple: A tuple containing:
+                - QueryFilters: The filters to apply to the query.
+                - dict: The parameters to use in the query.
+        """
+        optional_params = {}
+        default_params = {
+            'enterprise_customer_uuid': enterprise_customer_uuid,
+            'start_date': start_date,
+            'end_date': end_date,
+        }
+
+        query_filters = QueryFilters([
+            self.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
+            self.date_range_filter(
+                column='date',
+                start_date_params_key='start_date',
+                end_date_params_key='end_date',
+            ),
+        ])
+
+        if course_key:
+            query_filters.append(EqualQueryFilter(
+                column='course_key',
+                value_placeholder='course_key',
+            ))
+            optional_params['course_key'] = course_key
+
+        if course_type:
+            query_filters.append(EqualQueryFilter(
+                column='course_product_line',
+                value_placeholder='course_type',
+            ))
+            optional_params['course_type'] = course_type
+
+        params = {**default_params, **optional_params}
+        return query_filters, params
+
     @cache_it()
-    def get_top_skills(self, enterprise_customer_uuid: UUID, start_date: date, end_date: date):
+    def get_top_skills(
+        self,
+        enterprise_customer_uuid: UUID,
+        start_date: date,
+        end_date: date,
+        course_type: str = None,
+    ):
         """
         Get the top skills for the given enterprise customer.
 
@@ -31,17 +93,20 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
             start_date (date): The start date.
             end_date (date): The end date.
+            course_type (str): The course type (OCM or Executive Education) to filter by (optional).
 
         Returns:
             list<dict>: A list of dictionaries containing the skill_name, skill_type, enrolls and completions.
         """
+        query_filters, params = self.build_query_filters(
+            enterprise_customer_uuid=enterprise_customer_uuid,
+            start_date=start_date,
+            end_date=end_date,
+            course_type=course_type,
+        )
         return run_query(
-            query=self.queries.get_top_skills(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_skills(query_filters),
+            params=params,
             as_dict=True,
         )
 
@@ -50,7 +115,8 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
         self,
         enterprise_customer_uuid: UUID,
         start_date: date,
-        end_date: date
+        end_date: date,
+        course_type: str = None,
     ):
         """
         Get the top skills by enrollments for the given enterprise customer.
@@ -59,17 +125,20 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
             start_date (date): The start date.
             end_date (date): The end date.
+            course_type (str): The course type (OCM or Executive Education) to filter by (optional).
 
         Returns:
             list<dict>: A list of dictionaries containing the skill_name, subject_name, count.
         """
+        query_filters, params = self.build_query_filters(
+            enterprise_customer_uuid=enterprise_customer_uuid,
+            start_date=start_date,
+            end_date=end_date,
+            course_type=course_type,
+        )
         return run_query(
-            query=self.queries.get_top_skills_by_enrollment(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_skills_by_enrollment(query_filters),
+            params=params,
             as_dict=True,
         )
 
@@ -78,7 +147,8 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
         self,
         enterprise_customer_uuid: UUID,
         start_date: date,
-        end_date: date
+        end_date: date,
+        course_type: str = None,
     ):
         """
         Get the top skills by completion for the given enterprise customer.
@@ -87,17 +157,20 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
             enterprise_customer_uuid (UUID): The UUID of the enterprise customer.
             start_date (date): The start date.
             end_date (date): The end date.
+            course_type (str): The course type (OCM or Executive Education) to filter by (optional).
 
         Returns:
             list<dict>: A list of dictionaries containing the skill_name, subject_name, count.
         """
+        query_filters, params = self.build_query_filters(
+            enterprise_customer_uuid=enterprise_customer_uuid,
+            start_date=start_date,
+            end_date=end_date,
+            course_type=course_type,
+        )
         return run_query(
-            query=self.queries.get_top_skills_by_completion(),
-            params={
-                'enterprise_customer_uuid': enterprise_customer_uuid,
-                'start_date': start_date,
-                'end_date': end_date,
-            },
+            query=self.queries.get_top_skills_by_completion(query_filters),
+            params=params,
             as_dict=True,
         )
 
@@ -122,44 +195,13 @@ class SkillsDailyRollupAdminDashTable(CommonFiltersMixin, BaseTable):
         Returns:
             list<dict>: A list of dictionaries containing the skill_name, subject_name, count.
         """
-        optional_params = {}
-        course_key_filter = None
-        course_type_filter = None
-
-        default_params = {
-            'enterprise_customer_uuid': enterprise_customer_uuid,
-            'start_date': start_date,
-            'end_date': end_date,
-        }
-        query_filters = QueryFilters([
-            self.enterprise_customer_uuid_filter('enterprise_customer_uuid'),
-            self.date_range_filter(
-                column='date',
-                start_date_params_key='start_date',
-                end_date_params_key='end_date',
-            ),
-        ])
-
-        if course_key:
-            course_key_filter = EqualQueryFilter(
-                column='course_key',
-                value_placeholder='course_key',
-            )
-
-            optional_params['course_key'] = course_key
-            query_filters.append(course_key_filter)
-
-        if course_type:
-            course_type_filter = EqualQueryFilter(
-                column='course_product_line',
-                value_placeholder='course_type',
-            )
-
-            optional_params['course_type'] = course_type
-            query_filters.append(course_type_filter)
-
-        params = {**default_params, **optional_params}
-
+        query_filters, params = self.build_query_filters(
+            enterprise_customer_uuid=enterprise_customer_uuid,
+            start_date=start_date,
+            end_date=end_date,
+            course_key=course_key,
+            course_type=course_type,
+        )
         return run_query(
             query=self.queries.get_skills_by_learning_hours(query_filters),
             params=params,

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/api/v1/serializers.py

@@ -5,7 +5,7 @@ from uuid import UUID
 
 from rest_framework import serializers
 
-from enterprise_data.admin_analytics.constants import ResponseType
+from enterprise_data.admin_analytics.constants import CourseType, ResponseType
 from enterprise_data.cache.decorators import cache_it
 from enterprise_data.models import (
     EnterpriseAdminLearnerProgress,
@@ -343,6 +343,12 @@ class AdvanceAnalyticsQueryParamSerializer(serializers.Serializer):  # pylint: d
     page = serializers.IntegerField(required=False, min_value=1)
     page_size = serializers.IntegerField(required=False, min_value=2)
     group_uuid = serializers.UUIDField(required=False)
+    course_type = serializers.ChoiceField(
+        choices=[course_type.value for course_type in CourseType],
+        required=False,
+        allow_blank=False,
+        allow_null=False,
+    )
 
     def validate(self, attrs):
         """

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/api/v1/views/enterprise_admin.py

@@ -163,21 +163,29 @@ class EnterpriseAdminAnalyticsSkillsView(APIView):
             start_date, _ = FactEnrollmentAdminDashTable().get_enrollment_date_range(enterprise_id)
 
         end_date = serializer.data.get('end_date', date.today())
+        course_type = serializer.data.get('course_type')
 
         with timer('top_skills'):
-            skills = SkillsDailyRollupAdminDashTable().get_top_skills(enterprise_id, start_date, end_date)
+            skills = SkillsDailyRollupAdminDashTable().get_top_skills(
+                enterprise_id,
+                start_date,
+                end_date,
+                course_type
+            )
 
         with timer('top_skills_by_enrollments'):
             top_skills_by_enrollments = SkillsDailyRollupAdminDashTable().get_top_skills_by_enrollment(
                 enterprise_id,
                 start_date,
-                end_date
+                end_date,
+                course_type
             )
         with timer('top_skills_by_completions'):
             top_skills_by_completions = SkillsDailyRollupAdminDashTable().get_top_skills_by_completion(
                 enterprise_id,
                 start_date,
-                end_date
+                end_date,
+                course_type
             )
 
         # TODO: Handle course_key and course_type when they are provided in the request.

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/enterprise_data/tests/admin_analytics/test_data_loaders.py

@@ -1,6 +1,8 @@
 """
 Test the utility functions in the admin_analytics app for data loading operations.
 """
+from datetime import datetime
+
 from mock import patch
 
 from django.test import TestCase
@@ -18,7 +20,7 @@ class TestDataLoaders(TestCase):
         Validate the fetch_max_enrollment_datetime function.
         """
         with patch('enterprise_data.admin_analytics.data_loaders.run_query') as mock_run_query:
-            mock_run_query.return_value = [['2024-07-26']]
+            mock_run_query.return_value = [[datetime(2024, 7, 26, 21, 38, 48, 298000)]]
 
             max_enrollment_date = fetch_max_enrollment_datetime()
             self.assertEqual(max_enrollment_date.strftime('%Y-%m-%d'), '2024-07-26')

{edx_enterprise_data-10.16.11 → edx_enterprise_data-10.17.1}/requirements/base.in

@@ -13,6 +13,4 @@ django-model-utils
 edx-rbac
 rules
 factory_boy
-numpy
-pandas
 mysql-connector-python