Merge pull request #3014 from justmobilize/secrets-cleanup-p-part2

Secrets Cleanup: P Part 2

Author: FoamyGuy

CLUE/CLUE_Servo_Barometer/code.py

@@ -58,7 +58,7 @@
 
 display.root_group = group
 
-#  function to convert celcius to fahrenheit
+#  function to convert celsius to fahrenheit
 def c_to_f(temp):
     temp_f = (temp * 9/5) + 32
     return temp_f
@@ -87,12 +87,12 @@ def hpa_to_inHg(hPa):
         print(servo_value)
         #  if metric units...
         if metric_units:
-            #  update temp & pressure text in celcius and hPa
+            #  update temp & pressure text in celsius and hPa
             temp_data.text = "%0.1f ºC" % bmp280.temperature
             press_data.text = "%0.1f hPa" % bmp280.pressure
         #  if imperial units...
         else:
-            #  convert celcius to fahrenheit
+            #  convert celsius to fahrenheit
             temp_fahrenheit = c_to_f(bmp280.temperature)
             #  convert hPa to inHg
             pressure_inHg = hpa_to_inHg(bmp280.pressure)

GemmaM0_Headband/code.py

@@ -23,7 +23,7 @@
 # For the Gemma M0 onboard DotStar LED
 dotstar = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)
 
-def deg_f(deg_c):  # Convert Celcius to Fahrenheit
+def deg_f(deg_c):  # Convert celsius to Fahrenheit
     return(deg_c * 9 / 5) + 32.0
 
 while True:

PicoW_CircuitPython_HTTP_Server/code.py

@@ -37,7 +37,7 @@
 # scan for temp sensor
 ds18 = DS18X20(ow_bus, ow_bus.scan()[0])
 
-#  function to convert celcius to fahrenheit
+#  function to convert celsius to fahrenheit
 def c_to_f(temp):
     temp_f = (temp * 9/5) + 32
     return temp_f

PyPortal/PyPortal_Alarm_Clock/code.py

@@ -85,7 +85,7 @@
 
 icon_file = None
 icon_sprite = None
-celcius = getenv('celcius')
+celsius = getenv('celsius')
 
 # display/data refresh timers
 
@@ -294,7 +294,7 @@ def tick(self, now):
                     self.weather_icon.append(icon_sprite)
 
                 temperature = weather['main']['temp'] - 273.15 # its...in kelvin
-                if celcius:
+                if celsius:
                     temperature_text = '%3d C' % round(temperature)
                 else:
                     temperature_text = '%3d F' % round(((temperature * 9 / 5) + 32))

PyPortal/PyPortal_LIFX_Controller/code.py

@@ -9,7 +9,8 @@
 
 Brent Rubell for Adafruit Industries, 2019
 """
-import os
+
+from os import getenv
 
 import board
 import displayio
@@ -26,19 +27,26 @@
 # import lifx library
 import adafruit_lifx
 
-secrets = {
-  "ssid" : os.getenv("CIRCUITPY_WIFI_SSID"),
-  "password" : os.getenv("CIRCUITPY_WIFI_PASSWORD"),
-}
+# Get WiFi details, ensure these are setup in settings.toml
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+
+if None in [ssid, password]:
+    raise RuntimeError(
+        "WiFi settings are kept in settings.toml, "
+        "please add them there. The settings file must contain "
+        "'CIRCUITPY_WIFI_SSID', 'CIRCUITPY_WIFI_PASSWORD', "
+        "at a minimum."
+    )
 
 # ESP32 SPI
 esp32_cs = DigitalInOut(board.ESP_CS)
 esp32_ready = DigitalInOut(board.ESP_BUSY)
 esp32_reset = DigitalInOut(board.ESP_RESET)
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
-status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
-wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
+wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel)
 
 # These pins are used as both analog and digital! XL, XR and YU must be analog
 # and digital capable. YD just need to be digital
@@ -49,7 +57,7 @@
 
 # Set this to your LIFX personal access token in settings.toml
 # (to obtain a token, visit: https://cloud.lifx.com/settings)
-lifx_token = os.getenv("LIFX_TOKEN")
+lifx_token = getenv("LIFX_TOKEN")
 
 # Initialize the LIFX API Helper
 lifx = adafruit_lifx.LIFX(wifi, lifx_token)

PyPortal/PyPortal_LastFM/code.py

@@ -7,26 +7,35 @@
 and display it on a screen
 If you can find something that spits out JSON data, we can display it!
 """
+
+from os import getenv
 import time
 import board
 from adafruit_pyportal import PyPortal
 
-# Get wifi details and more from a secrets.py file
-try:
-    from secrets import secrets
-except ImportError:
-    print("WiFi secrets are kept in secrets.py, please add them there!")
-    raise
+# Get WiFi details, ensure these are setup in settings.toml
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+
+if None in [ssid, password]:
+    raise RuntimeError(
+        "WiFi settings are kept in settings.toml, "
+        "please add them there. The settings file must contain "
+        "'CIRCUITPY_WIFI_SSID', 'CIRCUITPY_WIFI_PASSWORD', "
+        "at a minimum."
+    )
 
 # Set up where we'll be fetching data from
 DATA_SOURCE = "http://ws.audioscrobbler.com/2.0/?method=user.getrecenttracks&limit=1&format=json"
 CAPTION = "www.last.fm/user"
 # If we have an access token, we can query more often
-if 'lfm_username' in secrets:
-    DATA_SOURCE += "&user="+secrets['lfm_username']
-    CAPTION += "/"+secrets['lfm_username']
-if 'lfm_key' in secrets:
-    DATA_SOURCE += "&api_key="+secrets['lfm_key']
+lfm_username = getenv("lfm_username")
+lfm_key = getenv("lfm_key")
+if lfm_username:
+    DATA_SOURCE += "&user=" + lfm_username
+    CAPTION += "/" + lfm_username
+if lfm_key:
+    DATA_SOURCE += "&api_key=" + lfm_key
 print(DATA_SOURCE)
 
 # Total number of plays

PyPortal/PyPortal_LeagueLevel/code.py

@@ -5,20 +5,33 @@
 """
 This project will access the League of Legends API, grab a Summoner's Level
 and display it on a screen.
-You'll need a Riot API key in your secrets.py file
+You'll need a Riot API key in your settings.toml file
 If you can find something that spits out JSON data, we can display it!
 """
-import os
+
+from os import getenv
 import time
 import board
 from adafruit_pyportal import PyPortal
 
+# Get WiFi details, ensure these are setup in settings.toml
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+
+if None in [ssid, password]:
+    raise RuntimeError(
+        "WiFi settings are kept in settings.toml, "
+        "please add them there. The settings file must contain "
+        "'CIRCUITPY_WIFI_SSID', 'CIRCUITPY_WIFI_PASSWORD', "
+        "at a minimum."
+    )
+
 #Choose a valid Summoner name
 SUMMONER_NAME = "RiotSchmick"
 
 # Set up where we'll be fetching data from
 DATA_SOURCE = "https://na1.api.riotgames.com/lol/summoner/v4/summoners/by-name/"+SUMMONER_NAME
-DATA_SOURCE += "?api_key=" + os.getenv("LEAGUE_TOKEN")
+DATA_SOURCE += "?api_key=" + getenv("LEAGUE_TOKEN")
 DATA_LOCATION = ["summonerLevel"]
 CAPTION = "SUMMONER  "+SUMMONER_NAME
 

PyPortal/PyPortal_MQTT_Control/code.py

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 
+from os import getenv
 import board
 import displayio
 import busio
@@ -18,14 +19,19 @@
 import adafruit_touchscreen
 import adafruit_minimqtt.adafruit_minimqtt as MQTT
 
-# ------------- WiFi ------------- #
+# Get WiFi details, ensure these are setup in settings.toml
+ssid = getenv("CIRCUITPY_WIFI_SSID")
+password = getenv("CIRCUITPY_WIFI_PASSWORD")
+
+if None in [ssid, password]:
+    raise RuntimeError(
+        "WiFi settings are kept in settings.toml, "
+        "please add them there. The settings file must contain "
+        "'CIRCUITPY_WIFI_SSID', 'CIRCUITPY_WIFI_PASSWORD', "
+        "at a minimum."
+    )
 
-# Get wifi details and more from a secrets.py file
-try:
-    from secrets import secrets
-except ImportError:
-    print("WiFi secrets are kept in secrets.py, please add them there!")
-    raise
+# ------------- WiFi ------------- #
 
 # If you are using a board with pre-defined ESP32 Pins:
 esp32_cs = DigitalInOut(board.ESP_CS)
@@ -34,8 +40,8 @@
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
-status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
-wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2)
+wifi = adafruit_esp32spi_wifimanager.WiFiManager(esp, ssid, password, status_pixel=status_pixel)
 
 # ------- Sensor Setup ------- #
 # init. the temperature sensor
@@ -234,10 +240,10 @@ def message(client, topic, message):
 
 # Set up a MiniMQTT Client
 client = MQTT.MQTT(
-    broker=secrets["broker"],
+    broker=getenv("mqtt_broker"),
     port=1883,
-    username=secrets["user"],
-    password=secrets["pass"],
+    username=getenv("mqtt_username"),
+    password=getenv("mqtt_password"),
     socket_pool=pool,
     ssl_context=ssl_context,
 )

PyPortal/PyPortal_MQTT_Control/secrets.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2020 Anne Barela for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+# This file is where you keep private settings, passwords, and tokens!
+# If you put them in the code you risk committing that info or sharing it
+
+CIRCUITPY_WIFI_SSID="your-wifi-ssid"
+CIRCUITPY_WIFI_PASSWORD="your-wifi-password"
+mqtt_broker="your-mqtt-broker-url-or-ip"
+mqtt_username="your-mqtt-broker-username"
+mqtt_password="your-mqtt-broker-password"