znields / business-classifier

A business classifier that uses data from Facebook, Google, and Yelp

Business Classifier

A business classifier that uses data from Facebook, Google, and Yelp.

Table of Contents

Purpose
Compatibility
Setup
Functionality
Use Cases
Future Goals

Purpose

The Business Classifier program is designed to categorize businesses using data from Facebook, Google, and Yelp. It was originally built in order to automate the classification of merchants who use iMobile3's point-of-sale and marketplace software, however, it can be used whenever a database of businesses needs to be classified.

Compatibility

The following code is compatible with Python 3.6 on Windows, Mac OS, and Linux.

Setup

1. Clone this repository.
2. Run pip install -r requirements.txt.
3. Run python3.6 main.py.

Functionality

After running the program according to the directions above, the window pictured below is displayed. In this section, the functionality of each widget in this window will be explored in depth.

Input and Output

The following widgets are useful for specifying how input is read and how output is saved.

Data File

The Data File widget is for selecting the file that contains the business data.

Results File

The Results File widget is for selecting where the results should be saved.

Business Name Columns

The Business Name Columns widget is for specifying which columns of the data file contain the name of the business. If columns are to be combined, commas should be used to separate the column numbers. Note: column indexing begins at 0.

Business Location Columns

The Business Location Columns widget is for specifying which columns of the data file contain the location of the business. If columns are to be combined, commas should be used to separate the column numbers. Note: column indexing begins at 0.

API Keys

The following widgets are useful for entering API keys that allow for access to Facebook and Yelp.

Facebook Access Token

The Facebook Access Token widget allows a user to enter a Facebook access token. This access token allows the scraper to access the Facebook Graph API. Learn more.

GeoNames Username

The GeoNames Username widget allows a user to enter a GeoNames username. This username allows the scraper to access the functionality of GeoNames. Learn more.

Yelp API Key

The Yelp API Key widget allows a user to enter a Yelp API key. This key allows the scraper to access the functionality of the Yelp Fusion API. Learn more.

Use Cases

There only use case for this program is business classification. The functionality of the program may be expanded in the future, however, there are no plans to do so at the momment.

Future Goals

See Projects.