Comprehensive Python wrapper for the Yelp v2 api
Project Description
Pyyelp
=======
Pyyelp is a python wrapper for the Yelp API v2
I wrote this wrapper because I couldn't find a comprehensive, lightweight Yelp API wrapper for Python. This wrapper has methods for Search, Business, and Phone APIs and supports all associated parameters - all in a nice, lightweight package.
Yelp API v2 docs <https://www.yelp.com/developers/documentation>
Requires
-------
- oauth2
Fast install
-------
pip install pyyelp
- Add the following in **settings.py** or .bash_profile
YELP_API_CONSUMER_KEY={{ CONSUMER_KEY }}
YELP_API_CONSUMER_SECRET={{ CONSUMER_SECRET }}
YELP_API_TOKEN={{ TOKEN }}
YELP_API_TOKEN_SECRET={{ SECRET_TOKEN }}
Fast example
-------
**Term and Location are required for Search**
from pyyelp.pyyelp import Yelp
yelp = Yelp()
search_result = yelp.search(term="foo store", location="California")
Examples
-------
1. **Search** Example
from pyyelp.pyyelp import Yelp
yelp = Yelp()
search_result = yelp.search(term="Don Quixote's Restaurant", location="Santa Cruz, California")
2. **Business** Example
from pyyelp.pyyelp import Yelp
yelp = Yelp()
business_result = yelp.get_business_by_id("taqueria-los-gallos-newark")
3. **Phone** Example
from pyyelp import Yelp
yelp = Yelp()
phone_result = yelp.search_by_phone_number("1234567890")
TODO
-------
- Errors
- Proper Testing
Contribute
-------
1. Fork the repo <https://github.com/motte/python-yelp>
2. Test the code thoroughly
3. Code with pep8 <http://www.python.org/dev/peps/pep-0008/>
4. Pull request
Tests
-------
Unit test setup to come.
=======
Pyyelp is a python wrapper for the Yelp API v2
I wrote this wrapper because I couldn't find a comprehensive, lightweight Yelp API wrapper for Python. This wrapper has methods for Search, Business, and Phone APIs and supports all associated parameters - all in a nice, lightweight package.
Yelp API v2 docs <https://www.yelp.com/developers/documentation>
Requires
-------
- oauth2
Fast install
-------
pip install pyyelp
- Add the following in **settings.py** or .bash_profile
YELP_API_CONSUMER_KEY={{ CONSUMER_KEY }}
YELP_API_CONSUMER_SECRET={{ CONSUMER_SECRET }}
YELP_API_TOKEN={{ TOKEN }}
YELP_API_TOKEN_SECRET={{ SECRET_TOKEN }}
Fast example
-------
**Term and Location are required for Search**
from pyyelp.pyyelp import Yelp
yelp = Yelp()
search_result = yelp.search(term="foo store", location="California")
Examples
-------
1. **Search** Example
from pyyelp.pyyelp import Yelp
yelp = Yelp()
search_result = yelp.search(term="Don Quixote's Restaurant", location="Santa Cruz, California")
2. **Business** Example
from pyyelp.pyyelp import Yelp
yelp = Yelp()
business_result = yelp.get_business_by_id("taqueria-los-gallos-newark")
3. **Phone** Example
from pyyelp import Yelp
yelp = Yelp()
phone_result = yelp.search_by_phone_number("1234567890")
TODO
-------
- Errors
- Proper Testing
Contribute
-------
1. Fork the repo <https://github.com/motte/python-yelp>
2. Test the code thoroughly
3. Code with pep8 <http://www.python.org/dev/peps/pep-0008/>
4. Pull request
Tests
-------
Unit test setup to come.
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size & hash SHA256 hash help | File type | Python version | Upload date |
---|---|---|---|
pyyelp-0.1.1.tar.gz (4.7 kB) Copy SHA256 hash SHA256 | Source | None | Apr 2, 2015 |