feat: [ACI-262] credly_badges feature flag

credentials/apps/badges/admin.py

@@ -1,9 +1,11 @@
 """
 Admin section configuration.
 """
+from django.contrib import admin
 
 from .toggles import is_badges_enabled
 
+
+# register admin configurations with respect to the feature flag
 if is_badges_enabled():
-    # TODO: Define registering admin classes here `admin.site.register(...)`
-    pass
+    pass

credentials/apps/badges/apps.py

@@ -1,37 +1,37 @@
 from django.apps import AppConfig
-from credentials.apps.plugins.constants import (
-    PluginURLs,
-    PluginSettings,
-    SettingsType,
-    PROJECT_TYPE,
-)
-from .toggles import is_badges_enabled, check_badges_enabled
+from django.conf import settings
 
+from credentials.apps.plugins.constants import PROJECT_TYPE, PluginSettings, PluginURLs, SettingsType
 
-class BadgesConfig(AppConfig):
+from .toggles import check_badges_enabled, is_badges_enabled
+
+
+class BadgesAppConfig(AppConfig):
+    """
+    Extended application config with additional Badges-specific logic.
+    """
+
+    @property
+    def verbose_name(self):
+        return f"Badges: {self.plugin_label}"
+
+
+class BadgesConfig(BadgesAppConfig):
+    """
+    Core badges application configuration.
+    """
+    default = True
     name = "credentials.apps.badges"
     verbose_name = "Badges"
 
-    plugin_app = {
-        PluginURLs.CONFIG: {
-            PROJECT_TYPE: {
-                PluginURLs.NAMESPACE: 'badges',
-                PluginURLs.REGEX: 'badges/',
-                PluginURLs.RELATIVE_PATH: 'urls',
-            }
-        },
-        PluginSettings.CONFIG: {
-            PROJECT_TYPE: {
-                SettingsType.BASE: {PluginSettings.RELATIVE_PATH: 'settings.base'},
-                SettingsType.PRODUCTION: {PluginSettings.RELATIVE_PATH: 'settings.production'},
-                SettingsType.TEST: {PluginSettings.RELATIVE_PATH: 'settings.test'},
-            },
-        }
-    } if is_badges_enabled() else {}
-
     @check_badges_enabled
     def ready(self):
         """
+        Activate installed badges plugins if they are enabled.
+
         Performs initial registrations for checks, signals, etc.
         """
-        # TODO: from .checks import configuration_checks
+        from .checks import badges_checks  # pylint: disable=unused-import,import-outside-toplevel
+        from .signals import handlers  # pylint: disable=unused-import,import-outside-toplevel
+
+        super().ready()

credentials/apps/badges/checks.py

@@ -1,5 +1,5 @@
 """
-Badges checks.
+Badges app self-checks.
 """
 from django.conf import settings
 from django.core.checks import Error, Tags, register

credentials/apps/badges/distribution/credly/credly_badges/admin.py

@@ -1,3 +1,21 @@
 """
 Credly Badges admin configuration.
 """
+
+from django.contrib import admin
+
+from credentials.apps.badges.toggles import is_badges_enabled
+
+from .models import CredlyOrganization
+
+
+class CredlyOrganizationAdmin(admin.ModelAdmin):
+    """
+    Credly organization admin setup.
+    """
+    list_display = ("name", "uuid", "api_key",)
+
+
+# register admin configurations with respect to the feature flag
+if is_badges_enabled():
+    admin.site.register(CredlyOrganization, CredlyOrganizationAdmin)

credentials/apps/badges/distribution/credly/credly_badges/apps.py

@@ -1,15 +1,22 @@
-from django.apps import AppConfig
-from credentials.apps.plugins.constants import (
-    PluginURLs,
-    PluginSettings,
-    SettingsType,
-    PROJECT_TYPE,
-)
+from credentials.apps.badges.apps import BadgesAppConfig
+from credentials.apps.badges.toggles import is_badges_enabled
+from credentials.apps.plugins.constants import PROJECT_TYPE, PluginSettings, PluginURLs, SettingsType
 
 
-class CredlyBadgesConfig(AppConfig):
+class CredlyBadgesConfig(BadgesAppConfig):
+    """
+    Credly distribution backend.
+
+    This app is the Credential service plugin.
+    It is built on the top of the `credentials.apps.badges`.
+    It allows configuration and issuance specific to the Credly (by Pearson) badges from Open edX.
+
+    In addition in a context of Credly Organization:
+    - organization badge templates are used to setup Open edX badge templates;
+    - earned badges are distributed to the Credly service;
+    """
     name = "credly_badges"
-    verbose_name = "Credly Badges"
+    plugin_label = "Credly (by Pearson)"
 
     plugin_app = {
         PluginURLs.CONFIG: {
@@ -26,4 +33,12 @@ class CredlyBadgesConfig(AppConfig):
                 SettingsType.TEST: {PluginSettings.RELATIVE_PATH: 'settings.test'},
             },
         }
-    }
+    } if is_badges_enabled() else {} # TODO: improve this
+
+    def ready(self):
+        """
+        Activate installed badges plugins if they are enabled.
+
+        Performs initial registrations for checks, signals, etc.
+        """
+        super().ready()

credentials/apps/badges/distribution/credly/credly_badges/models.py

@@ -1,3 +1,16 @@
 """
 Credly Badges DB models.
 """
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+from django_extensions.db.models import TimeStampedModel
+
+
+class CredlyOrganization(TimeStampedModel):
+    """
+    Credly organization configuration.
+    """
+    uuid = models.UUIDField(unique=True, help_text=_('Unique organization ID.'))
+    name = models.CharField(max_length=255, help_text=_('Organization display name.'))
+    api_key = models.CharField(max_length=255, help_text=_('Credly API shared secret for organization.'))

credentials/apps/badges/distribution/credly/credly_badges/rest_api.py

@@ -1,10 +1,10 @@
 import base64
 import logging
-from attrs import asdict
 from functools import lru_cache
 from urllib.parse import urljoin
 
 import requests
+from attrs import asdict
 from django.conf import settings
 from requests.packages.urllib3.exceptions import HTTPError
 

credentials/apps/badges/distribution/credly/credly_badges/settings/production.py

@@ -3,4 +3,4 @@
 """
 
 def plugin_settings(settings):  # pylint: disable=unused-argument
-    pass
+    settings.CREDLY_API_BASE_URL = 'https://api.credly.com/v1/'

credentials/apps/badges/distribution/credly/credly_badges/urls.py

@@ -1,4 +1,12 @@
 """
 Credly Badges routing configuration.
 """
+
+from credentials.apps.badges.toggles import is_badges_enabled
+
 urlpatterns = []
+
+if is_badges_enabled():
+    urlpatterns = [
+        # Define urls here
+    ]

credentials/apps/badges/distribution/credly/pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 dynamic = ["version", "dependencies", "optional-dependencies"]
 
 [project.entry-points."credentials.djangoapp"]
-credly_badges = "credly_badges.apps:CredlyBadgesConfig"
+badges = "credly_badges.apps:CredlyBadgesConfig"
 
 [project.urls]
 Repository = "https://github.com/openedx/credentials.git"
@@ -37,7 +37,7 @@ packages = ["credly_badges"]
 
 [tool.setuptools.dynamic]
 version = { attr = "credly_badges.__version__" }
-dependencies = { file = "requirements/base.in" }
+dependencies = { file = "requirements/base.txt" }
 
 [tool.ruff]
 # https://docs.astral.sh/ruff/configuration/

credentials/apps/badges/distribution/credly/requirements/base.in

@@ -1,2 +1 @@
 # Main requirements of the plugin application.
--c constraints.txt