yelpapi 2.6.0__tar.gz → 2.7.0__tar.gz

yelpapi-2.7.0/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: '3.15'
+
+      - name: Verify tag matches package version
+        run: |
+          version="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [ "v${version}" != "${{ github.ref_name }}" ]; then
+            echo "Tag ${{ github.ref_name }} does not match pyproject.toml version ${version}" >&2
+            exit 1
+          fi
+
+      - name: Extract release notes from CHANGES.md
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          awk -v v="$version" '/^## /{if (f) exit; f = (index($0, "## " v " ") == 1); next} f' CHANGES.md > release-notes.md
+          if [ ! -s release-notes.md ]; then
+            echo "No CHANGES.md entry found for ${version}" >&2
+            exit 1
+          fi
+
+      - name: Build
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release create "${{ github.ref_name }}" dist/* --title "YelpAPI ${{ github.ref_name }}" --notes-file release-notes.md

yelpapi-2.7.0/.github/workflows/tests.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  typecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v7
+
+      # mypy targets python_version in pyproject.toml regardless of the interpreter it runs on, so a single job is
+      # sufficient. Run it on that same minimum version so installed dependencies and stubs match what users on the
+      # minimum get. Keep this equal to python_version.
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Type-check with mypy
+        run: mypy
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11', '3.12', '3.13', '3.14', '3.15']
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest

{yelpapi-2.6.0 → yelpapi-2.7.0}/.gitignore

@@ -19,6 +19,7 @@ venv/
 .pytest_cache/
 .coverage
 htmlcov/
+.codebase-memory/
 
 # OS
 .DS_Store

yelpapi-2.7.0/AGENTS.md

@@ -0,0 +1,78 @@
+# AGENTS.md
+
+This file provides guidance to AI coding agents working with code in this repository.
+
+## Commands
+
+Install dependencies:
+```
+pip install -e ".[dev]"
+```
+
+Run tests (coverage included by default via `pyproject.toml`):
+```
+pytest
+```
+
+Run a single test:
+```
+pytest tests/test_yelpapi.py::TestYelpAPI::test_calls_api
+```
+
+Type-check (strict; configured in `[tool.mypy]` in `pyproject.toml`, which sets the files to check and targets the minimum supported Python):
+```
+mypy
+```
+
+CI (`.github/workflows/tests.yml`) runs `pytest` on every supported Python version and `mypy` once in a separate `typecheck` job. Both must pass.
+
+## Architecture
+
+This is a thin Python wrapper around the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). The entire implementation lives in `yelpapi/yelpapi.py` as a single `YelpAPI` class, re-exported from `yelpapi/__init__.py` via `__all__`.
+
+**Design philosophy:** The wrapper is intentionally minimal and extensible — all API parameters are passed through `**kwargs` directly to the HTTP request, so it doesn't break when Yelp adds new parameters. The only thing that would break it is a URL scheme change. Public methods return `dict[str, Any]`; don't introduce `TypedDict`s or response models, since they would break this pass-through design.
+
+**Request flow:** Each public method (e.g., `search_query`, `business_query`) validates required parameters, then delegates to `_query()`, which strips `None`-valued kwargs before issuing the GET request via a shared `requests.Session`. `_query()` raises `requests.HTTPError` for HTTP error statuses, and raises `YelpAPI.YelpAPIError` if the JSON body isn't an object or contains an `error` key. Methods that require a location share a `_require_location_or_lat_lng()` helper.
+
+**Session management:** A single `requests.Session` is reused for all calls (performance benefit). Users should close it via context manager (`with YelpAPI(...) as api`) or explicitly via `api.close()`.
+
+**Tests** use `requests-mock` (via the `mock_request` autouse fixture in `conftest.py`) to intercept HTTP calls, and `Faker` for generating random test data. No real API calls are made in tests.
+
+## Conventions
+
+- **Typing:** The package ships `py.typed` and must pass strict `mypy`. All library code must be fully annotated. Tests and examples are type-checked but may omit annotations; see the `[[tool.mypy.overrides]]` section of `pyproject.toml`.
+- **Coverage:** Line coverage of `yelpapi/` is 100%. Keep it there; new code paths need tests.
+- **Style:** Use single quotes for strings, and 120-character lines.
+- **Adding an endpoint** requires all of the following:
+  - a `*_API_URL` constant
+  - a method that validates required parameters and calls `_query()`
+  - an entry in the `YelpAPI` class docstring's API list
+  - an entry in the README "METHODS" list
+  - tests covering both validation failures and success
+
+## Supported Python versions
+
+Support only Python versions that are currently maintained (not end-of-life); see https://devguide.python.org/versions/. The minimum is currently 3.11. When adding or dropping a version, update all of these together:
+
+- `requires-python` and the `Programming Language :: Python :: 3.x` classifiers in `pyproject.toml`
+- `python_version` in `[tool.mypy]` in `pyproject.toml` (keep it equal to the minimum)
+- the `test` job's matrix in `.github/workflows/tests.yml`
+- the Python version used by the `typecheck` job in `tests.yml` (keep it equal to the minimum, matching `python_version`)
+- the Python version used by `publish.yml` (use the newest supported version)
+- the "REQUIREMENTS" section of `README.md`
+- `CHANGES.md`
+
+Once the minimum is raised, newly available language and typing features (e.g., `typing.Self` with 3.11) may be used.
+
+## Releasing
+
+1. Bump `version` in `pyproject.toml`.
+2. Add a `## X.Y.Z (YYYY-MM-DD)` entry at the top of `CHANGES.md`.
+3. Commit, push, and make sure CI is green. The publish workflow does not run tests.
+4. Push an annotated tag:
+
+   ```
+   git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z
+   ```
+
+Pushing a `v*` tag triggers `.github/workflows/publish.yml`. Before publishing, it fails if the tag doesn't match the `pyproject.toml` version, or if `CHANGES.md` has no entry for that version. It then builds, publishes to PyPI, and creates a GitHub release whose notes are that version's `CHANGES.md` entry.

{yelpapi-2.6.0 → yelpapi-2.7.0}/CHANGES.md

@@ -1,5 +1,12 @@
 # Changes
 
+## 2.7.0 (2026-10-28)
+* Dropped support for end-of-life Python 3.9 and 3.10; added Python 3.15. Minimum supported version is now 3.11.
+* `YelpAPI.__enter__` now returns `Self`, so subclasses are typed correctly when used as context managers.
+* Declared `__all__` in the `yelpapi` package so `from yelpapi import YelpAPI` passes `mypy --strict` (no implicit re-export) and Pyright's private-import checks.
+* Added the `Typing :: Typed` classifier.
+* A JSON response body that isn't an object (e.g., a string or list) now raises `YelpAPI.YelpAPIError` instead of an unhelpful `TypeError` or silently returning the wrong type.
+
 ## 2.6.0 (2026-03-17)
 * Added 5 new API endpoints: Business Engagement Metrics (`business_engagement_query`), Business Service Offerings (`business_service_offerings_query`), Categories (`categories_query`), Category by Alias (`category_query`), and Review Highlights (`review_highlights_query`).
 * Updated all documentation URLs to the current `docs.developer.yelp.com` reference format.

{yelpapi-2.6.0 → yelpapi-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: yelpapi
-Version: 2.6.0
+Version: 2.7.0
 Summary: yelpapi is a pure Python implementation of the Yelp Fusion API.
 Project-URL: Homepage, https://github.com/lanl/yelpapi
 Project-URL: Changelog, https://github.com/lanl/yelpapi/blob/master/CHANGES.md
@@ -32,21 +32,24 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
 Requires-Dist: requests
 Provides-Extra: dev
 Requires-Dist: faker; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: requests-mock; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # yelpapi
@@ -54,18 +57,18 @@ Description-Content-Type: text/markdown
 [![Tests](https://github.com/lanl/yelpapi/actions/workflows/tests.yml/badge.svg)](https://github.com/lanl/yelpapi/actions/workflows/tests.yml)
 
 ## LICENSE
-This software is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
+This software is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
 
 ## ABOUT
 yelpapi is a pure Python implementation of the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). It is simple, fast, and robust to any changes Yelp may make to the API in the future.
 
 ## REQUIREMENTS
-This code requires Python 3.9 or higher and [requests](https://github.com/requests/requests).
+This code requires Python 3.11 or higher and [requests](https://github.com/psf/requests).
 
 ## INSTALL
 yelpapi is available on PyPI at https://pypi.org/project/yelpapi/.
 
-Install using [pip](http://www.pip-installer.org/):
+Install using [pip](https://pip.pypa.io/):
 
     pip install yelpapi
 
@@ -75,7 +78,7 @@ This API is demonstrated more thoroughly in [examples.py](examples/examples.py),
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 You can also set timeouts so API calls do not block indefinitely in degraded network conditions:
@@ -83,16 +86,16 @@ You can also set timeouts so API calls do not block indefinitely in degraded net
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key, timeout_s=3.0) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 Under the covers, this module uses a [`requests.Session`](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) object for issuing all API calls, which offers potentially significant performance benefits over issuing separate API calls outside of a session. You should be sure to close the underlying session when all API interactions are complete. The above examples demonstrate using the class as a context manager, which will automatically close the connection when you're done and is the preferred way of using the class, but you can also manually close it like this if a context manager won't work for your use case:
 
 ```python
 from yelpapi import YelpAPI
+yelp_api = YelpAPI(api_key)
 try:
-    yelp_api = YelpAPI(api_key)
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 finally:
     yelp_api.close()
 ```

{yelpapi-2.6.0 → yelpapi-2.7.0}/README.md

@@ -3,18 +3,18 @@
 [![Tests](https://github.com/lanl/yelpapi/actions/workflows/tests.yml/badge.svg)](https://github.com/lanl/yelpapi/actions/workflows/tests.yml)
 
 ## LICENSE
-This software is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
+This software is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
 
 ## ABOUT
 yelpapi is a pure Python implementation of the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). It is simple, fast, and robust to any changes Yelp may make to the API in the future.
 
 ## REQUIREMENTS
-This code requires Python 3.9 or higher and [requests](https://github.com/requests/requests).
+This code requires Python 3.11 or higher and [requests](https://github.com/psf/requests).
 
 ## INSTALL
 yelpapi is available on PyPI at https://pypi.org/project/yelpapi/.
 
-Install using [pip](http://www.pip-installer.org/):
+Install using [pip](https://pip.pypa.io/):
 
     pip install yelpapi
 
@@ -24,7 +24,7 @@ This API is demonstrated more thoroughly in [examples.py](examples/examples.py),
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 You can also set timeouts so API calls do not block indefinitely in degraded network conditions:
@@ -32,16 +32,16 @@ You can also set timeouts so API calls do not block indefinitely in degraded net
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key, timeout_s=3.0) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 Under the covers, this module uses a [`requests.Session`](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) object for issuing all API calls, which offers potentially significant performance benefits over issuing separate API calls outside of a session. You should be sure to close the underlying session when all API interactions are complete. The above examples demonstrate using the class as a context manager, which will automatically close the connection when you're done and is the preferred way of using the class, but you can also manually close it like this if a context manager won't work for your use case:
 
 ```python
 from yelpapi import YelpAPI
+yelp_api = YelpAPI(api_key)
 try:
-    yelp_api = YelpAPI(api_key)
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 finally:
     yelp_api.close()
 ```

{yelpapi-2.6.0 → yelpapi-2.7.0}/pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "hatchling.build"
 
 [project]
 name = "yelpapi"
-version = "2.6.0"
+version = "2.7.0"
 description = "yelpapi is a pure Python implementation of the Yelp Fusion API."
 readme = "README.md"
 license = {file = "LICENSE"}
 authors = [
     {name = "Geoffrey Fairchild", email = "mail@gfairchild.com"},
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 dependencies = [
     "requests",
 ]
@@ -21,12 +21,13 @@ classifiers = [
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
@@ -34,9 +35,11 @@ classifiers = [
 [project.optional-dependencies]
 dev = [
     "faker",
+    "mypy",
     "pytest",
     "pytest-cov",
     "requests-mock",
+    "types-requests",
 ]
 
 [project.urls]
@@ -44,4 +47,19 @@ Homepage = "https://github.com/lanl/yelpapi"
 Changelog = "https://github.com/lanl/yelpapi/blob/master/CHANGES.md"
 
 [tool.pytest.ini_options]
-addopts = "-vl --cov"
+addopts = "-vl --cov=yelpapi --import-mode=importlib"
+
+[tool.mypy]
+strict = true
+python_version = "3.11"
+files = ["yelpapi", "tests", "examples"]
+explicit_package_bases = true
+warn_unreachable = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool", "possibly-undefined"]
+
+# The test suite and examples are checked, but we don't require every test
+# helper/fixture to carry full type annotations.
+[[tool.mypy.overrides]]
+module = ["tests.*", "examples.*"]
+disallow_untyped_defs = false
+disallow_incomplete_defs = false

yelpapi-2.7.0/release-notes.md

@@ -0,0 +1,6 @@
+* Dropped support for end-of-life Python 3.9 and 3.10; added Python 3.15. Minimum supported version is now 3.11.
+* `YelpAPI.__enter__` now returns `Self`, so subclasses are typed correctly when used as context managers.
+* Declared `__all__` in the `yelpapi` package so `from yelpapi import YelpAPI` passes `mypy --strict` (no implicit re-export) and Pyright's private-import checks.
+* Added the `Typing :: Typed` classifier.
+* A JSON response body that isn't an object (e.g., a string or list) now raises `YelpAPI.YelpAPIError` instead of an unhelpful `TypeError` or silently returning the wrong type.
+

{yelpapi-2.6.0 → yelpapi-2.7.0}/tests/test_yelpapi.py

@@ -79,7 +79,7 @@ class TestYelpAPI:
         url = faker.uri()
         mock_request.get(url, content=bytes(faker.binary(length=256)))
 
-        with pytest.raises(ValueError):
+        with pytest.raises(requests.exceptions.JSONDecodeError):
             yelp._query(url)
 
     def test_raises_yelp_api_error(self, yelp, faker, mock_request, random_dict):
@@ -94,6 +94,21 @@ class TestYelpAPI:
 
         assert exc_info.value.args[0] == f'{error_code}: {error_description}'
 
+    @pytest.mark.parametrize('body, type_name', [
+        ('"an error occurred"', 'str'),
+        ('["error"]', 'list'),
+        ('42', 'int'),
+        ('null', 'NoneType'),
+    ])
+    def test_rejects_non_dict_json(self, yelp, faker, mock_request, body, type_name):
+        url = faker.uri()
+        mock_request.get(url, text=body)
+
+        with pytest.raises(YelpAPI.YelpAPIError) as exc_info:
+            yelp._query(url)
+
+        assert exc_info.value.args[0] == f'Unexpected response type: {type_name}'
+
     @pytest.mark.parametrize('status_code', [400, 401, 403, 404, 500])
     def test_raises_http_error(self, yelp, faker, mock_request, status_code):
         url = faker.uri()
@@ -114,9 +129,10 @@ class TestYelpAPI:
 
 
 class TestAutocompleteQuery:
-    def test_requires_text(self, yelp):
+    @pytest.mark.parametrize('invalid_text', [None, ''])
+    def test_requires_text(self, yelp, invalid_text):
         with pytest.raises(ValueError):
-            yelp.autocomplete_query()
+            yelp.autocomplete_query(text=invalid_text)
 
     def test_success(self, yelp, faker, mock_request, random_dict):
         mock_request.get(AUTOCOMPLETE_API_URL, json=random_dict)
@@ -152,6 +168,20 @@ class TestBusinessMatchQuery:
         with pytest.raises(ValueError):
             yelp.business_match_query(**params)
 
+    @pytest.mark.parametrize('empty_param', ['name', 'city', 'state', 'country', 'address1'])
+    def test_rejects_empty_params(self, yelp, faker, empty_param):
+        params = {
+            'name': faker.company(),
+            'city': faker.city(),
+            'state': faker.state_abbr(),
+            'country': faker.country_code(),
+            'address1': faker.street_address(),
+        }
+        params[empty_param] = ''
+
+        with pytest.raises(ValueError):
+            yelp.business_match_query(**params)
+
     def test_success(self, yelp, faker, mock_request, random_dict):
         mock_request.get(BUSINESS_MATCH_API_URL, json=random_dict)
 
@@ -165,9 +195,10 @@ class TestBusinessMatchQuery:
 
 
 class TestBusinessEngagementQuery:
-    def test_requires_business_ids(self, yelp):
+    @pytest.mark.parametrize('invalid_ids', [None, ''])
+    def test_requires_business_ids(self, yelp, invalid_ids):
         with pytest.raises(ValueError):
-            yelp.business_engagement_query()
+            yelp.business_engagement_query(business_ids=invalid_ids)
 
     def test_success(self, yelp, faker, mock_request, random_dict):
         mock_request.get(BUSINESS_ENGAGEMENT_API_URL, json=random_dict)
@@ -233,16 +264,27 @@ class TestFeaturedEventQuery:
         with pytest.raises(ValueError):
             yelp.featured_event_query()
 
-    def test_success(self, yelp, faker, mock_request, random_dict):
+    @pytest.mark.parametrize('partial_kwargs', [{'latitude': 37.7749}, {'longitude': -122.4194}])
+    def test_rejects_partial_lat_lng(self, yelp, partial_kwargs):
+        with pytest.raises(ValueError):
+            yelp.featured_event_query(**partial_kwargs)
+
+    def test_success_with_location(self, yelp, faker, mock_request, random_dict):
         mock_request.get(FEATURED_EVENT_API_URL, json=random_dict)
 
         assert yelp.featured_event_query(location=faker.city()) == random_dict
 
+    def test_success_with_lat_lng(self, yelp, faker, mock_request, random_dict):
+        mock_request.get(FEATURED_EVENT_API_URL, json=random_dict)
+
+        assert yelp.featured_event_query(latitude=faker.latitude(), longitude=faker.longitude()) == random_dict
+
 
 class TestPhoneSearchQuery:
-    def test_requires_phone(self, yelp):
+    @pytest.mark.parametrize('invalid_phone', [None, ''])
+    def test_requires_phone(self, yelp, invalid_phone):
         with pytest.raises(ValueError):
-            yelp.phone_search_query()
+            yelp.phone_search_query(phone=invalid_phone)
 
     def test_success(self, yelp, faker, mock_request, random_dict):
         mock_request.get(PHONE_SEARCH_API_URL, json=random_dict)
@@ -281,7 +323,12 @@ class TestSearchQuery:
         with pytest.raises(ValueError):
             yelp.search_query()
 
-    def test_success(self, yelp, faker, mock_request, random_dict):
+    @pytest.mark.parametrize('partial_kwargs', [{'latitude': 37.7749}, {'longitude': -122.4194}])
+    def test_rejects_partial_lat_lng(self, yelp, partial_kwargs):
+        with pytest.raises(ValueError):
+            yelp.search_query(**partial_kwargs)
+
+    def test_success_with_location(self, yelp, faker, mock_request, random_dict):
         mock_call = mock_request.get(SEARCH_API_URL, json=random_dict)
         term = faker.word()
         location = f'{faker.city()}, {faker.state_abbr()}'
@@ -297,6 +344,11 @@ class TestSearchQuery:
             'limit': [str(limit)],
         }
 
+    def test_success_with_lat_lng(self, yelp, faker, mock_request, random_dict):
+        mock_request.get(SEARCH_API_URL, json=random_dict)
+
+        assert yelp.search_query(latitude=faker.latitude(), longitude=faker.longitude()) == random_dict
+
 
 class TestTransactionSearchQuery:
     @pytest.mark.parametrize('invalid_type', [None, ''])
@@ -308,8 +360,21 @@ class TestTransactionSearchQuery:
         with pytest.raises(ValueError):
             yelp.transaction_search_query(faker.word())
 
-    def test_success(self, yelp, faker, mock_request, random_dict):
+    @pytest.mark.parametrize('partial_kwargs', [{'latitude': 37.7749}, {'longitude': -122.4194}])
+    def test_rejects_partial_lat_lng(self, yelp, faker, partial_kwargs):
+        with pytest.raises(ValueError):
+            yelp.transaction_search_query(faker.word(), **partial_kwargs)
+
+    def test_success_with_location(self, yelp, faker, mock_request, random_dict):
         transaction_type = faker.word()
         mock_request.get(TRANSACTION_SEARCH_API_URL.format(transaction_type), json=random_dict)
 
         assert yelp.transaction_search_query(transaction_type, location=faker.city()) == random_dict
+
+    def test_success_with_lat_lng(self, yelp, faker, mock_request, random_dict):
+        transaction_type = faker.word()
+        mock_request.get(TRANSACTION_SEARCH_API_URL.format(transaction_type), json=random_dict)
+
+        assert yelp.transaction_search_query(
+            transaction_type, latitude=faker.latitude(), longitude=faker.longitude()
+        ) == random_dict

{yelpapi-2.6.0 → yelpapi-2.7.0}/yelpapi/__init__.py

@@ -22,3 +22,5 @@
 """
 
 from .yelpapi import YelpAPI
+
+__all__ = ['YelpAPI']

{yelpapi-2.6.0 → yelpapi-2.7.0}/yelpapi/yelpapi.py

@@ -21,10 +21,8 @@
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
-from __future__ import annotations
-
 from types import TracebackType
-from typing import Any
+from typing import Any, Self
 
 import requests
 
@@ -78,7 +76,7 @@ class YelpAPI:
 
         This class will create and use a single `requests.Session` object for all API calls, which will provide a nice
         performance boost with many calls. To avoid keeping unnecessary connections open, you should be sure to close
-        the Session once all Yelp API interactions are complete. This can be done manully by calling close() or by
+        the Session once all Yelp API interactions are complete. This can be done manually by calling close() or by
         using it as a context manager.
     """
 
@@ -112,7 +110,7 @@ class YelpAPI:
         """
         self._yelp_session.close()
 
-    def __enter__(self) -> YelpAPI:
+    def __enter__(self) -> Self:
         return self
 
     def __exit__(
@@ -376,6 +374,11 @@ class YelpAPI:
 
         response_json = response.json()
 
+        # Every Yelp Fusion endpoint returns a JSON object. Anything else (e.g., a bare string or list) is unexpected
+        # and must be rejected before the error check below, which assumes a dict.
+        if not isinstance(response_json, dict):
+            raise YelpAPI.YelpAPIError(f'Unexpected response type: {type(response_json).__name__}')
+
         # Yelp can return one of many different API errors, so check for one of them.
         # The Yelp Fusion API does not yet have a complete list of errors, but this is on the TODO list; see
         # https://github.com/Yelp/yelp-fusion/issues/95 for more info.

yelpapi-2.6.0/.github/workflows/publish.yml

@@ -1,28 +0,0 @@
-name: Publish
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    environment: pypi
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.13'
-
-      - name: Build
-        run: |
-          pip install build
-          python -m build
-
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1

yelpapi-2.6.0/.github/workflows/tests.yml

@@ -1,29 +0,0 @@
-name: Tests
-
-on:
-  push:
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: pip install ".[dev]"
-
-      - name: Run tests
-        run: pytest

yelpapi-2.6.0/CLAUDE.md

@@ -1,32 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Commands
-
-Install dependencies:
-```
-pip install ".[dev]"
-```
-
-Run tests (coverage included by default via `pyproject.toml`):
-```
-pytest
-```
-
-Run a single test:
-```
-pytest tests/test_yelpapi.py::TestYelpAPI::test_calls_api
-```
-
-## Architecture
-
-This is a thin Python wrapper around the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). The entire implementation lives in `yelpapi/yelpapi.py` as a single `YelpAPI` class.
-
-**Design philosophy:** The wrapper is intentionally minimal and extensible — all API parameters are passed through `**kwargs` directly to the HTTP request, so it doesn't break when Yelp adds new parameters. The only thing that would break it is a URL scheme change.
-
-**Request flow:** Each public method (e.g., `search_query`, `business_query`) validates required parameters, then delegates to `_query()`, which strips `None`-valued kwargs before issuing the GET request via a shared `requests.Session`. Errors from Yelp's API (returned as JSON with an `error` key) are raised as `YelpAPI.YelpAPIError`.
-
-**Session management:** A single `requests.Session` is reused for all calls (performance benefit). Users should close it via context manager (`with YelpAPI(...) as api`) or explicitly via `api.close()`.
-
-**Tests** use `requests-mock` (via the `mock_request` autouse fixture in `conftest.py`) to intercept HTTP calls, and `Faker` for generating random test data. No real API calls are made in tests.