ebird-api 4.0.0__tar.gz → 4.1.1__tar.gz

{ebird_api-4.0.0 → ebird_api-4.1.1}/CHANGELOG.md

@@ -6,7 +6,14 @@ the git log for details.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 This project adheres to [PEP440](https://www.python.org/dev/peps/pep-0440/)
-and by implication, [Semantic Versioning](http://semver.org/).
+and by implication,
+
+## [4.1.1] - 2026-10-10
+- Changed get_location() to handle an API change where an empty response
+  is now returned for private locations instead of HHTP 410 Gone.
+
+## [4.1.0] - 2026-06-14
+- Retry requests, with exponentinal back-off, if an error occurs.
 
 ## [4.0.0] - 2025-07-09
 - Moved the package to ebird.api.requests to make space for other projects.

{ebird_api-4.0.0/src/ebird_api.egg-info → ebird_api-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebird-api
-Version: 4.0.0
+Version: 4.1.1
 Summary: Wrapper for accessing the eBird API
 Author-email: Project Babbler <projectbabbler@gmail.com>
 License: MIT License

{ebird_api-4.0.0 → ebird_api-4.1.1}/pyproject.toml

@@ -29,7 +29,7 @@ license = {text = "MIT License"}
 name = "ebird-api"
 readme = "README.md"
 requires-python = ">= 3.10"
-version = "4.0.0"
+version = "4.1.1"
 
 [project.urls]
 Repository = "https://github.com/ProjectBabbler/ebird-api.git"
@@ -37,7 +37,7 @@ Issues = "https://github.com/ProjectBabbler/ebird-api/issues"
 Changelog = "https://github.com/ProjectBabbler/ebird-api/blob/master/CHANGELOG.md"
 
 [tool.bumpversion]
-current_version = "4.0.0"
+current_version = "4.1.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 ignore_missing_version = false

{ebird_api-4.0.0 → ebird_api-4.1.1}/src/ebird/api/requests/__init__.py

@@ -2,7 +2,7 @@
 
 """A set of wrapper functions for accessing the eBird API."""
 
-__version__ = "4.0.0"
+__version__ = "4.1.1"
 
 from ebird.api.requests.checklists import get_checklist, get_visits
 from ebird.api.requests.client import Client

{ebird_api-4.0.0 → ebird_api-4.1.1}/src/ebird/api/requests/hotspots.py

@@ -1,5 +1,6 @@
 """Functions for fetching information about hotspots."""
 
+from json import JSONDecodeError
 from urllib.error import HTTPError
 
 from ebird.api.requests.utils import call
@@ -124,8 +125,8 @@ def get_hotspot(token, loc_id):
     """Get the geographical details of a hotspot.
 
     The call only work for hotspots. If you use the identifier for a private
-    location the eBird API will return HTTP 410 Gone and an HttpError will be
-    raised.
+    location the eBird API will return an empty response (as of Oct 2026) and
+    a JSONDecodeError will be raised.
 
     This maps to the end point in the eBird API 2.0,
     https://documenter.getpostman.com/view/664302/S1ENwy59?version=latest#e25218db-566b-4d8b-81ca-e79a8f68c599
@@ -143,6 +144,8 @@ def get_hotspot(token, loc_id):
 
     :raises HTTPError if the eBird API returns an error.
 
+    :raises JSONDecodeError if the JSON data returned by the API is invalid.
+
     """
     url = HOTSPOT_INFO_URL % clean_location(loc_id)
 
@@ -185,11 +188,13 @@ def get_location(token, loc_id):
 
     # get_region() does not return "isHotspot" in the results, so we
     # try get_hotspot() first and if the call fails with HTTP 410 Gone,
-    # indicating it's a private location, we call get_region and
-    # massage the result.
+    # or as of Oct 2026, HTTP 200 and an empty response, indicating
+    # it's a private location, we call get_region and massage the result.
 
     try:
         return get_hotspot(token, loc_id)
+    except JSONDecodeError:
+        pass
     except HTTPError as err:
         if err.code != 410:
             raise

{ebird_api-4.0.0 → ebird_api-4.1.1}/src/ebird/api/requests/utils.py

@@ -1,6 +1,8 @@
 """Various functions used in the API."""
 
 import json
+import time
+from urllib.error import HTTPError
 from urllib.parse import urlencode
 from urllib.request import Request, urlopen
 
@@ -74,7 +76,7 @@ def filter_parameters(params):
     return filtered
 
 
-def get_response(url, params=None, headers=None):
+def get_response(url, params=None, headers=None, max_retries=3, backoff_factor=1.0):
     """Get the content from the eBird API.
 
     :param url: the URL for the API call.
@@ -84,7 +86,14 @@ def get_response(url, params=None, headers=None):
     :type params: dict
 
     :param headers: the headers to add to the request.
-    :type params: dict
+    :type headers: dict
+
+    :param max_retries: number of times to retry after a 429 response.
+    :type max_retries: int
+
+    :param backoff_factor: seconds to wait before the first retry; doubles
+    on each subsequent attempt.
+    :type backoff_factor: float
 
     :return: the content returned by the API
     :rtype: str
@@ -104,7 +113,15 @@ def get_response(url, params=None, headers=None):
         for name, value in headers.items():
             request.add_header(name, value)
 
-    return urlopen(request).read()
+    for attempt in range(max_retries + 1):
+        try:
+            return urlopen(request).read()
+        except HTTPError as exc:
+            if attempt == max_retries:
+                raise
+            retry_after = exc.headers.get("Retry-After") if exc.code == 429 else None
+            delay = float(retry_after) if retry_after else backoff_factor * (2**attempt)
+            time.sleep(delay)
 
 
 def get_json(content):
@@ -138,7 +155,7 @@ def save_json(filename, data, indent=None):
         json.dump(data, outfile, indent=indent)
 
 
-def call(url, params, headers):
+def call(url, params, headers, max_retries=3, backoff_factor=1.0):
     """Call the eBird API.
 
     :param url: the URL for the API call.
@@ -148,7 +165,14 @@ def call(url, params, headers):
     :type params: dict
 
     :param headers: the headers to add to the request.
-    :type params: dict
+    :type headers: dict
+
+    :param max_retries: number of times to retry after a 429 response.
+    :type max_retries: int
+
+    :param backoff_factor: seconds to wait before the first retry; doubles
+    on each subsequent attempt.
+    :type backoff_factor: float
 
     :return: the content returned by the API
     :rtype: dict | list
@@ -158,7 +182,13 @@ def call(url, params, headers):
 
     :raises HTTPError if the eBird API returns an error.
 
+    :raises JSONDecodeError if the JSON data returned by the API is invalid.
+
     """
     filtered = filter_parameters(params)
     mapped = map_parameters(filtered)
-    return get_json(get_response(url, mapped, headers))
+    return get_json(
+        get_response(
+            url, mapped, headers, max_retries=max_retries, backoff_factor=backoff_factor
+        )
+    )

{ebird_api-4.0.0 → ebird_api-4.1.1/src/ebird_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebird-api
-Version: 4.0.0
+Version: 4.1.1
 Summary: Wrapper for accessing the eBird API
 Author-email: Project Babbler <projectbabbler@gmail.com>
 License: MIT License