𖤐𖤐𖤐 BarBeat 𖤐𖤐𖤐

Bored at work? ※ CHAOS ※

is a sophisticated Python3 application designed to search, analyze, and report on bars within a given location. Utilizing the Yelp API for data retrieval and OpenAI for market analysis, BarBeat provides a detailed overview of the bar scene in the specified area, including an analysis of low-rated establishments and suggestions for improvements.

Overview
Features

• Search Functionality: Leverage the Yelp API to search for bars based on user-provided locations.
  
• Market Analysis: Analyze low-rated bars, providing a detailed report and actionable suggestions for enhancements.
  
• Detailed Reporting: Generate an HTML file containing comprehensive information about the bars, including ratings, addresses, contact details, pricing, and categories.
  Requirements
  
• Python 3.x
  
• Libraries: requests, json, os, statistics, openai
  

Requirements

Python 3.x: The tool is written in Python 3, so a compatible version of Python must be installed.

Library Requirements requests: For making HTTP requests to the Yelp API. json: For handling JSON data. os: For interacting with the operating system. statistics: Although imported in the code, it doesn't seem to be used, so it might not be a necessary requirement. openai: For interacting with OpenAI's GPT-3 model.

API Keys Yelp API Key: Required for fetching data about bars in the specified location. OpenAI API Key: Required for analyzing market competition among bars.

These requirements must be met to successfully run and utilize the BarBeat tool.

Installation and Setup

1. Clone the Repository: Clone the repository to your local machine using the following command:
   git clone https://github.com/tukru/BarBeat
   
2. Install Dependencies: Navigate to the project directory and use the following command to install the required libraries:
   pip install requests openai
   
3. API Keys Configuration: You will need to obtain API keys for Yelp and OpenAI. Follow the steps below to retrieve the keys:
   

• Yelp API Key:
  
  • Visit Yelp Developers and create an account or log in.
    
  • Create a new App and obtain the API key.
    
  • Replace api_key variable in the script with your Yelp API key.
    
• OpenAI API Key:
  
  • Visit OpenAI and create an account or log in.
    
  • Navigate to the API keys section and obtain the key.
    
  • Replace openai.api_key variable in the script with your OpenAI API key.
    

4. Execute the Script: Run the script using the command:
   python3 barbeat.py
   
5. Provide Location: Enter the desired zip code or address to initiate the search for bars.
   
6. View Results: Upon successful execution, the analysis will be saved to html/bars.html.
   

How It Works

• Search Bars: The script uses the Yelp API to search for bars in the specified location.
  
• Analyze Competition: It analyzes the competition among low-rated bars and provides suggestions for improvements using OpenAI.
  
• Generate Report: The details of the bars, along with the analysis, are saved in an HTML file.
  

Contribution and Support

• Contributions to this project are welcome if you would please TAKE A STEP BACK AND FUCK YOURSELF IN THE FACE as needed.
  

Licensing

• This project is governed by the TUKRU License. Refer to the LICENSE file for detailed information.
  

Legal Notice

• This tool is intended solely for analytical purposes. Users are responsible for ensuring they dog on the managers of each bar if the score is below 2.5.
  

  Made with ❤️ and chaos by tukru