feat: [ACI-222] feature flag for badges (#52)

credentials/apps/badges/admin.py

@@ -1,3 +1,9 @@
 """
 Admin section configuration.
 """
+
+from .toggles import is_badges_enabled
+
+if is_badges_enabled():
+    # TODO: Define registering admin classes here `admin.site.register(...)`
+    pass

credentials/apps/badges/apps.py

@@ -1,16 +1,16 @@
 from django.apps import AppConfig
 
-from .toggles import is_badges_enabled
+from .toggles import check_badges_enabled
 
 
 class BadgesConfig(AppConfig):
     name = "credentials.apps.badges"
     verbose_name = "Badges"
 
+    @check_badges_enabled
     def ready(self):
         """
         Performs initial registrations for checks, signals, etc.
         """
-        if is_badges_enabled():
-            from . import signals  # pylint: disable=unused-import,import-outside-toplevel
-            from . checks import badges_checks  # pylint: disable=unused-import,import-outside-toplevel
+        from . import signals  # pylint: disable=unused-import,import-outside-toplevel
+        from . checks import badges_checks  # pylint: disable=unused-import,import-outside-toplevel

credentials/apps/badges/toggles.py

@@ -3,7 +3,31 @@
 """
 
 
+from edx_toggles.toggles import SettingToggle
+
+# .. toggle_name: BADGES_ENABLED
+# .. toggle_implementation: DjangoSetting
+# .. toggle_default: False
+# .. toggle_description: Determines if the Credentials IDA uses badges functionality.
+# .. toggle_life_expectancy: permanent
+# .. toggle_permanent_justification: Badges are optional for usage.
+# .. toggle_creation_date: 2024-01-12
+# .. toggle_use_cases: open_edx
+ENABLE_BADGES = SettingToggle('BADGES_ENABLED', default=False, module_name=__name__)
+
+
 def is_badges_enabled():
     """
+    Checks if badges app enabled.
+    """
+    return ENABLE_BADGES.is_enabled()
+
+
+def check_badges_enabled(func):
+    """
+    Decorator for checking the applicability of a badges app.
     """
-    return True
+    def wrapper(*args, **kwargs):
+        if is_badges_enabled():
+            return func(*args, **kwargs)
+    return wrapper

credentials/apps/badges/urls.py

@@ -1,4 +1,9 @@
 """
 URLs for badges.
 """
-urlpatterns = []
+
+from .toggles import is_badges_enabled
+
+urlpatterns = [] if not is_badges_enabled else [
+    # Define urls here
+]