Add flake8 and clean up code (#6)

* Add flake8 config
* Apply flake8 suggestions
* Apply black formatting

Author: stefanthoss

poetry.lock

@@ -20,8 +20,15 @@ uvicorn = "^0.32.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.10.0"
+flake8 = "^7.1.1"
 isort = "^5.13.2"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"

pyproject.toml

@@ -0,0 +1,3 @@
+[flake8]
+ignore = E501, W503
+max-line-length = 100

setup.cfg

@@ -26,9 +26,7 @@ class MagInkDashConfig:
     LAT: float = float(os.getenv("LAT", 34.118333))
     LNG: float = float(os.getenv("LNG", -118.300333))
     WEATHER_UNITS: WeatherUnits = WeatherUnits[os.getenv("WEATHER_UNITS", "metric")]
-    NUM_DAYS_IN_TEMPLATE: int = (
-        5  # Not configurable because it's hard-coded in the HTML template
-    )
+    NUM_DAYS_IN_TEMPLATE: int = 5  # Not configurable because it's hard-coded in the HTML template
 
     def get_config():
         global _current_config

src/config.py

@@ -38,9 +38,7 @@ def get_events(self, ics_url, calStartDatetime, calEndDatetime, displayTZ, numDa
 
         for event in eventList:
             if event["isMultiday"]:
-                numDays = (
-                    event["endDatetime"].date() - event["startDatetime"].date()
-                ).days
+                numDays = (event["endDatetime"].date() - event["startDatetime"].date()).days
                 for day in range(0, numDays):
                     calDict.setdefault(
                         event["startDatetime"].date() + dt.timedelta(days=day), []

src/ics_cal/ics.py

@@ -28,9 +28,7 @@ def retrieve_events(self, ics_url, startDatetime, endDatetime, localTZ):
         if response.ok:
             cal = Calendar(response.text)
         else:
-            self.logger.error(
-                f"Received an error when downloading ICS: {response.text}"
-            )
+            self.logger.error(f"Received an error when downloading ICS: {response.text}")
             sys.exit(1)
 
         if not cal.events:

src/ics_cal/icshelper.py

@@ -6,6 +6,7 @@
 retrieve the information. So feel free to change up the code and amend it to your needs.
 """
 
+
 import datetime as dt
 import tempfile
 import time
@@ -55,11 +56,8 @@ def get_image() -> FileResponse:
     )
 
     currTime = dt.datetime.now(pytz.timezone(cfg.DISPLAY_TZ))
-    currDate = currTime.date()
     calStartDatetime = currTime.replace(hour=0, minute=0, second=0, microsecond=0)
-    calEndDatetime = calStartDatetime + dt.timedelta(
-        days=cfg.NUM_CAL_DAYS_TO_QUERY, seconds=-1
-    )
+    calEndDatetime = calStartDatetime + dt.timedelta(days=cfg.NUM_CAL_DAYS_TO_QUERY, seconds=-1)
 
     events = calModule.get_events(
         cfg.ICS_URL,
@@ -73,16 +71,12 @@ def get_image() -> FileResponse:
     )  # sort by date so we can later take the first N days
 
     end_time = time.time()
-    logger.info(
-        f"Completed data retrieval in {round(end_time - start_time, 3)} seconds."
-    )
+    logger.info(f"Completed data retrieval in {round(end_time - start_time, 3)} seconds.")
 
     # TODO: delete=False leads to accumulating temporary files in /tmp but is currently needed because the FileResponse is async.
-    with tempfile.NamedTemporaryFile(
-        suffix=".png", delete_on_close=False, delete=False
-    ) as tf:
+    with tempfile.NamedTemporaryFile(suffix=".png", delete_on_close=False, delete=False) as tf:
         start_time = time.time()
-        logger.info(f"Generating image...")
+        logger.info("Generating image...")
 
         renderService = RenderHelper(cfg)
         renderService.process_inputs(
@@ -103,7 +97,7 @@ def get_image() -> FileResponse:
 
 
 if __name__ == "__main__":
-    logger.info(f"Starting web server...")
+    logger.info("Starting web server...")
     config = uvicorn.Config(app, host="127.0.0.1", port=5000, log_level="debug")
     server = uvicorn.Server(config)
     server.run()

src/main.py

@@ -13,7 +13,6 @@
 from time import sleep
 
 import structlog
-from PIL import Image
 from selenium import webdriver
 from selenium.webdriver.chrome.options import Options
 from selenium.webdriver.common.by import By
@@ -36,12 +35,8 @@ def set_viewport_size(self, driver):
         inner_height = int(html.get_attribute("clientHeight"))
 
         # "Internal width you want to set+Set "outer frame width" to window size
-        target_width = self.cfg.IMAGE_WIDTH + (
-            current_window_size["width"] - inner_width
-        )
-        target_height = self.cfg.IMAGE_HEIGHT + (
-            current_window_size["height"] - inner_height
-        )
+        target_width = self.cfg.IMAGE_WIDTH + (current_window_size["width"] - inner_width)
+        target_height = self.cfg.IMAGE_HEIGHT + (current_window_size["height"] - inner_height)
 
         driver.set_window_rect(width=target_width, height=target_height)
 
@@ -60,9 +55,7 @@ def get_screenshot(self, path_to_server_image):
         sleep(1)
         driver.get_screenshot_as_file(self.currPath + "/dashboard.png")
         driver.get_screenshot_as_file(path_to_server_image)
-        self.logger.debug(
-            f"Screenshot captured and saved to file {path_to_server_image}."
-        )
+        self.logger.debug(f"Screenshot captured and saved to file {path_to_server_image}.")
         driver.close()
 
     def get_short_time(self, datetimeObj, is24hour=False):
@@ -120,9 +113,7 @@ def process_inputs(
 
         if len(cal_events_days) == 0:
             cal_events_days.append("Today")
-            cal_events_list.append(
-                '<div class="event"><span class="event-time">None</span></div>'
-            )
+            cal_events_list.append('<div class="event"><span class="event-time">None</span></div>')
 
         self.extend_list(cal_events_days, self.cfg.NUM_DAYS_IN_TEMPLATE, "")
         self.extend_list(cal_events_list, self.cfg.NUM_DAYS_IN_TEMPLATE, "")
@@ -146,9 +137,7 @@ def process_inputs(
                 events_dayafter3=cal_events_list[3],
                 events_dayafter4=cal_events_list[4],
                 # I'm choosing to show the forecast for the next hour instead of the current weather
-                current_weather_text=string.capwords(
-                    current_weather["weather"][0]["description"]
-                ),
+                current_weather_text=string.capwords(current_weather["weather"][0]["description"]),
                 current_weather_id=current_weather["weather"][0]["id"],
                 current_weather_temp=round(current_weather["temp"]),
                 today_weather_id=daily_forecast[0]["weather"][0]["id"],