refactor

Author: Adam-D-Lewis

jhub_apps/config_utils.py

@@ -5,7 +5,7 @@
 
 from traitlets.config import SingletonConfigurable, Enum
 
-from jhub_apps.service.models import StartupApp, PinnedService
+from jhub_apps.service.models import StartupApp, AdditionalService
 
 
 # jhub-app-proxy configuration constants
@@ -139,13 +139,13 @@ class JAppsConfig(SingletonConfigurable):
     ).tag(config=True)
 
     additional_services = List(
-        trait=PydanticModelTrait(PinnedService),
+        trait=PydanticModelTrait(AdditionalService),
         description="List of additional external services to display in JupyterHub UI.",
         default_value=[],
         help="""
         List of additional external services to display in JupyterHub's services menu.
         Services with pinned=True will also appear in the quick access section.
-        Each service should be a PinnedService model instance or dict with keys:
+        Each service should be an AdditionalService model instance or dict with keys:
         name (str), url (str), description (str, optional), pinned (bool, optional),
         thumbnail (str, optional) - can be a URL or base64-encoded data URL.
 

jhub_apps/configuration.py

@@ -102,9 +102,9 @@ def install_jhub_apps(c, spawner_to_subclass, *, oauth_no_confirm=False):
 
     # Add additional services from JAppsConfig
     if japps_config.additional_services:
-        from jhub_apps.service_utils import pinned_service_to_service_dict
+        from jhub_apps.service_utils import additional_service_to_service_dict
         additional_service_dicts = [
-            pinned_service_to_service_dict(service)
+            additional_service_to_service_dict(service)
             for service in japps_config.additional_services
         ]
         c.JupyterHub.services.extend(additional_service_dicts)

jhub_apps/service/models.py

@@ -103,10 +103,11 @@ class StartupApp(ServerCreation):
     user_options: JHubAppUserOptions
 
 
-class PinnedService(BaseModel):
-    """Configuration for a pinned external service in JupyterHub.
+class AdditionalService(BaseModel):
+    """Configuration for an additional external service in JupyterHub.
 
     These services appear in the JupyterHub UI services menu.
+    Services with pinned=True also appear in the quick access section.
     """
     name: str
     url: str

jhub_apps/service_utils.py

@@ -1,7 +1,7 @@
 """Utilities for configuring JupyterHub services."""
 from typing import Dict, Any, Optional
 
-from jhub_apps.service.models import PinnedService
+from jhub_apps.service.models import AdditionalService
 
 
 def service_for_jhub_apps(
@@ -14,15 +14,16 @@ def service_for_jhub_apps(
     """Create a service configuration dict for JupyterHub services.
 
     This helper function creates the proper structure for external services
-    that appear in the JupyterHub UI services menu. It validates the input
-    using the PinnedService Pydantic model.
+    that appear in the JupyterHub UI services menu. Services with pinned=True
+    also appear in the quick access section. It validates the input using
+    the AdditionalService Pydantic model.
 
     Args:
         name: Display name of the service
         url: URL path for the service
         description: Optional description of the service
-        pinned: Whether the service should be pinned in the UI
-        thumbnail: Optional thumbnail URL or data URL for the service icon
+        pinned: Whether the service should appear in the quick access section
+        thumbnail: Optional thumbnail URL or base64-encoded data URL for the service icon
 
     Returns:
         Dictionary with JupyterHub service configuration
@@ -40,7 +41,7 @@ def service_for_jhub_apps(
         ... )
     """
     # Validate inputs using Pydantic model
-    pinned_service = PinnedService(
+    additional_service = AdditionalService(
         name=name,
         url=url,
         description=description,
@@ -49,32 +50,32 @@ def service_for_jhub_apps(
     )
 
     return {
-        "name": pinned_service.name,
+        "name": additional_service.name,
         "display": True,
         "info": {
-            "name": pinned_service.name,
-            "description": pinned_service.description,
-            "url": pinned_service.url,
+            "name": additional_service.name,
+            "description": additional_service.description,
+            "url": additional_service.url,
             "external": True,
-            "pinned": pinned_service.pinned,
-            "thumbnail": pinned_service.thumbnail,
+            "pinned": additional_service.pinned,
+            "thumbnail": additional_service.thumbnail,
         },
     }
 
 
-def pinned_service_to_service_dict(pinned_service: PinnedService) -> Dict[str, Any]:
-    """Convert a PinnedService model to a JupyterHub service dict.
+def additional_service_to_service_dict(additional_service: AdditionalService) -> Dict[str, Any]:
+    """Convert an AdditionalService model to a JupyterHub service dict.
 
     Args:
-        pinned_service: PinnedService model instance
+        additional_service: AdditionalService model instance
 
     Returns:
         Dictionary with JupyterHub service configuration
     """
     return service_for_jhub_apps(
-        name=pinned_service.name,
-        url=pinned_service.url,
-        description=pinned_service.description,
-        pinned=pinned_service.pinned,
-        thumbnail=pinned_service.thumbnail,
+        name=additional_service.name,
+        url=additional_service.url,
+        description=additional_service.description,
+        pinned=additional_service.pinned,
+        thumbnail=additional_service.thumbnail,
     )