typo fix and sets timeout to 5 seconds

Author: ribalba

README.md

@@ -32,7 +32,7 @@ cp config.example.yml config.yml
 Edit `config.yml` and add API tokens per source in `cron.sources` (via `api_token`).
 If a source should skip historical fetches, set `only_get_current: true` on that source.
 You can also set `resolution` per source to override provider defaults (for example ElectricityMaps `5_minutes`).
-Set `update_iterval` (seconds) on a source to run it less frequently than the global cron loop (`run_cron_checker_seconds`).
+Set `update_interval` (seconds) on a source to run it less frequently than the global cron loop (`run_cron_checker_seconds`).
 
 For ElectricityMaps: Replace "your-electricitymaps-api-token-here" with your actual token. You don't need to modify anything to start collection. We use free endpoints per default.
 
@@ -55,7 +55,7 @@ and that should set everythin up so that you can access Elephant under `http://l
 
 In production you typically need an SSL certificate to run Elephant.
 
-Here we recommend you to use an NGINX reverse proxy and use its SSL certificate handling. 
+Here we recommend you to use an NGINX reverse proxy and use its SSL certificate handling.
 Then bind the Elephant `app` container only to localhost.
 
 Change the `ports` directive from `8085:8085` to `127.0.0.1:8085:8085`.

config.example.yml

@@ -11,25 +11,25 @@ cron:
   sources:
     - region: "DE"
       provider: "bundesnetzagentur"
-      # update_iterval: 3600 # seconds
+      # update_interval: 3600 # seconds
       primary: true # If you have multiple sources for the same region, one should be marked as primary so the api knows which to return by default
     - region: "DE"
       provider: "energycharts"
-      # update_iterval: 1800 # seconds
+      # update_interval: 1800 # seconds
     # - region: "DE"
     #   provider: "bundesnetzagentur_all"
     # - region: "DE"
     #   provider: "electricitymaps"
     #   api_token: "YOUR TOKEN HERE"
     #   resolution: "5_minutes"
-    #   update_iterval: 3600 # every hour
+    #   update_interval: 3600 # every hour
     #   only_get_current: true
     #   primary: true
     # - region: "FR"
     #   provider: "electricitymaps"
     #   api_token: "YOUR TOKEN HERE"
     #   resolution: "5_minutes"
-    #   update_iterval: 3600 # every hour
+    #   update_interval: 3600 # every hour
     #   only_get_current: false
 
 # Logging

elephant/config.py

@@ -33,7 +33,7 @@ class Source(BaseModel):
     provider: str
     api_token: Optional[str] = None
     resolution: Optional[str] = None
-    update_iterval: Optional[int] = Field(default=None, ge=1)
+    update_interval: Optional[int] = Field(default=None, ge=1)
     only_get_current: bool = False
     primary: bool = False
 

elephant/cron.py

@@ -85,11 +85,11 @@ def run_cron(specific_region=None, specific_provider=None) -> None:
                 logger.warning("Provider '%s' for region '%s' is not configured or enabled.", provider_db_name, region)
                 continue
 
-            if not _is_source_due(cur, provider_db_name, source.update_iterval, force_run=force_run):
+            if not _is_source_due(cur, provider_db_name, source.update_interval, force_run=force_run):
                 logger.debug(
-                    "Skipping '%s' due to update_iterval=%s seconds.",
+                    "Skipping '%s' due to update_interval=%s seconds.",
                     provider_db_name,
-                    source.update_iterval,
+                    source.update_interval,
                 )
                 continue
 

elephant/providers/bna_helper.py

@@ -55,7 +55,7 @@
 
 def fetch_json(url: str) -> Optional[dict]:
     try:
-        response = requests.get(url, timeout=30.0)
+        response = requests.get(url, timeout=5.0)
         response.raise_for_status()
         return response.json()
     except (requests.RequestException, ValueError):

elephant/providers/electricitymaps.py

@@ -33,7 +33,7 @@ def __init__(self, config: ProviderConfig):
     def _get(self, path: str, params: dict) -> Response:
         """Perform a GET request with shared error handling."""
         try:
-            response = requests.get(f"{BASE_URL}{path}", params=params, timeout=30.0, headers=self.headers)
+            response = requests.get(f"{BASE_URL}{path}", params=params, timeout=5.0, headers=self.headers)
             response.raise_for_status()
             return response
 

elephant/providers/energycharts.py

@@ -29,7 +29,7 @@ def __init__(self, config: ProviderConfig):
     def _get(self, region: str) -> dict:
         """Perform a GET request with shared error handling."""
         try:
-            response = requests.get(f"{BASE_URL}/co2eq", params={"country": region.lower()}, timeout=30.0)
+            response = requests.get(f"{BASE_URL}/co2eq", params={"country": region.lower()}, timeout=5.0)
             response.raise_for_status()
             return response.json()
         except (HTTPError, RequestException) as exc:

tests/test_cron.py

@@ -142,9 +142,9 @@ def _fake_db_connection():
     assert conn.commits == 1
 
 
-def test_run_cron_skips_source_if_update_iterval_not_elapsed(monkeypatch) -> None:
+def test_run_cron_skips_source_if_update_interval_not_elapsed(monkeypatch) -> None:
     provider = _CountingProvider()
-    cfg = _make_config(Source(region="DE", provider="energycharts", update_iterval=15))
+    cfg = _make_config(Source(region="DE", provider="energycharts", update_interval=15))
     conn = _FakeConnection()
     conn.last_runs["energycharts_de"] = datetime.now(tz=timezone.utc)
 
@@ -164,9 +164,9 @@ def _fake_db_connection():
     assert conn.commits == 0
 
 
-def test_run_cron_runs_source_if_update_iterval_elapsed(monkeypatch) -> None:
+def test_run_cron_runs_source_if_update_interval_elapsed(monkeypatch) -> None:
     provider = _CountingProvider()
-    cfg = _make_config(Source(region="DE", provider="energycharts", update_iterval=15))
+    cfg = _make_config(Source(region="DE", provider="energycharts", update_interval=15))
     conn = _FakeConnection()
     previous_run = datetime.now(tz=timezone.utc) - timedelta(seconds=16)
     conn.last_runs["energycharts_de"] = previous_run
@@ -188,9 +188,9 @@ def _fake_db_connection():
     assert conn.last_runs["energycharts_de"] > previous_run
 
 
-def test_run_cron_force_run_bypasses_update_iterval(monkeypatch) -> None:
+def test_run_cron_force_run_bypasses_update_interval(monkeypatch) -> None:
     provider = _CountingProvider()
-    cfg = _make_config(Source(region="DE", provider="energycharts", update_iterval=30))
+    cfg = _make_config(Source(region="DE", provider="energycharts", update_interval=30))
     conn = _FakeConnection()
     conn.last_runs["energycharts_de"] = datetime.now(tz=timezone.utc)