Skip to main content

A Python wrapper for Yelp API

Project description

ezapi-yelp

A Python wrapper for Yelp API, supporting v2 and Fusion (v3)

  • Implement all endpoints
    • v2
      • Search
      • Business
      • PhoneSearch
    • fusion (v3)
      • Search
      • PhoneSearch
      • TransactionSearch
      • Business
      • Reviews
      • Autocomplete
  • Validate all parameters
  • Provide CLI
  • Include unit tests

Install

pip install ezapi_yelp

Test

  1. Clone down the repo

    git clone git@github.com:zehengl/ezapi_yelp.git
    cd ezapi_yelp
    
  2. Create a config file to store your credentials for testing

    touch tests/credentials.conf
    
  3. Put down your api credentials as follows

    [v2]
    consumer_key = xxxx
    consumer_secret = xxxx
    token = xxxx
    token_secret = xxxx
    
    [v3]
    app_id = xxxx
    app_secret = xxxx
    
  4. Run the tests

    python setup.py test
    

Usage

  1. Python Library To use the python library, please create a Yelp instance with the required credentials.

    All parameters are considered as keyword arguments (**kwargs).

    For v2 api:

    from yelp.api.v2 import Yelp
    
    
    consumer_key = 'xxxx'
    consumer_secret = 'xxxx'
    token = 'xxxx'
    token_secret = 'xxxx'
    
    yelp = Yelp(
        consumer_key,
        consumer_secret,
        token,
        token_secret,
    )
    
    # Simple Examples
    print yelp.search(location='calgary', limit=1)
    print yelp.business('yelp-san-francisco')
    print yelp.phone_search(phone='+14037275451')
    print yelp.search(term='food',bounds='37.900000,-122.500000|37.788022,-122.399797')
    print yelp.search(term='food',ll='37.900000,-122.500000')
    print yelp.search(term='food',location='Hayes',cll='37.77493,-122.419415')
    

    For fusion (v3) api:

    from yelp.api.v3 import Yelp
    
    
    app_id = 'xxxx'
    app_secret = 'xxxx'
    
    yelp = Yelp(
        app_id,
        app_secret,
    )
    
    # Simple Examples
    print yelp.search(location='calgary', limit=1)
    print yelp.phone_search(phone='+14037275451')
    print yelp.transaction_search('delivery', location='calgary')
    print yelp.business('yelp-san-francisco')
    print yelp.reviews('yelp-san-francisco')
    print yelp.autocomplete(text='pizza', latitude=37.77493, longitude=-122.419415)
    
  2. Command Line Interface To use the CLI, please set up the api credentials as environment variables or pass in as options.

    All parameters are considered options (–PARAMETER=VALUE) in the command line interface.

    For v2 api:

    export consumer_key = xxxx
    export consumer_secret = xxxx
    export token = xxxx
    export token_secret = xxxx
    
    yelp2 business yelp-san-francisco
    yelp2 phone_search --phone=+15555555555
    

    or

    yelp2 --consumer_key='xxxx' --consumer_secret='xxxx' --token='xxxx' --token_secret='xxxx' ENDPOINT --PARAMETER=yy
    

    For fusion (v3) api:

    export app_id = xxxx
    export app_secret = xxxx
    
    yelp-fusion search --location='san franciso' --limit=10 --indent=2
    yelp-fusion business yelp-san-francisco
    yelp-fusion autocomplete --latitude=37.77493 --longitude=-122.419415 -text='pizza'
    

    or

    yelp3 --app_id='xxxx' --app_secret='xxxx' ENDPOINT --PARAMETER=yy
    

Contact

Zeheng Li

imzehengl@gmail.com

Project details


Release history Release notifications

This version
History Node

0.3.1

History Node

0.3.0

History Node

0.2.0

History Node

0.1.0

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
ezapi_yelp-0.3.1.tar.gz (6.4 kB) Copy SHA256 hash SHA256 Source None Dec 18, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page