# python-yelp-v2

**Repository Path**: mirrors_mathisonian/python-yelp-v2

## Basic Information

- **Project Name**: python-yelp-v2
- **Description**: A Python wrapper for the Yelp API v2
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

python-yelp-v2
==============

A Python wrapper for the Yelp API v2. The structure for this was inspired by the [python-twitter](https://github.com/bear/python-twitter) library, and some internal methods are reused.


Installation
----

From [pypi](https://pypi.python.org/pypi/python-yelp-v2)

```sh
pip install python-yelp-v2
```

Usage
-----

You must have yelp oauth credentials: http://www.yelp.com/developers/getting_started

```python
import yelp

yelp_api = yelp.Api(consumer_key=MY_CONSUMER_KEY,
                    consumer_secret=MY_CONSUMER_SECRET,
                    access_token_key=MY_ACCESS_TOKEN,
                    access_token_secret=MY_ACCESS_SECRET)

```

### Searching

```python
search_results = yelp_api.Search(term="my search term", location="my location") # location and search term are required
for business in search_results.businesses:
    print business.name
```

See the exact attributes available on the [search result set](https://github.com/mathisonian/python-yelp-v2/blob/master/yelp.py#L184)

### Getting business info

```python
business = yelp_api.GetBusiness('post-no-bills-brooklyn')
print business.name
```

The [business class](https://github.com/mathisonian/python-yelp-v2/blob/master/yelp.py#L203) lists all of the attributes that are 
available for each business the API returns.



Todo
----

* Create classes for categories.
* Improve the location class


Authors
-------

* Matthew Conlen (<a href="http://github.com/mathisonian">mathisonian</a>)
* Chris Clouten (<a href="http://github.com/triplec1988">triplec1988</a>)

License
-------

Copyright Matthew Conlen

MIT