Merge pull request #3 from jepler/subfolders

Handle projects that have sub-directories

Author: jepler

README.md

@@ -6,15 +6,13 @@ SPDX-License-Identifier: MIT
 
 This folder contains scripts that can be run to create requirement screenshots for all of the learn guide projects
 
-To use the scripts you must set `LEARN_GUIDE_REPO` inside of `get_imports.py` to point to the location of learn guide repo.
+To use the scripts you must set the environment `LEARN_GUIDE_REPO` to point to the location of learn guide repo.  It must end with a trailing slash.
 
-default value is `"../../Adafruit_Learning_System_Guides/"`
-
-One directory above the root of this repo.
+The default value is `"../Adafruit_Learning_System_Guides/"`, one directory above the root of this repo.
 
 With that pointed at a learn guide repo you can run:
 
 ```
-python create_requirement_images.py
+python3 create_requirement_images.py
 ```
 It will create images in the `generated_images` directory.

create_requirement_images.py

@@ -325,7 +325,9 @@ def make_libraries(libraries, position):
             (PADDING, PADDING + (LINE_SPACING * (7 + project_files_count))),
         )
 
-        img.save("generated_images/{}.png".format(learn_guide_project))
+        img.save(
+            "generated_images/{}.png".format(learn_guide_project.replace("/", "_"))
+        )
     except SyntaxError as exc:
         print(exc)
         traceback.print_exc()

get_imports.py

@@ -16,7 +16,7 @@
 BUNDLE_TAG = "latest_bundle_tag.json"
 
 LEARN_GUIDE_REPO = os.environ.get(
-    "LEARN_GUIDE_REPO", "../../Adafruit_Learning_System_Guides/"
+    "LEARN_GUIDE_REPO", "../Adafruit_Learning_System_Guides/"
 )
 
 SHOWN_FILETYPES = ["py", "mpy", "bmp", "pcf", "bdf", "wav", "mp3", "json", "txt"]
@@ -140,28 +140,28 @@ def get_libs_for_project(project_name):
     return found_libs
 
 
-def get_learn_guide_projects():
-    """Get the list of all folders in the learn guide"""
-    return os.listdir(LEARN_GUIDE_REPO)
-
-
 def get_learn_guide_cp_projects():
     """Get the list of all circuitpython projects, according to some heuristics"""
-    cp_projects = []
-
-    def has_py_file(location):
-        dir_files = os.listdir(location)
-        for file in dir_files:
-            if file.endswith(".py"):
-                return ".circuitpython.skip" not in dir_files
-        return False
-
-    all_projects = get_learn_guide_projects()
-    for project in all_projects:
-        project_dir = "{}/{}/".format(LEARN_GUIDE_REPO, project)
-        try:
-            if has_py_file(project_dir):
-                cp_projects.append(project)
-        except NotADirectoryError:
-            pass
-    return cp_projects
+    for dirpath, dirnames, filenames in os.walk(LEARN_GUIDE_REPO):
+        # The top-level needs special treatment
+        if dirpath == LEARN_GUIDE_REPO:
+            dirnames.remove(".git")
+            continue
+        # Skip this folder and all subfolders
+        if ".circuitpython.skip" in filenames:
+            del dirnames[:]
+            continue
+        # Skip files in this folder, but handle sub-folders
+        if ".circuitpython.skip-here" in filenames:
+            continue
+        # Do not reurse, but handle files in this folder
+        if ".circuitpython.skip-sub" in filenames:
+            del dirnames[:]
+
+        if any(f for f in filenames if f.endswith(".py")):
+            yield os.path.relpath(dirpath, LEARN_GUIDE_REPO)
+
+
+if __name__ == "__main__":
+    for p in get_learn_guide_cp_projects():
+        print("PROJECT", p)