Add pre-commit and linting actions

Author: Perseudonymous

.coveragerc

@@ -11,4 +11,4 @@ exclude_lines =
     if __name__ == .__main__.:
 ignore_errors = True
 omit =
-    tests/*
+    tests/*

.flake8

@@ -1,6 +1,6 @@
 [flake8]
 max-complexity = 10
-max-line-length = 80
+max-line-length = 88
 extend-select = B950
 extend-ignore = E203,E501,E701
-exclude = .git,__pycache__,build,dist
+exclude = .git,__pycache__,build,dist

.readthedocs.yaml

@@ -12,7 +12,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: "docs/conf.py"
   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
   # builder: "dirhtml"
   # Fail on all warnings to avoid broken references
@@ -22,6 +22,6 @@ sphinx:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
- python:
-   install:
-     - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: "docs/requirements.txt"

CHANGELOG.md

@@ -18,7 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [0.9.8] - 2020-07-03
 
 + Remove f-string in test
-  
+
 ## [0.9.7] - 2020-07-03
 
 + Bugfix for `get_observation_sites`

docs/source/conf.py

@@ -5,30 +5,28 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'datapoint-python'
-copyright = '2024, Emily Price, Jacob Tomlinson'
-author = 'Emily Price, Jacob Tomlinson'
-
 import importlib
 
-import datapoint
+project = "datapoint-python"
+copyright = "2024, Emily Price, Jacob Tomlinson"
+author = "Emily Price, Jacob Tomlinson"
 
-release = importlib.metadata.version('datapoint')
-version = importlib.metadata.version('datapoint')
+release = importlib.metadata.version("datapoint")
+version = importlib.metadata.version("datapoint")
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc',]
+extensions = [
+    "sphinx.ext.autodoc",
+]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = "alabaster"
+html_static_path = ["_static"]

examples/tube_bike/tube_bike.py

@@ -28,28 +28,30 @@
 
 # Check whether there are any problems with rain or the tube
 if (
-    my_house_now['probOfPrecipitation']['value'] < 40
-    and work_now['probOfPrecipitation']['value'] < 40
+    my_house_now["probOfPrecipitation"]["value"] < 40
+    and work_now["probOfPrecipitation"]["value"] < 40
     and waterloo_status.description == "Good Service"
 ):
     print("Rain is unlikely and tube service is good, the decision is yours.")
 
 # If it is going to rain then suggest the tube
 elif (
-    my_house_now['probOfPrecipitation']['value'] >= 40 or work_now['probOfPrecipitation']['value'] >= 40
+    my_house_now["probOfPrecipitation"]["value"] >= 40
+    or work_now["probOfPrecipitation"]["value"] >= 40
 ) and waterloo_status.description == "Good Service":
     print("Looks like rain, better get the tube")
 
 # If the tube isn't running then suggest cycling
 elif (
-    my_house_now['probOfPrecipitation']['value'] < 40
-    and work_now['probOfPrecipitation']['value'] < 40
+    my_house_now["probOfPrecipitation"]["value"] < 40
+    and work_now["probOfPrecipitation"]["value"] < 40
     and waterloo_status.description != "Good Service"
 ):
     print("Bad service on the tube, cycling it is!")
 
 # Else if both are bad then suggest cycling in the rain
 else:
     print(
-        "The tube has poor service so you'll have to cycle, but it's raining so take your waterproofs."
+        "The tube has poor service so you'll have to cycle,"
+        " but it's raining so take your waterproofs."
     )

examples/washing/washing.py

@@ -8,8 +8,6 @@
 them and print out the best.
 """
 
-from datetime import datetime
-
 import datapoint
 
 # Set thresholds
@@ -42,8 +40,8 @@
             timestep_score = timestep.wind_speed.value + timestep.temperature.value
 
             # If this timestep scores better than the current best replace it
-            if timestep_score > best_day_score:
-                best_day_score = timestep_score
+            if timestep_score > best_score:
+                best_score = timestep_score
                 best_day = day.date
 
 for timestep in forecast.timesteps:
@@ -54,12 +52,14 @@
         and timestep.wind_gust.value < MAX_WIND
     ):
         # Calculate the score for this timestep
-        timestep_score = timestep['windSpeed10m']['value'] + timestep['screenTemperature']['value']
+        timestep_score = (
+            timestep["windSpeed10m"]["value"] + timestep["screenTemperature"]["value"]
+        )
 
         # If this timestep scores better than the current best replace it
-        if timestep_score > best_day_score:
+        if timestep_score > best_score:
             best_score = timestep_score
-            best_time = timestep['time']
+            best_time = timestep["time"]
 
 
 # If best_day is still None then there are no good days
@@ -68,6 +68,4 @@
 
 # Otherwise print out the day
 else:
-    print(
-        f"{best_time} is the best day with a score of {best_score}"
-    )
+    print(f"{best_time} is the best day with a score of {best_score}")

pyproject.toml

@@ -58,4 +58,4 @@ default-tag = "0.0.1"
 [tool.pytest.ini_options]
 addopts = [
     "--import-mode=importlib",
-]
+]

src/datapoint/Forecast.py

@@ -124,13 +124,13 @@ def __init__(self, frequency, api_data):
         ]  #: The distance of the location of the provided forecast from the requested location
         self.name = api_data["features"][0]["properties"]["location"][
             "name"
-        ]  #:  The name of the location of the provided forecast
+        ]  #: The name of the location of the provided forecast
 
         # N.B. Elevation is in metres above or below the WGS 84 reference
         # ellipsoid as per GeoJSON spec.
         self.elevation = api_data["features"][0]["geometry"]["coordinates"][
             2
-        ]  #:  The elevation of the location of the provided forecast
+        ]  #: The elevation of the location of the provided forecast
 
         forecasts = api_data["features"][0]["properties"]["timeSeries"]
         parameters = api_data["parameters"][0]
@@ -260,7 +260,8 @@ def _check_requested_time(self, target):
         ] - datetime.timedelta(hours=0, minutes=30):
             err_str = (
                 "There is no forecast available for the requested time. "
-                + "The requested time is more than 30 minutes before the first available forecast"
+                "The requested time is more than 30 minutes before the "
+                "first available forecast."
             )
             raise APIException(err_str)
 
@@ -271,7 +272,8 @@ def _check_requested_time(self, target):
         ] - datetime.timedelta(hours=1, minutes=30):
             err_str = (
                 "There is no forecast available for the requested time. "
-                + "The requested time is more than 1 hour and 30 minutes before the first available forecast"
+                "The requested time is more than 1 hour and 30 minutes "
+                "before the first available forecast."
             )
             raise APIException(err_str)
 
@@ -282,7 +284,8 @@ def _check_requested_time(self, target):
         ] - datetime.timedelta(hours=6):
             err_str = (
                 "There is no forecast available for the requested time. "
-                + "The requested time is more than 6 hours before the first available forecast"
+                "The requested time is more than 6 hours before the first "
+                "available forecast."
             )
 
             raise APIException(err_str)
@@ -292,7 +295,11 @@ def _check_requested_time(self, target):
         if self.frequency == "hourly" and target > (
             self.timesteps[-1]["time"] + datetime.timedelta(hours=0, minutes=30)
         ):
-            err_str = "There is no forecast available for the requested time. The requested time is more than 30 minutes after the first available forecast"
+            err_str = (
+                "There is no forecast available for the requested time. The "
+                "requested time is more than 30 minutes after the first "
+                "available forecast"
+            )
 
             raise APIException(err_str)
 
@@ -301,7 +308,11 @@ def _check_requested_time(self, target):
         if self.frequency == "three-hourly" and target > (
             self.timesteps[-1]["time"] + datetime.timedelta(hours=1, minutes=30)
         ):
-            err_str = "There is no forecast available for the requested time. The requested time is more than 1.5 hours after the first available forecast"
+            err_str = (
+                "There is no forecast available for the requested time. The "
+                "requested time is more than 1.5 hours after the first "
+                "available forecast."
+            )
 
             raise APIException(err_str)
 
@@ -310,7 +321,11 @@ def _check_requested_time(self, target):
         if self.frequency == "daily" and target > (
             self.timesteps[-1]["time"] + datetime.timedelta(hours=6)
         ):
-            err_str = "There is no forecast available for the requested time. The requested time is more than 6 hours after the first available forecast"
+            err_str = (
+                "There is no forecast available for the requested time. The "
+                "requested time is more than 6 hours after the first available "
+                "forecast."
+            )
 
             raise APIException(err_str)
 

src/datapoint/__init__.py

@@ -1 +0,0 @@
-from datapoint.Manager import Manager