ebird-api 3.2.1__tar.gz → 3.3.0__tar.gz

{ebird_api-3.2.1 → ebird_api-3.3.0}/CHANGELOG.md

@@ -8,10 +8,21 @@ 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/).
 
+## [3.3.0] - 2025-02-01
+- Added get_location() which works like get_hotspot() but return data for
+  hotspots and private locations.
+
+## [3.2.2] - 2025-01-10
+### Added
+- Added constant API_MAX_RESULTS for the maximum number of results returned
+  by an API call.
+
 ## [3.2.1] - 2024-12-31
+### Updated
 - Remove the '.json' suffix from the URL from get_regions()
 
 ## [3.2.0] - 2024-12-30
+### Added
 - Add get_species_list which returns the list of codes for species seen
   in a country, subnational1 are, subnational2 area or hotspot.
 

{ebird_api-3.2.1/src/ebird_api.egg-info → ebird_api-3.3.0}/PKG-INFO

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

{ebird_api-3.2.1 → ebird_api-3.3.0}/pyproject.toml

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

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/__init__.py

@@ -2,12 +2,17 @@
 
 """A set of wrapper functions for accessing the eBird API."""
 
-__version__ = "3.2.1"
+__version__ = "3.3.0"
 
 from ebird.api.checklists import get_checklist, get_visits
 from ebird.api.client import Client
 from ebird.api.constants import LOCALES
-from ebird.api.hotspots import get_hotspot, get_hotspots, get_nearby_hotspots
+from ebird.api.hotspots import (
+    get_hotspot,
+    get_hotspots,
+    get_location,
+    get_nearby_hotspots,
+)
 from ebird.api.observations import (
     get_historic_observations,
     get_nearby_notable,

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/client.py

@@ -4,6 +4,7 @@
 
 from ebird.api import (
     checklists,
+    constants,
     hotspots,
     observations,
     regions,
@@ -31,12 +32,12 @@ class Client:
         self.api_key = api_key
         self.locale = clean_locale(locale)
         self.max_observations = None
-        self.max_visits = 200
-        self.max_observers = 100
-        self.back = 14
+        self.max_visits = constants.API_MAX_RESULTS
+        self.max_observers = constants.DEFAULT_MAX_OBSERVERS
+        self.back = constants.DEFAULT_BACK
         self.category = None
         self.detail = "full"
-        self.dist = 25
+        self.dist = constants.DEFAULT_DISTANCE
         self.hotspot = False
         self.provisional = True
         self.sort = "date"

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/constants.py

@@ -14,6 +14,8 @@ DEFAULT_MAX_OBSERVERS = 100
 DEFAULT_MAX_CHECKLISTS = 10
 DEFAULT_TOP_100_RANK = "spp"
 
+API_MAX_RESULTS = 200
+
 LOCALES = {
     "Bulgarian": "bg",
     "Chinese": "zh",

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/hotspots.py

@@ -1,5 +1,7 @@
 """Functions for fetching information about hotspots."""
 
+from urllib.error import HTTPError
+
 from ebird.api.utils import call
 from ebird.api.validation import (
     clean_back,
@@ -13,6 +15,7 @@ from ebird.api.validation import (
 REGION_HOTSPOTS_URL = "https://api.ebird.org/v2/ref/hotspot/%s"
 NEARBY_HOTSPOTS_URL = "https://api.ebird.org/v2/ref/hotspot/geo"
 HOTSPOT_INFO_URL = "https://api.ebird.org/v2/ref/hotspot/info/%s"
+LOCATION_INFO_URL = "https://api.ebird.org/v2/ref/region/info/%s"
 
 
 def get_hotspots(token, region, back=None):
@@ -120,6 +123,10 @@ def get_nearby_hotspots(token, lat, lng, dist=25, back=None):
 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.
+
     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
 
@@ -144,3 +151,89 @@ def get_hotspot(token, loc_id):
     }
 
     return call(url, {}, headers)
+
+
+def get_location(token, loc_id):
+    """Get the geographical details of a location (hotspot or private).
+
+    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
+
+    This uses the same API call for get_region, however the data is flattened
+    so it matches the format returned by get_hotspot(). As result you can use
+    this as a drop-in replacement for get_hotspot() which will work with any
+    location.
+
+    NOTE: There is one difference between get_hotspot(). The 'hierarchicalName'
+    attribute ends with the name of the country. In get_hotspot() is ends with
+    the country code.
+
+    :param token: the token needed to access the API.
+
+    :param loc_id: the code for the location, eg. L34742596.
+
+    :return: the latitude, longitude, name, region, etc. for the location.
+
+    :raises ValueError: if an invalid region code is given.
+
+    :raises URLError if there is an error with the connection to the
+    eBird site.
+
+    :raises HTTPError if the eBird API returns an error.
+
+    """
+
+    # 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.
+
+    try:
+        return get_hotspot(token, loc_id)
+    except HTTPError as err:
+        if err.code != 410:
+            raise
+
+    url = LOCATION_INFO_URL % clean_location(loc_id)
+
+    headers = {
+        "X-eBirdApiToken": token,
+    }
+
+    data: dict = call(url, {}, headers)
+
+    result = {
+        "locId": data["code"],
+        "name": data["result"],
+        "latitude": data["latitude"],
+        "longitude": data["longitude"],
+        "isHotspot": False,
+        "locName": data["result"],
+        "lat": data["latitude"],
+        "lng": data["longitude"],
+        "locID": data["code"],
+    }
+
+    # Get all the parent regions in reverse order
+    items = [data["parent"]]
+    while "parent" in items[-1]:
+        items.append(items[-1].pop("parent"))
+    parents = items[::-1]
+
+    # if the name contains the parent, remove it
+    full_name = ", " + parents[0]["result"]
+    for parent in parents[1:]:
+        if parent["result"].endswith(full_name):
+            parent["result"] = parent["result"][: -len(full_name)]
+        full_name = ", " + parent["result"] + full_name
+
+    # Add the processed regions to the record
+    for parent in parents:
+        kind = parent["type"]
+        name = parent["result"]
+        result["%sName" % kind] = name
+        result["%sCode" % kind] = parent["code"]
+
+    result["hierarchicalName"] = result["name"] + full_name
+
+    return result

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/utils.py

@@ -151,7 +151,7 @@ def call(url, params, headers):
     :type params: dict
 
     :return: the content returned by the API
-    :rtype: str
+    :rtype: dict | list
 
     :raises URLError if there is an error with the connection to the
     eBird site.

{ebird_api-3.2.1 → ebird_api-3.3.0}/src/ebird/api/validation.py

@@ -175,7 +175,7 @@ def clean_max_observers(value):
 
 
 def clean_max_checklists(value):
-    return clean_max_results(value, 200)
+    return clean_max_results(value, constants.API_MAX_RESULTS)
 
 
 def clean_locale(value):

{ebird_api-3.2.1 → ebird_api-3.3.0/src/ebird_api.egg-info}/PKG-INFO

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