Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lanl/yelpapi
yelpapi is a pure Python implementation of the Yelp Fusion API (aka Yelp v3 API).
https://github.com/lanl/yelpapi
api python python-yelp yelp
Last synced: 1 day ago
JSON representation
yelpapi is a pure Python implementation of the Yelp Fusion API (aka Yelp v3 API).
- Host: GitHub
- URL: https://github.com/lanl/yelpapi
- Owner: lanl
- License: bsd-3-clause
- Created: 2013-10-03T20:55:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-13T20:38:53.000Z (over 1 year ago)
- Last Synced: 2024-04-26T12:43:26.784Z (9 months ago)
- Topics: api, python, python-yelp, yelp
- Language: Python
- Homepage:
- Size: 124 KB
- Stars: 135
- Watchers: 9
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# yelpapi
[](https://app.travis-ci.com/lanl/yelpapi)
## 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.
## 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.8 or higher and [requests](https://github.com/requests/requests).
## INSTALL
yelpapi is available on PyPI at https://pypi.org/project/yelpapi/.
Install using [pip](http://www.pip-installer.org/):
pip install yelpapi
Install from source:
python setup.py install
## USING THIS CODE
This API is demonstrated more thoroughly in [examples.py](examples/examples.py), but the following chunk of code demonstrates basic use of yelpapi:
```python
from yelpapi import YelpAPI
with YelpAPI(api_key) as yelp_api:
search_results = yelp_api.search_query(args)
```
You can also set timeouts so API calls do not block indefinitely in degraded network conditions:
```python
from yelpapi import YelpAPI
with YelpAPI(api_key, timeout_s=3.0) as yelp_api:
search_results = yelp_api.search_query(args)
```
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
try:
yelp_api = YelpAPI(api_key)
search_results = yelp_api.search_query(args)
finally:
yelp_api.close()
```
## METHODS
* [Autocomplete API](https://www.yelp.com/developers/documentation/v3/autocomplete) - `autocomplete_query(...)`
* [Business API](https://www.yelp.com/developers/documentation/v3/business) - `business_query(...)`
* [Business Match API](https://www.yelp.com/developers/documentation/v3/business_match) - `business_match_query(...)`
* [Event Lookup API](https://www.yelp.com/developers/documentation/v3/event) - `event_lookup_query(...)`
* [Event Search API](https://www.yelp.com/developers/documentation/v3/event_search) - `event_search_query(...)`
* [Featured Event API](https://www.yelp.com/developers/documentation/v3/featured_event) - `featured_event_query(...)`
* [Phone Search API](https://www.yelp.com/developers/documentation/v3/business_search_phone) - `phone_search_query(...)`
* [Reviews API](https://www.yelp.com/developers/documentation/v3/business_reviews) - `reviews_query(...)`
* [Search API](https://www.yelp.com/developers/documentation/v3/business_search) - `search_query(...)`
* [Transaction Search API](https://www.yelp.com/developers/documentation/v3/transactions_search) - `transaction_search_query(...)`