Add pre-commit configuration and autoformat

.git-blame-ignore-revs

@@ -0,0 +1,13 @@
+# This file lists commits to be ignored when running git-blame(1)
+# Add commit IDs to this when the commit is a trivial change such
+# as autoformatting commits
+
+# You can use this file with git-blame by using --ignore-revs-file:
+#    git blame --ignore-revs-file .git-blame-ignore-revs
+# To set this file to be ignored on each git-blame invocation:
+#    git config blame.ignoreRevsFile .git-blame-ignore-revs
+# By default, GitHub will use the set of commits in this file in its Blame view:
+# https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
+
+# initial pre-commit run and ruff autoformatting
+9031aafa07bdc3a93a2019648bbf50b894446b70

.github/workflows/docs-build-deploy.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v3
-    - name: Install cats 
+    - name: Install cats
       run: python3 -m pip install .
     - run: |
         pip install -r docs/docs-requirements.txt

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.2
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format

.vscode/settings.json

@@ -10,4 +10,4 @@
     "python.formatting.provider": "none",
     "python.linting.flake8Enabled": true,
     "python.linting.enabled": true
-}
+}

cats/CI_api_interface.py

@@ -10,7 +10,8 @@ class InvalidLocationError(Exception):
     pass
 
 
-APIInterface = namedtuple('APIInterface', ['get_request_url', 'parse_response_data'])
+APIInterface = namedtuple("APIInterface", ["get_request_url", "parse_response_data"])
+
 
 def ciuk_request_url(timestamp: datetime, postcode: str):
     # This transformation is specific to the CI-UK API.
@@ -25,7 +26,7 @@ def ciuk_request_url(timestamp: datetime, postcode: str):
     else:
         dt = timestamp.replace(minute=1, second=0, microsecond=0)
 
-    if (len(postcode) > 4):
+    if len(postcode) > 4:
         sys.stderr.write(f"Warning: truncating postcode {postcode} to ")
         postcode = postcode[:-3].strip()
         sys.stderr.write(f"{postcode}.\n")
@@ -49,9 +50,10 @@ def ciuk_parse_response_data(response: dict):
     :param response:
     :return:
     """
+
     def invalid_code(r: dict):
         try:
-            return "postcode" in r['error']['message']
+            return "postcode" in r["error"]["message"]
         except KeyError:
             return False
 
@@ -65,9 +67,9 @@ def invalid_code(r: dict):
 
     datefmt = "%Y-%m-%dT%H:%MZ"
     # The "Z" at the end of the format string indicates UTC,
-    # however, strptime does not know how to parse this, so we 
+    # however, strptime does not know how to parse this, so we
     # need to add tzinfo data.
-    utc = ZoneInfo('UTC')
+    utc = ZoneInfo("UTC")
     return [
         CarbonIntensityPointEstimate(
             datetime=datetime.strptime(d["from"], datefmt).replace(tzinfo=utc),
@@ -76,9 +78,10 @@ def invalid_code(r: dict):
         for d in response["data"]["data"]
     ]
 
+
 API_interfaces = {
     "carbonintensity.org.uk": APIInterface(
         get_request_url=ciuk_request_url,
         parse_response_data=ciuk_parse_response_data,
-        ),
-    }
+    ),
+}

cats/CI_api_query.py

@@ -1,9 +1,13 @@
-import requests_cache
 from datetime import datetime, timezone
 
+import requests_cache
+
 from .forecast import CarbonIntensityPointEstimate
 
-def get_CI_forecast(location: str, CI_API_interface) -> list[CarbonIntensityPointEstimate]:
+
+def get_CI_forecast(
+    location: str, CI_API_interface
+) -> list[CarbonIntensityPointEstimate]:
     """
     Get carbon intensity from an API
 
@@ -16,16 +20,19 @@ def get_CI_forecast(location: str, CI_API_interface) -> list[CarbonIntensityPoin
 
     # Setup a session for the API call. This uses a global HTTP cache
     # with the URL as the key. Failed attempts are not cached.
-    session = requests_cache.CachedSession('cats_cache', use_temp=True)
+    session = requests_cache.CachedSession("cats_cache", use_temp=True)
 
     # get the carbon intensity api data
-    r = session.get(CI_API_interface.get_request_url(datetime.now(timezone.utc), location))
+    r = session.get(
+        CI_API_interface.get_request_url(datetime.now(timezone.utc), location)
+    )
     data = r.json()
 
     return CI_API_interface.parse_response_data(data)
 
 
 if __name__ == "__main__":
     from .CI_api_interface import API_interfaces
+
     # test example using Manchester as a location
     data_tuples = get_CI_forecast("M15", API_interfaces["carbonintensity.org.uk"])