Added additional checks for boards and images

.github/workflows/build.yml

@@ -43,8 +43,11 @@ jobs:
         gem install bundler:1.17.3
         bundle install --full-index
         pip install python-frontmatter
-    - name: Check feature names
-      run: python3 check-features.py
+        pip install pillow
+    - name: Check feature names and other data
+      run: python3 check-boards.py
+    - name: Check Image Dimensions
+      run: python3 check-images.py
     - name: Build site with jekyll
       run: |
         bundle exec jekyll build -d build

_board/Seeed_XIAO_nRF52840_Sense.md

@@ -7,6 +7,7 @@ manufacturer: "SEEED"
 board_url: "https://www.seeedstudio.com/Seeed-XIAO-BLE-Sense-nRF52840-p-5253.html"
 board_image: "Seeed_XIAO_nRF52840_Sense.jpg"
 date_added: 2021-12-29
+family: nrf52840
 downloads_display: true
 
 

_board/diodes_delight_piunora.md

@@ -8,6 +8,7 @@ board_url: "https://www.crowdsupply.com/diodes-delight/piunora"
 board_image: "diodes_delight_piunora.jpg"
 download_instructions: 
 date_added: 2021-2-14
+family: raspberrypi
 features:
   - Wi-Fi
   - Bluetooth/BTLE

_board/dynalora_usb.md

@@ -6,7 +6,7 @@ name: "DynaLoRa-USB"
 manufacturer: "BH Dynamics"
 board_url: "https://github.com/BHDynamics/rfm_radio_dongle"
 board_image: "dynalora_usb.jpg"
-date_added:
+date_added: 2021-02-11
 family: atmel-samd
 features:
   - LoRa/Radio

_board/dynossat_edu_eps.md

@@ -6,7 +6,7 @@ name: "DynOSSAT-EDU EPS"
 manufacturer: "BH Dynamics"
 board_url: "https://bhdyn.com/newspace"
 board_image: "dynossat_edu_eps.jpg"
-date_added:
+date_added: 2020-10-16
 family: atmel-samd
 downloads_display: true
 

_board/dynossat_edu_obc.md

@@ -6,7 +6,7 @@ name: "DynOSSAT-EDU OBC"
 manufacturer: "BH Dynamics"
 board_url: "https://bhdyn.com/newspace"
 board_image: "dynossat_edu_obc.jpg"
-date_added:
+date_added: 2020-10-16
 family: atmel-samd
 downloads_display: true
 

_board/elecfreaks_picoed.md

@@ -7,6 +7,7 @@ manufacturer: "ELECFREAKS"
 board_url: "https://www.elecfreaks.com/picoed.html"
 board_image: "elecfreaks_picoed.jpg"
 date_added: 2022-4-21
+family: raspberrypi
 features:
   - Speaker
   - Display

_board/lilygo_ttgo_t8_s2.md

@@ -6,7 +6,7 @@ name: "TTGO T8 ESP32-S2"
 manufacturer: "LILYGO"
 board_url: "http://www.lilygo.cn/prod_view.aspx?TypeId=50033&Id=1321"
 board_image: "lilygo_ttgo_t8_s2.jpg"
-date_added:
+date_added: 2022-03-09
 family: esp32s2
 bootloader_id: lilygo_ttgo_t8_s2
 features:

_board/lilygo_ttgo_t8_s2_st7789.md

@@ -6,7 +6,7 @@ name: "TTGO T8 ESP32-S2 ST7789"
 manufacturer: "LILYGO"
 board_url: "http://www.lilygo.cn/prod_view.aspx?TypeId=50033&Id=1321"
 board_image: "lilygo_ttgo_t8_s2_st7789.jpg"
-date_added:
+date_added: 2021-02-14
 family: esp32s2
 bootloader_id: lilygo_ttgo_t8_s2_st7789
 features:

_board/mixgo_ce_serial.md

@@ -7,6 +7,7 @@ manufacturer: "Mixly"
 board_url: "https://mixly.org/"
 board_image: "mixgo_ce_serial.jpg"
 date_added: 2022-5-22
+family: esp32s2
 features:
   - Display
   - Wi-Fi

_board/mixgo_ce_udisk.md

@@ -7,6 +7,7 @@ manufacturer: "Mixly"
 board_url: "https://mixly.org/"
 board_image: "mixgo_ce_udisk.jpg"
 date_added: 2022-5-1
+family: esp32s2
 features:
   - Display
   - Wi-Fi

_board/pycubed_mram_v05.md

@@ -7,7 +7,9 @@ manufacturer: "PyCubed.org"
 board_url: "https://pycubed.org/"
 board_image: "pycubed_v05.jpg"
 date_added: 2021-9-12
+family: atmel-samd
 features:
+
 ---
 
 ### ⭐ Double-check the your PyCubed board version before updating firmware.

_board/pycubed_v05.md

@@ -7,7 +7,9 @@ manufacturer: "PyCubed.org"
 board_url: "https://pycubed.org/"
 board_image: "pycubed_v05.jpg"
 date_added: 2021-9-12
+family: atmel-samd
 features:
+
 ---
 
 ### ⭐ Double-check the your PyCubed board version before updating firmware.

_board/raspberrypi_cm4.md

@@ -7,6 +7,7 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/compute-module-4/"
 board_image: "raspberry_pi_cm4.jpg"
 date_added: 2022-1-4
+family: raspberrypi
 
 ---
 

_board/raspberrypi_cm4io.md

@@ -7,6 +7,7 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/compute-module-4-io-board/"
 board_image: "raspberrypi_cm4io.jpg"
 date_added: 2021-11-29
+family: raspberrypi
 
 ---
 

_board/raspberrypi_pi4b.md

@@ -7,6 +7,8 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/raspberry-pi-4-model-b/"
 board_image: "raspberry_pi_4b.jpg"
 date_added: 2021-11-29
+family: raspberrypi
+
 ---
 
 **NOTE**: Not all features are supported in CircuitPython.

_board/raspberrypi_zero.md

@@ -7,7 +7,9 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/raspberry-pi-zero/"
 board_image: "raspberry_pi_zero.jpg"
 date_added: 2022-2-14
+family: raspberrypi
 features:
+
 ---
 
 **NOTE**: Not all features are supported in CircuitPython.

_board/raspberrypi_zero2w.md

@@ -7,6 +7,8 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/"
 board_image: "raspberry_pi_zero_2_w.jpg"
 date_added: 2021-11-29
+family: raspberrypi
+
 ---
 
 **NOTE**: Not all features are supported in CircuitPython.

_board/raspberrypi_zero_w.md

@@ -7,6 +7,8 @@ manufacturer: "Raspberry Pi"
 board_url: "https://www.raspberrypi.com/products/raspberry-pi-zero-w/"
 board_image: "raspberry_pi_zero_w.jpg"
 date_added: 2022-01-07
+family: raspberrypi
+
 ---
 
 **NOTE**: Not all features are supported in CircuitPython.

_board/seeeduino_xiao_rp2040.md

@@ -7,7 +7,7 @@ manufacturer: "SEEED"
 board_url: "https://www.seeedstudio.com/XIAO-RP2040-v1-0-p-5026.html"
 board_image: "seeeduino_xiao_rp2040.jpg"
 date_added: 2022-1-4
-
+family: raspberrypi
 features:
   - Breadboard-Friendly
   - Robotics

_board/swan_r5.md

@@ -7,6 +7,7 @@ manufacturer: "Blues Wireless"
 board_url: "https://blues.io/products/swan"
 board_image: "swan_r5.jpg"
 date_added: 2021-9-29
+family: stm
 features:
   - Feather-Compatible
   - Battery Charging

_board/waveshare_rp2040_zero.md

@@ -7,10 +7,10 @@ manufacturer: "Waveshare"
 board_url: "https://www.waveshare.com/rp2040-zero.htm"
 board_image: "waveshare_rp2040_zero.jpg"
 date_added: "2022-1-12"
+family: raspberrypi
 features:
   - USB-C
   - Breadboard-Friendly
-
 ---
 
 a Pico-like MCU board based on Raspberry Pi RP2040

_board/wiznet_w5100s_evb_pico.md

@@ -7,6 +7,7 @@ manufacturer: "WIZnet"
 board_url: "https://www.wiznet.io/product-item/w5100s-evb-pico/"
 board_image: "w5100s-evb-pico.jpg"
 date_added: 2022-4-26
+family: raspberrypi
 features:
     - Breadboard-Friendly
 ---

_data/bootloaders.json

@@ -1,7 +1,7 @@
 {
     "bootloaders": {
         "nrf52840": {
-            "version": "0.6.3"
+            "version": "0.6.4"
         },
         "atmel-samd": {
             "version": "v3.14.0"
@@ -15,6 +15,8 @@
         "esp32c3": {},
         "stm": {},
         "cxd56": {},
-        "mimxrt10xx": {}
+        "mimxrt10xx": {},
+        "raspberrypi": {},
+        "litex": {}
     }
 }

check-boards.py

@@ -0,0 +1,127 @@
+#!/usr/bin/python3
+import json
+import re
+from pathlib import Path
+import frontmatter
+from dateutil.parser import parse
+
+# Check CircuitPython Download Features
+with open('template.md', "rt") as f:
+    metadata, content = frontmatter.parse(f.read())
+    acceptable_features = set(metadata['features'])
+
+def valid_date(date):
+    date = str(date)
+    if date:
+        try:
+            parse(date)
+            return True
+        except:
+            return False
+    return False
+
+def verify_features(folder, valid_features):
+    valid = True
+    for filename in Path(folder).glob("*.md"):
+        with open(filename, "rt") as f:
+            metadata, _ = frontmatter.parse(f.read())
+        downloads_display = metadata.get('downloads_display')
+        if downloads_display is None or downloads_display:
+            board_id = metadata.get('board_id')
+            if board_id == "unknown":
+                continue
+            features = metadata.get('features') or ()
+            for feature in sorted(set(features) - valid_features):
+                print(f"{filename}:0: Non-standard feature: {feature}")
+                valid = False
+    return valid
+
+def verify_family(folder):
+    valid = True
+    bl_file = open('./_data/bootloaders.json')
+    bootloaders = json.load(bl_file)
+    valid_bootloaders = bootloaders["bootloaders"].keys()
+    for filename in Path(folder).glob("*.md"):
+        with open(filename, "rt") as f:
+            metadata, _ = frontmatter.parse(f.read())
+        downloads_display = metadata.get('downloads_display')
+        if downloads_display is None or downloads_display:
+            board_id = metadata.get('board_id') or ()
+            if board_id == "unknown":
+                continue
+            family = metadata.get('family')
+            if family is None:
+                print(f"Family field is missing for {board_id}")
+                valid = False
+            elif family not in valid_bootloaders:
+                print(f"Family field value of {family} for {board_id} is invalid.")
+                valid = False
+    bl_file.close()
+    return valid
+
+def verify_date_added(folder):
+    valid = True
+    for filename in Path(folder).glob("*.md"):
+        with open(filename, "rt") as f:
+            metadata, _ = frontmatter.parse(f.read())
+        downloads_display = metadata.get('downloads_display')
+        if downloads_display is None or downloads_display:
+            board_id = metadata.get('board_id') or ()
+            if board_id == "unknown":
+                continue
+            date_added = metadata.get('date_added')
+            if date_added is None:
+                print(f"date_added field is missing for {board_id}")
+                valid = False
+            elif not valid_date(date_added):
+                print(f"{date_added} is an invalid date for {board_id}")
+                valid = False
+    return valid
+
+def verify_contribute_not_present(folder):
+    valid = True
+    contribute = re.compile(r".*\n## Contribute", re.MULTILINE | re.DOTALL)
+    for filename in Path(folder).glob("*.md"):
+        with open(filename, "rt") as f:
+            metadata, content = frontmatter.parse(f.read())
+        board_id = metadata.get('board_id') or ()
+        result = contribute.match(content)
+        if result is not None:
+            print(f"Contribute Section found for {board_id} in {folder}")
+    return valid
+
+if not verify_features("_board", acceptable_features):
+    print("Non-standard features found. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-downloads for acceptable features")
+    raise SystemExit(True)
+ 
+# Check Blinka Download Features
+blinka_features = {
+    "Ethernet",
+    "HDMI",
+    "Wi-Fi",
+    "40-pin GPIO",
+    "GPS",
+    "Feather-Compatible",
+    "Bluetooth/BLE",
+    "STEMMA QT/QWIIC",
+    "USB 3.0",
+    "Infrared Receiver",
+}
+
+if not verify_features("_blinka", blinka_features):
+    print("Non-standard features found. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-blinka for acceptable features")
+    raise SystemExit(True)
+
+if not verify_family("_board"):
+    print("Family or not found or invalid value. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-downloads for details")
+    raise SystemExit(True)
+
+if not verify_date_added("_board") or not verify_date_added("blinka"):
+    print("Date Added field not found or invalid value. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-downloads for details")
+    raise SystemExit(True)
+
+if not verify_contribute_not_present("_board") or not verify_contribute_not_present("blinka"):
+    print("Contribute section found. This should not be there since it is automatically added.")
+    raise SystemExit(True)
+
+raise SystemExit(False)

check-features.py

@@ -1,43 +0,0 @@
-#!/usr/bin/python3
-from pathlib import Path
-import frontmatter
-
-# Check CircuitPython Download Features
-with open('template.md', "rt") as f:
-    metadata, content = frontmatter.parse(f.read())
-    acceptable_features = set(metadata['features'])
-
-def verify_features(folder, valid_features):
-    success = True
-    for filename in Path(folder).glob("*.md"):
-        with open(filename, "rt") as f:
-            metadata, content = frontmatter.parse(f.read())
-        features = metadata.get('features') or ()
-        for feature in sorted(set(features) - valid_features):
-            print(f"{filename}:0: Non-standard feature: {feature}")
-            success = False
-    return success
-
-if not verify_features("_board", acceptable_features):
-    print("Non-standard features found. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-downloads for acceptable features")
-    raise SystemExit(True)
-
-# Check Blinka Download Features
-blinka_features = {
-    "Ethernet",
-    "HDMI",
-    "Wi-Fi",
-    "40-pin GPIO",
-    "GPS",
-    "Feather-Compatible",
-    "Bluetooth/BLE",
-    "STEMMA QT/QWIIC",
-    "USB 3.0",
-    "Infrared Receiver",
-}
-
-failed = not verify_features("_blinka", blinka_features)
-if failed:
-    print("Non-standard features found. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/adding-to-blinka for acceptable features")
-
-raise SystemExit(failed)

check-images.py

@@ -0,0 +1,81 @@
+#!/usr/bin/python3
+import os
+from pathlib import Path
+import frontmatter
+from PIL import Image
+
+MIN_ACCEPTABLE_RATIO = 0.75   # HEIGHT / WIDTH
+MAX_ACCEPTABLE_RATIO = 0.8
+SMALL_IMAGE_MIN_WIDTH = 292
+SMALL_IMAGE_MAX_WIDTH = 800
+LARGE_IMAGE_MIN_WIDTH = 590
+REQUIRE_ORIGINAL_IMAGE = True
+
+BOARD_IMAGE_PATH = "./assets/images/boards/"
+SMALL_IMAGE_PATH = BOARD_IMAGE_PATH + "small/"
+LARGE_IMAGE_PATH = BOARD_IMAGE_PATH + "large/"
+ORIGINAL_IMAGE_PATH = BOARD_IMAGE_PATH + "original/"
+
+def verify_images(folder):
+    valid = True
+    for filename in sorted(Path(folder).glob("*.md")):
+        with open(filename, "rt") as f:
+            metadata, _ = frontmatter.parse(f.read())
+        downloads_display = metadata.get('downloads_display')
+        if downloads_display is None or downloads_display:
+            board_image = metadata.get('board_image') or ()
+            board_id = metadata.get('board_id') or ()
+            if board_id == "unknown":
+                continue
+            # Small Image
+            small_image_found = os.path.exists(SMALL_IMAGE_PATH + board_image)
+            if small_image_found:
+                img = Image.open(SMALL_IMAGE_PATH + board_image)
+                if not verify_image_size(SMALL_IMAGE_PATH + board_image, SMALL_IMAGE_MIN_WIDTH, SMALL_IMAGE_MAX_WIDTH):
+                    valid = False
+            large_image_found = os.path.exists(LARGE_IMAGE_PATH + board_image)
+            if large_image_found:
+                if not verify_image_size(LARGE_IMAGE_PATH + board_image, LARGE_IMAGE_MIN_WIDTH):
+                    valid = False
+                img.close()
+            sized_images_missing = not small_image_found and not large_image_found
+            if REQUIRE_ORIGINAL_IMAGE or sized_images_missing:
+                if os.path.exists(ORIGINAL_IMAGE_PATH + board_image):
+                    img = Image.open(ORIGINAL_IMAGE_PATH + board_image)
+                    if not verify_image_size(ORIGINAL_IMAGE_PATH + board_image, LARGE_IMAGE_MIN_WIDTH, check_ratio=sized_images_missing):
+                        valid = False
+                    img.close()
+                else:
+                    if sized_images_missing:
+                        print(f"No images found for {board_id}")
+                    else:
+                        print(f"Original image {ORIGINAL_IMAGE_PATH + board_image} not found for {board_id}.")
+                    valid = False
+    return valid
+
+def verify_image_size(image_path, min_width, max_width=None, check_ratio=True):
+    valid = True
+    img = Image.open(image_path)
+    width, height = img.size
+    min_height = int(min_width * MIN_ACCEPTABLE_RATIO)
+    if width < min_width:
+        print(f"Image file {image_path} is too narrow ({width} x {height}). It should be at least {min_width} x {min_height} pixels.")
+        valid = False
+    elif (max_width and width > max_width):
+        max_height = int(max_width * MAX_ACCEPTABLE_RATIO)
+        print(f"Image file {image_path} is too wide ({width} x {height}). It should be no larger than {max_width} x {max_height} pixels.")
+        valid = False
+    elif check_ratio and height / width < MIN_ACCEPTABLE_RATIO:
+        print(f"Ratio for image file {image_path} is too wide ({width} x {height}). Try reducing width or increasing height.")
+        valid = False
+    elif check_ratio and height / width > MAX_ACCEPTABLE_RATIO:
+        print(f"Ratio for image file {image_path} is too tall ({width} x {height}). Try reducing height or increasing width.")
+        valid = False
+    img.close()
+    return valid
+
+success = verify_images("_board") and verify_images("_blinka")
+if not success:
+    print("Missing images or images that do not meet requirements found. See https://learn.adafruit.com/how-to-add-a-new-board-to-the-circuitpython-org-website/preparing-the-images for images acceptable sizes.")
+
+raise SystemExit(not success)