ebird-api 3.1.1__tar.gz → 3.2.0__tar.gz

{ebird_api-3.1.1 → ebird_api-3.2.0}/CHANGELOG.md

@@ -8,6 +8,10 @@ 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.2.0] - 2024-12-30
+- Add get_species_list which returns the list of codes for species seen
+  in a country, subnational1 are, subnational2 area or hotspot.
+
 ## [3.1.1] - 2024-12-30
 ## Changed
 - URLs calling the api are now in the form, https://api.ebird.org/v2/...

{ebird_api-3.1.1/src/ebird_api.egg-info → ebird_api-3.2.0}/PKG-INFO

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

{ebird_api-3.1.1 → ebird_api-3.2.0}/pyproject.toml

@@ -30,7 +30,7 @@ license = {text = "MIT License"}
 name = "ebird-api"
 readme = "README.md"
 requires-python = ">= 3.8"
-version = "3.1.1"
+version = "3.2.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.1.1"
+current_version = "3.2.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 ignore_missing_version = false

{ebird_api-3.1.1 → ebird_api-3.2.0}/src/ebird/api/__init__.py

@@ -2,7 +2,7 @@
 
 """A set of wrapper functions for accessing the eBird API."""
 
-__version__ = "3.1.1"
+__version__ = "3.2.0"
 
 from ebird.api.checklists import get_checklist, get_visits
 from ebird.api.client import Client
@@ -19,6 +19,7 @@ from ebird.api.observations import (
     get_species_observations,
 )
 from ebird.api.regions import get_adjacent_regions, get_region, get_regions
+from ebird.api.species import get_species_list
 from ebird.api.statistics import get_top_100, get_totals
 from ebird.api.taxonomy import (
     get_taxonomy,

ebird_api-3.2.0/src/ebird/api/species.py

@@ -0,0 +1,37 @@
+"""Functions for fetching information about species."""
+
+from ebird.api.utils import call
+from ebird.api.validation import clean_area
+
+SPECIES_LIST_URL = "https://api.ebird.org/v2/product/spplist/%s"
+
+
+def get_species_list(token, area):
+    """
+    Get the list of species for an area.
+
+    The maps to the two end points in the eBird API 2.0,
+    https://documenter.getpostman.com/view/664302/S1ENwy59?version=latest#55bd1b26-6951-4a88-943a-d3a8aa1157dd
+
+    :param token: the token needed to access the API.
+
+    :param area: the code for a country, subnational1 region, subnational2
+    region or location.
+
+    :return: codes, e.g. horlar1, for the list of species observed in the area.
+
+    :raises ValueError: if any of the arguments fail the validation checks.
+
+    :raises URLError if there is an error with the connection to the
+    eBird site.
+
+    :raises HTTPError if the eBird API returns an error.
+
+    """
+    url = SPECIES_LIST_URL % clean_area(area)
+
+    headers = {
+        "X-eBirdApiToken": token,
+    }
+
+    return call(url, {}, headers)

{ebird_api-3.1.1 → ebird_api-3.2.0/src/ebird_api.egg-info}/PKG-INFO

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

{ebird_api-3.1.1 → ebird_api-3.2.0}/src/ebird_api.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/ebird/api/constants.py
 src/ebird/api/hotspots.py
 src/ebird/api/observations.py
 src/ebird/api/regions.py
+src/ebird/api/species.py
 src/ebird/api/statistics.py
 src/ebird/api/taxonomy.py
 src/ebird/api/utils.py