Skip to content

Setup and Install

Jump to bottom
TKS edited this page Oct 2, 2023 · 1 revision

Employ Rating App

Overview

The Employ Rating App is a Python-based application designed to evaluate and rank businesses based on various metrics. The application fetches data from multiple APIs, including Yelp, Better Business Bureau (BBB), and Google Places, to generate an overall score for a business. You will need to set your own api's in the .env first. The app is intended to help users make informed decisions about businesses they are interested in and more importantly would like to develop for someone looking to work for a business to get a REAL rating on a potential employer.

Features

  • Yelp Ratings: Fetches and scales Yelp ratings for a business.
  • BBB Ratings: Retrieves Better Business Bureau ratings and scales them.
  • Google Places Ratings: Gets ratings from Google Places and scales them.
  • Credit Score: Allows manual entry of a business's credit score.
  • Employee Turnover: Allows manual entry of a business's employee turnover rate.
  • Weighted Scoring: Uses a weighted scoring system to generate an overall business score.

Installation

Using Python Virtual Environment

  1. Clone the repository.
  2. Navigate to the project directory.
  3. Create a Python virtual environment: python -m venv .venv
  4. Activate the virtual environment.
  5. Install dependencies: pip install -r requirements.txt

Using Conda

  1. Install Anaconda or Miniconda.
  2. Create a new environment: conda create -n employ python=3.11.0
  3. Activate the environment: conda activate employ
  4. Install dependencies: pip install -r requirements.txt

Usage

Run python app.py to start the application.

Future Additions

  • Integration of more APIs for a comprehensive business evaluation.
  • Introduction of awards or certifications that can positively impact a business's score.
  • Adapt the tool for job seekers to evaluate potential employers.
  • Allow manual entries for additional business metrics.
  • Implement industry-specific ranking systems.

Contributing

If you're interested in contributing, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License.

Clone this wiki locally