Order of tools and categories is now directly tied to the order in the whitelist.

Author: Thetwam

lti.py

@@ -226,7 +226,9 @@ def index(lti=lti):
     )
 
     try:
-        tools_by_category = filter_tool_list(session["course_id"], session["api_key"])
+        tools_by_category, cagetory_order = filter_tool_list(
+            session["course_id"], session["api_key"]
+        )
     except CanvasException:
         app.logger.exception("Couldn't connect to Canvas")
         return return_error(
@@ -243,6 +245,7 @@ def index(lti=lti):
     return render_template(
         "main_template.html",
         tools_by_category=tools_by_category,
+        category_order=cagetory_order,
         course=session["course_id"],
     )
 

templates/lti_list.html

@@ -44,9 +44,8 @@ <h3 class="card-title text-center">{{lti.display_name}}</h3>
 	{% endfor %}
 {% else %}
 	<div class="row">
-		<div class="col-md-8 ml-auto">
+		<div class="col-md-8 ml-auto mr-auto">
 			<p class="text-center" id="no_ltis">No LTIs available in this category.</p>
-			<hr />
 		</div>
 	</div>
 {% endif %}

templates/main_template.html

@@ -4,7 +4,7 @@
 <div class="container-fluid jump-to-section">
 	<h2>Jump to section:</h2>
 	<ul>
-		{% for category in tools_by_category %}
+		{% for category in category_order %}
 		<li><a class="btn btn-primary" href="#{{ category|slugify}}">{{ category }}</a></li>
 		{% endfor %}
 		{% include "extra_links.html" ignore missing %}
@@ -14,18 +14,16 @@ <h2>Jump to section:</h2>
 
 {% block content %}
 
-{% for category, tools in tools_by_category.items() %}
-<div class="row">
-	<div class="col-md-8 ml-auto mr-auto">
-		<h2 class="text-center section_headline" id="{{ category|slugify}}">{{ category }}</h2>
-		<hr />
+{% for category in category_order %}
+	<div class="row">
+		<div class="col-md-8 ml-auto mr-auto">
+			<h2 class="text-center section_headline" id="{{ category|slugify}}">{{ category }}</h2>
+			<hr />
+		</div>
 	</div>
-</div>
-
-{% with ltis=tools %}
-	{% include "lti_list.html" %}
-{% endwith %}
-
+	{% with ltis=tools_by_category[category] %}
+		{% include "lti_list.html" %}
+	{% endwith %}
 {% endfor %}
 
 {% include "custom_tools.html" ignore missing %}

utils.py

@@ -7,6 +7,23 @@
 import settings
 
 
+def get_tool_info(whitelist, tool_name):
+    """
+    Search the whitelist by tool name.
+
+    :returns: A dictionary , or none if no tool matching that name was found.
+    :rtype: dict or None
+    """
+    for category, category_tools in whitelist.items():
+        for tool_info in category_tools:
+            print(tool_info)
+            if tool_info.get("name") == tool_name:
+                tool_info.update({"category": category})
+                return tool_info
+
+    return None
+
+
 def filter_tool_list(course_id, access_token):
     """
     Filter tool list down to those on whitelist and sort by category.
@@ -31,38 +48,45 @@ def filter_tool_list(course_id, access_token):
 
     course = canvas.get_course(course_id)
     installed_tools = course.get_external_tools(include_parents=True)
-
     tools_by_category = defaultdict(list)
     for installed_tool in installed_tools:
-        for tool in whitelist:
-            if installed_tool.name != tool.get("name"):
-                continue
-
-            is_course_navigation = hasattr(installed_tool, "course_navigation")
-
-            if tool.get("is_launchable", False):
-                if is_course_navigation:
-                    sessionless_launch_url = installed_tool.get_sessionless_launch_url(
-                        launch_type="course_navigation"
-                    )
-                else:
-                    sessionless_launch_url = installed_tool.get_sessionless_launch_url()
-            else:
-                sessionless_launch_url = None
+        tool_info = get_tool_info(whitelist, installed_tool.name)
+        if not tool_info:
+            continue
 
-            tool_info = tool
-            tool_info.update(
-                {
-                    "id": installed_tool.id,
-                    "lti_course_navigation": is_course_navigation,
-                    "sessionless_launch_url": sessionless_launch_url,
-                    "screenshot": "screenshots/" + tool["screenshot"],
-                }
-            )
+        is_course_navigation = hasattr(installed_tool, "course_navigation")
 
-            tools_by_category[tool.get("category", "Uncategorized")].append(tool_info)
-
-    return tools_by_category
+        if tool_info.get("is_launchable", False):
+            if is_course_navigation:
+                sessionless_launch_url = installed_tool.get_sessionless_launch_url(
+                    launch_type="course_navigation"
+                )
+            else:
+                sessionless_launch_url = installed_tool.get_sessionless_launch_url()
+        else:
+            sessionless_launch_url = None
+
+        tool_info.update(
+            {
+                "id": installed_tool.id,
+                "lti_course_navigation": is_course_navigation,
+                "sessionless_launch_url": sessionless_launch_url,
+                "screenshot": "screenshots/" + tool_info["screenshot"],
+            }
+        )
+
+        tools_by_category[tool_info.get("category", "Uncategorized")].append(tool_info)
+
+    for category, tools in tools_by_category.items():
+        # Determine tool order based on order in whitelist
+        order = {
+            tool.get("display_name"): i for i, tool in enumerate(whitelist[category])
+        }
+        tools_by_category[category] = sorted(
+            tools, key=lambda k: order[k["display_name"]]
+        )
+
+    return tools_by_category, list(whitelist.keys())
 
 
 def slugify(value):

whitelist.json.template

@@ -1,15 +1,16 @@
-[
-    {
-        "display_name": "Name to Display",
-        "name": "Installed Tool Name",
-        "tool_id": "tool_id",
-        "allowed_roles": [""],
-        "desc": "Tool Description",
-        "screenshot": "screenshot.png",
-        "logo": "logo.svg",
-        "filter_by": ["all"],
-        "docs_url": "https://example.com/tool/docs/",
-        "is_launchable": true,
-        "category": "Course Tool"
-    }
-]
+{
+    "Course Tool": [
+        {
+            "display_name": "Name to Display",
+            "name": "Installed Tool Name",
+            "tool_id": "tool_id",
+            "allowed_roles": [""],
+            "desc": "Tool Description",
+            "screenshot": "screenshot.png",
+            "logo": "logo.svg",
+            "filter_by": ["all"],
+            "docs_url": "https://example.com/tool/docs/",
+            "is_launchable": true
+        }
+    ]
+}