Merge pull request #14 from FoamyGuy/settings_toml

add settings.toml to the rendered screenshots if needed.

Author: kattni

create_requirement_images.py

@@ -23,6 +23,7 @@
     get_files_for_example,
     get_learn_guide_cp_projects,
 )
+from settings_required import settings_required
 
 os.makedirs("generated_images", exist_ok=True)
 
@@ -66,6 +67,7 @@ def asset_path(asset_name):
     "py": file_icon,
     "mpy": file_icon,
     "txt": file_empty_icon,
+    "toml": file_icon,
     "bmp": file_image_icon,
     "wav": file_music_icon,
     "mp3": file_music_icon,
@@ -78,15 +80,17 @@ def asset_path(asset_name):
 }
 
 # If this is not done, the images fail to load in the subprocesses.
-for file_icon in FILE_TYPE_ICON_MAP.values():
-    file_icon.load()
+for _file_icon in FILE_TYPE_ICON_MAP.values():
+    _file_icon.load()
 
 
 def generate_requirement_image(
     project_files, libs, image_name
-):  # pylint: disable=too-many-statements
+):  # pylint: disable=too-many-statements, too-many-locals
     """Generate a single requirement image"""
 
+    context = {"added_settings_toml": False}
+
     def make_line(
         requirement_name, position=(0, 0), icon=None, hidden=False, triangle_icon=None
     ):  # pylint: disable=too-many-branches
@@ -159,7 +163,8 @@ def make_line(
                 font=font,
             )
 
-    def make_header(position, project_files):
+    def make_header(position, project_files, files_and_libs):
+        # pylint: disable=too-many-locals
         # Static files
         make_line(
             "CIRCUITPY",
@@ -194,6 +199,21 @@ def make_header(position, project_files):
             icon=file_icon,
         )
 
+        # TODO: Add settings.toml if it's needed
+
+        if settings_required(files_and_libs):
+            make_line(
+                "settings.toml",
+                (position[0] + INDENT_SIZE * 2, position[1] + (LINE_SPACING * 6)),
+                icon=file_icon,
+            )
+            context["added_settings_toml"] = True
+
+            if project_files:
+                print(image_name)
+                print(project_files)
+                print("=============")
+
         # dynamic files from project dir in learn guide repo
         rows_added = 0
         project_files_to_draw = []
@@ -210,13 +230,18 @@ def make_header(position, project_files):
                 if ".circuitpython.skip-screenshot" not in cur_file[1]:
                     project_folders_to_draw[cur_file[0]] = cur_file[1]
 
+        begin_y_offset = 7 if context["added_settings_toml"] else 6
         for i, file in enumerate(sorted(project_files_to_draw)):
             cur_file_extension = file.split(".")[-1]
 
             cur_file_icon = FILE_TYPE_ICON_MAP.get(cur_file_extension, file_empty_icon)
+
             make_line(
                 file,
-                (position[0] + INDENT_SIZE * 2, position[1] + (LINE_SPACING * (6 + i))),
+                (
+                    position[0] + INDENT_SIZE * 2,
+                    position[1] + (LINE_SPACING * (begin_y_offset + i)),
+                ),
                 icon=cur_file_icon,
             )
             rows_added += 1
@@ -229,7 +254,8 @@ def make_header(position, project_files):
                     position[0] + INDENT_SIZE * 2,
                     position[1]
                     + (
-                        LINE_SPACING * (6 + i + len(project_files_to_draw) + extra_rows)
+                        LINE_SPACING
+                        * (begin_y_offset + i + len(project_files_to_draw) + extra_rows)
                     ),
                 ),
                 triangle_icon=down_triangle,
@@ -246,7 +272,7 @@ def make_header(position, project_files):
                     sub_file,
                     (
                         position[0] + INDENT_SIZE * 3,
-                        position[1] + (LINE_SPACING * (6 + rows_added)),
+                        position[1] + (LINE_SPACING * (begin_y_offset + rows_added)),
                     ),
                     triangle_icon=triangle_icon,
                     icon=cur_file_icon,
@@ -257,7 +283,7 @@ def make_header(position, project_files):
             "lib",
             (
                 position[0] + INDENT_SIZE * 2,
-                position[1] + (LINE_SPACING * (5 + rows_added + 1)),
+                position[1] + (LINE_SPACING * ((begin_y_offset - 1) + rows_added + 1)),
             ),
             triangle_icon=down_triangle,
         )
@@ -333,11 +359,20 @@ def make_libraries(libraries, position):
                 triangle_icon = right_triangle
             make_line(
                 lib_name,
-                (position[0] + INDENT_SIZE * 3, position[1] + (LINE_SPACING * i)),
+                (
+                    position[0] + INDENT_SIZE * 3,
+                    position[1]
+                    + (
+                        LINE_SPACING
+                        * (i + (1 if context["added_settings_toml"] else 0))
+                    ),
+                ),
                 triangle_icon=triangle_icon,
             )
 
     final_list_to_render = sort_libraries(libs)
+    if settings_required(final_list_to_render):
+        context["added_settings_toml"] = True
 
     if "code.py" in project_files:
         project_files.remove("code.py")
@@ -352,16 +387,20 @@ def make_libraries(libraries, position):
         + 7 * LINE_SPACING
         + len(final_list_to_render) * LINE_SPACING
         + (project_files_count) * LINE_SPACING
+        + (1 if context["added_settings_toml"] else 0) * LINE_SPACING
     )
     img = Image.new("RGB", (OUT_WIDTH, image_height), "#303030")
     draw = ImageDraw.Draw(img)
 
     make_background_highlights(
-        7 + len(final_list_to_render) + project_files_count,
+        7
+        + len(final_list_to_render)
+        + project_files_count
+        + (1 if context["added_settings_toml"] else 0),
         offset=(PADDING, PADDING),
     )
-
-    make_header((PADDING, PADDING), project_files)
+    print(f"fltr: {final_list_to_render}")
+    make_header((PADDING, PADDING), project_files, final_list_to_render)
     make_libraries(
         final_list_to_render,
         (PADDING, PADDING + (LINE_SPACING * (7 + project_files_count))),

settings_required.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2023 Tim C
+# SPDX-License-Identifier: MIT
+
+"""
+Utility function to check whether settings.toml file should be rendered for a project.
+Based on whether it uses certain libraries or not.
+"""
+
+
+LIBRARIES_THAT_REQUIRE_SETTINGS = [
+    "adafruit_requests.mpy",
+    "adafruit_esp32spi",
+    "adafruit_minimqtt",
+    "adafruit_portalbase",
+    "adafruit_azureiot",
+]
+
+
+def settings_required(files_and_libs):
+    """
+    Returns True if the project needs ot have a settings.toml file
+
+    :param files_and_libs list: a List of all files and libraries used in the project
+    """
+
+    if "settings.toml" in files_and_libs:
+        # settings.toml file is already in the files so we don't need to add it again
+        return False
+
+    # if any of the libraries that require settings.toml are included in this project
+    if any(
+        libs_that_require_settings in files_and_libs
+        for libs_that_require_settings in LIBRARIES_THAT_REQUIRE_SETTINGS
+    ):
+        return True
+
+    return False